Resource Fields
|
PII |
SI |
Field |
Description |
Format |
|---|---|---|---|---|
|
|
|
id |
The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values. This field is also named “userTypeId“ when used as path parameter. |
integer |
|
|
|
code |
Alphanumeric code that uniquely identifies a singular User Type. This is manually generated by the user and can be obtained by using the appropriate API. |
string |
|
|
|
description |
Natural language description of the User Type. |
string |
|
|
|
ordering |
The User Type’s ordering. |
integer |
|
|
|
maxInactiveInterval |
The User Type’s max inactive interval in minutes. |
integer |
|
|
|
active |
Whether the User Type is active or not. |
boolean |
|
|
|
systemAdmin |
Whether the User Type is a system admin or not. |
boolean |
|
|
|
companyAdmin |
Whether the User Type is a company admin or not. |
boolean |
|
|
|
profileId |
External identifier referencing a User Profile. |
integer |
|
|
|
mobileUser |
Whether the User is a scheduling resource. |
boolean |
|
|
|
externalUser |
Whether the User is external. |
boolean |