General - Update employee pincode
API Url
Used for updating the employee's pincode. User needs to have access to the employee to change pin.
PUT
http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/password
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 |
|---|---|---|
| empId | String | Employee identifier |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| confirmPassword | String | New password confirmed. |
| newPassword | String | New password. |
Request example:
{"request": {"data": {"newPassword": "123456","confirmPassword": "123456"}}}
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| errorCode | Number | Error Code |
| errorMessage | String | Message description of the error. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"errorCode": 0,"errorMessage": ""}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |
Error example:
HTTP/1.1 422 Unprocessable Entity{"response": {"errorCode": 22,"errorMessage": "Incorrect password"}}