General - Get user information

API Url

Used for loading user informations, like name and e-mail, for the current loged-in user.

GET

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

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.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
avatarURI`optional`	String	URI for loading employee avatar. If no picture exists, this will be skipped.
culture`optional`	String	User culture.
email`optional`	String	User's e-mail.
empId`optional`	String	User's employee id.
empNo`optional`	String	User's employee number.
fullName	String	User's full name.
initials`optional`	String	User's initials.
mobilePhone`optional`	String	User's mobile phone number.
portalUserId	Number	Portal user id
roles	Object[]	Collection of allowed ProMark roles.
description	String	Role description.
HostRetransferAccess`optional`	String	Access to host retransfering functonality
id	Number[1-2]	Role identifier (1: Employee, 2: User).
isAdministrator`optional`	Boolean	true = User has Administrator privileges.
productionDisplayId`optional`	String	Production Display ID linked to the display user.
terminalId`optional`	String	Terminal ID linked to the terminal user.
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": {
         "empNo": "MFA",
         "empId": "4321",
         "fullName": "Mircea Alexandru",
         "email": "mfa@mark-info.com",
         "initials": "MFA",
         "culture": "da-dk"
         "roles": [
            {
               "id": 1,
               "description": "Employee"
            },
            {
                "id": 2,
                "description": "User",
                "isAdministrator": false,
            }
         ],
         "avatarURI": "data:image/jpg;base64,..."
      },
      "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.