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

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
idString

The unique User ID.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    usersObject[]

Single entry array with the user to be updated.

      firstNameString

User's first name.

      isInactiveBoolean

TRUE to disable the user.

      isLockedBoolean

FALSE to unlock the account. It's not allowed to lock it.

      surnameString

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

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.