General - Get ProMark users

API Url

Used for loading ProMark users

GET

http://localhost:16010/ProMarkREST/rest/General/users

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Query parameters

Field	Type	Description
filter`optional`	String	JSON containing filter fields, their values and conditions.
includeInactive`optional`	Boolean	TRUE if you want to include also inactive Users (default is FALSE).
skip`optional`	Number	Number of records to skip. Used for pagination.
sortBy`optional`	String	String with fields to sort on (descending,ascending)
take`optional`	Number	Number of records to get. Used for pagination.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
users	Object[]	Collection of users.
firstName	String	User's first name.
id	String	User ID (unique identifier).
isAdministrator	Boolean	TRUE if the user is a ProMark administrator.
isInactive	Boolean	TRUE if the user is disabled.
isLocked	Boolean	TRUE if the user account is locked. It might be because of multiple login attempts.
lastLogin	Date	The last login time expressed as date-time ISO strig.
surname	String	User's surname.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "users": [
            {
               "id": "MFA",
               "firstName": "Mircea",
               "surname": "Alexandru",
               "isAdministrator": true,
               "lastLogin": "2018-09-04T08:30:00",
               "isLocked": false,
               "isPasswordExpired": false,
               "isInactive": false
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.