REST Object Definitions User Related Objects User Object

User Object Formats

JSON Format

 {
	"Activated": true,
	"AuthenticationID": "",
	"Deleted": false,
	"DGroupID": "",
	"Email": "",
    "EnableMobileDiagnostics": false,
	"Extensions": {
		"key1": "value1",
		"key2": "value2"
	},
	"FaceTime": "",
	"FirstName": "",
	"IsMobileWorker": true,
	"LanguageCode": "",
	"LastName": "",
	"Locked": false,
	"Password": "",
	"Phones": [{
		"PhoneNum": "",
		"PhoneType": ""
	}],
	"ResetPassword": false,
	"ServiceTeamID": "",
	"SMS": "",
	"Status": "",
	"StorageLocationID": "",
	"UserID": ""
}

User Object Properties

Required properties are in bold.

Property

Type

Description

Activated

boolean

Identifies is the user record is activated. If not activated the user will be unable to logon to the system.

Valid values are:

true - User is active and can use the system.
false - User is not active and can not logon to the system.

Deleted

boolean

Identifies if the user record is to be deleted.

Notes:

This field is only used in conjunction with the Bulk APIs
Individual users can be deleted using the DELETE method of the REST Standard REST APIs User REST API

Valid values are:

true - The user object should be deleted
false - The user object should not be deleted. This is the default value if this property is not specified.

DGroupID string Specifies the Deployment Group the user is assigned to.

Email

Specifies the email address of the user.

EntityEmployeeNumber

string

This property is deprecated. Please use the Extensions property instead.

Extensions

collection

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

FaceTime

string

Identifies the Apple FaceTime ID associated with the user.

FirstName

string

Identifies the first name of the user.

Locked

bool

Identifies is the user account is locked. If true, then this user will not be able to access the Nexus management console or the ServiceMobility mobile application.

An administrator has the ability to lock any user (except their own).

Valid values are:

true - The user is locked out of the system
false (default) - The user is not locked out of the system

3.13

IsMobileWorker

bool

Identifies if the user is a mobile worker. If true, then this user has access to the ServiceMobility mobile application.

Valid values are:

true - The user is a mobile worker
false (default) - This user is not a mobile worker

v.3.13

LanguageCode

string

Identifies the language in which the mobile application will be run for the user. If the mobile application does not have the selected language translations deployed it will default to English.

LastName

string

Identifies the last name of the user.

Phones

collection

A collection of phone numbers associated with the contact.

Phone Properties

Property

Type

Description

PhoneNum

string

The phone number.

PhoneType

string

Identifies the type of phone number.

See: REST System Categories Phone Types

Password

string

Identifies the password for the user.

Passwords are always stored encrypted with a unique user cryptography salt value.

ResetPassword

boolean

Identifies if the password should be reset to the value specified by the Password property.

Valid values are:

true = The password will be reset to the value identifies by the Password property
false = The password will not be reset. This is the default value if this property is not provided.

ServiceTeamID

string

Identifies the service team the user is associated with. This field should be populate for any user that is a field technician / worker. If the user is a manager or planner then this field can be left empty.

3.20.0

SMS

string

This field contains the number used to send SMS to the user. Typically this is a user's mobile phone number.

Status

string

Future. This field is currently not used.

StorageLocationID

string

Identifies the storage location assigned to the user. When the user is using the mobile application this is the inventory location where parts will be consumed from. If you are not using / tracking inventory then this field can be left blank.

UserID

string

This field represents the user's logon to the system. This includes both the portal and mobile application. Note, based on the user's roles access either the portal or mobile application may be restricted.