The user item, as its name suggests, contains information about a GeoOp user (which could be either an office or field worker).

Associations

Name Type Description Value Restrictions Access Visible by Default Required
role item

Role of the user assigned by the administrator.

Associated item: role

None Read
Write
Filter
Sort
Change
Yes No
account item

Administrative account the user belongs to.

Associated item: account

None Read
Write
Filter
Change
Yes POST
PUT
createdBy item

Associated item: user

None Read
Write
Filter
Change
No No
modifiedBy item

Associated item: user

None Read
Write
Filter
Change
No No
locations collection

Associated item: location

None Read
No No
workgroups collection

The workgroup(s) the user belongs to.

Associated item: workgroup

None Read
Write
Filter
Change
No No

Fields

Name Type Description Value Restrictions Access Visible by Default Required
id integer

Item identifier.

None Read
Write
Sort
Filter
Change
Yes PATCH
DELETE
login string

User login that they use to access the GeoOp system.

None Read
Write
Change
No POST
PUT
firstName string

First name of the user.

None Read
Write
Filter
Sort
Change
Yes POST
PUT
lastName string

Last (family) name of the user.

None Read
Write
Filter
Sort
Change
Yes POST
PUT
companyName string

Name of the company the user works at.

None Read
Write
Change
Yes No
email string

Email address.

None Read
Write
Change
Yes POST
PUT
phone string

Work phone number in international format.

None Read
Write
Change
Yes No
mobile string

Mobile phone number in international format.

None Read
Write
Change
Yes POST
PUT
mobileCountryCode float None Read
Write
Change
Yes No
hourlyRate float

Hourly rate.

None Read
Write
Change
Yes No
active integer

Determines whether the user account is active.

Allowed values:
0, 1
Read
Write
Filter
Change
Yes No
deleted boolean

Determines whether the user account has been deleted.

None Read
Write
Filter
Change
Yes No
status.message string

Status message.

None Read
Write
Change
Yes No
status.timestamp datetime

Date and time the status has been changed.

None Read
Write
Filter
Change
Yes No
colour string

Colour code in hexadecimal (HEX) notation.

None Read
Write
Change
Yes No
created datetime None Read
Sort
Filter
Yes No
modified datetime None Read
Sort
Filter
Yes No
isAssignable boolean

Determines whether the user can be assigned to a job.

None Read
Yes No
avatarUrl string

The user image if set by the user

None Read
Yes No
oldPassword string

Old (current) password of the user.

None Write
Change
No PATCH ?
newPassword string

New password of the user.

Encoding: UTF-8
Min length: 8
Max length: 50
Write
Change
No POST
PUT
PATCH ?
newPasswordConfirm string

Confirmation of the new password.

None Write
Change
No POST
PUT
PATCH ?