NovatusUser Object

  • The NovatusUser class contains information about system internal users. 
  • When creating a user, the emailAddress, loginName, password, firstName, and lastName fields are required. 
  • Also, functions must have at least one entry. The password field can be used to change a user's password, but for security reasons, the field is blank when a NovatusUser is retrieved from the server. 

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

Field Name

Type

Description

Queryable

Required

id

String

A unique identifier of this Contracts User

Yes

-

roles

List<String>

List of system roles for this user

Yes

Yes

prefix

String

Person Name Prefix

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

-

functions

List<String>

List of system person functions

Yes

Yes

organization

String

User Organization

Yes

-

loginName

String

User Login Name

-

Yes

password

String

User Password

-

Yes

forcePasswordChange

Boolean

Set "true" to force password change on next login

-

-

disabled

Boolean

User is disabled

-

-


NovatusUser Object Methods

 

NovatusUser NQL Statements

These are list of items that can be placed into an NQL statement to filter User 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.

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 user

work

Work Phone Number

cell

Cell Phone Number

home

Home Phone Number

fax

Fax Number

notes

Notes

functions

List of system person functions

organization

User Organization