NovatusPerson

  • The NovatusPerson object is a means by which External Persons can be created, updated, and queried.  
  • The type of person must always be set to “External”
  • Though emailAddress is not required in the API it is highly recommended that this field be filled in as well.
  • The purpose of an external person is to allow messaging from Contracts to that person and allow them to reply so that the reply can be captured in Contracts.


Production WSDL: https://app1.novatuscontracts.com/Contracts/wsapi/v1/Person?Wsdl

Field Name

Type

Description

Queryable

Required

id

String

A unique identifier of this Contracts Person

Yes

-

prefix

String

Person Name Prefix

Yes

-

type

String

The type of person

Yes

Yes

firstName

String

Person First Name

Yes

Yes

middleName

String

Person Middle Name

Yes

-

lastName

String

Person Last Name

Yes

Yes

title

String

Person Title

Yes

-

addressLine1

String

Address Line 1

Yes

-

addressLine2

String

Address Line 2

Yes

-

mailStop

String

Mail Stop

Yes

-

city

String

City

Yes

-

state

String

State

Yes

-

postalCode

String

Postal Code

Yes

-

country

String

Country

Yes

-

emailAddress

String

Email Address

Yes

-

workCountryCode

String

Work Phone Number Country Code

-

-

workAreaCode

String

Work Phone Number Area Code

-

-

workNumber

String

Work Phone Number

Yes

-

workExtension

String

Work Phone Number Extension

-

-

cellCountryCode

String

Cell Phone Number Country Code

-

-

cellAreaCode

String

Cell Phone Number Area Code

-

-

cellNumber

String

Cell Phone Number

Yes

-

cellExtension

String

Cell Phone Number Extension

-

-

homeCountryCode

String

Home Phone Number Country Code

-

-

homeAreaCode

String

Home Phone Number Area Code

-

-

homeNumber

String

Home Phone Number

Yes

-

homeExtension

String

Home Phone Number Extension

-

-

faxCountryCode

String

Fax Number Country Code

-

-

faxAreaCode

String

Fax Number Area Code

-

-

faxNumber

String

Fax Number

Yes

-

faxExtension

String

Fax Number Extension

-

-

notes

String

Notes

Yes

-

organization

String

User Organization

Yes

-


NovatusPerson Object Methods

The methods listed below are the means by which changes can be made to the person(s) themselves; below is a quick example of how to use these methods:

String personId = session.getPersonPort().create(person);		
		PersonQueryResult test = session.getPersonPort().query("id = '" + personId + "'", 10, 0);
		// PersonQueryResult person = personPort.query("lastname='Doe'", 25, 0);
		return test.get Person List().get(0);
CODE



NovatusPerson NQL Statements

These are list of items that can be placed into an NQL statement to filter Person queries.  This is different from the above chart in that these are not methods that can return data but rather NQL statements that can allow you to filter query results.

PersonQueryResult persons = personPort.query(“firstname = ‘John’”,10,0);
CODE

Field Name

Description

id

A unique identifier of this Contracts User

roles

List of system roles for this user

prefix

Person Name Prefix

firstname

Person First Name

middlename

Person Middle Name

lastname

Person Last Name

title

Person Title

address1

Address Line 1

address2

Address Line 2

mailstop

Mail Stop

city

City

state

State

postal

Postal Code

country

Country

email

Email Address

personid

The UUID of the person associated with the person

work

Work Phone Number

cell

Cell Phone Number

home

Home Phone Number

fax

Fax Number

notes

Notes

organization

User Organization