General - Save user details
API Url
Used for update a Promark user details, but not password. You must be an administrator to update another user.
PUT
http://localhost:16010/ProMarkREST/rest/General/users/{id}
Permissions: user
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| id | String | The unique User ID. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| users | Object[] | Single entry array with the user to be updated. |
| firstName | String | User's first name. |
| isInactive | Boolean | TRUE to disable the user. |
| isLocked | Boolean | FALSE to unlock the account. It's not allowed to lock it. |
| surname | String | User's surname. |
Request example when updating user name:
HTTP/1.1 200 OK{"request": {"data": {"users": [{"firstName": "Mircea","surname": "Alexandru"}]}}}
Request example when unlocking a user:
HTTP/1.1 200 OK{"request": {"data": {"users": [{"isLocked": false}]}}}
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. |