ProRoster - Update a stamp
API Url
Used for updating a stamp
http://localhost:16010/ProMarkREST/web/ProRoster/stamps/{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 | Number | The stamp id |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| stamps | Object[] | |
absenceReasonoptional | Object[] | |
| code | String | The code of the absence reason |
attendanceProfileoptional | Object[] | |
| id | String | The attendance profile's id |
attendanceTimeoptional | Object[] | |
| endTime | Number | End time |
| isLocked | Boolean | TRUE if it is locked |
| isRequired | Boolean | TRUE if it is required |
| startTime | Number | Start time |
dayProfileoptional | Object[] | |
| id | String | The day profile id |
departmentoptional | Object[] | |
| id | String | The department's id |
groupoptional | Object[] | |
| id | String | The group's id |
normalTimeoptional | Object[] | |
| endTime | Number | End time |
| isLocked | Boolean | TRUE if it is locked |
| isRequired | Boolean | TRUE if it is required |
| startTime | Number | Start time |
| type | Number | The type of the stamp. |
| valueTypes | String[] | An array with the value types that will be inserted for the stamp |
Request example:
{"request": {"data": {"stamps": [{"type": 0,"valueTypes": ["day-profile","normal-time","department"],"day-profile": [{"id": "BAY7-16"}],"normal-time": [{"startTime": 25200,"endTime": 57600,"isLocked": "false","isRequired": "false"}],"department":[{"id": "17"}]}]}}}
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
{"response": {"data": {"stamps": [{"stampId": 2164886755,"type": 0,"valueTypes": ["day-profile","normal-time","department","group"],"day-profile": [{"id": "BAY7-16","description": "07: 00 - 16: 00, Bay test","normalTimeStart": 25200,"normalTimeStop": 57600,"isVariable": "false","hoursPerDay": 28800,"inactive": "false","arrivalTimeStop": 86400,"departureTimeStop": 86400,"normalTimeIntervalFormatted": "07: 00 - 16: 00","arrivalTimeIntervalFormatted": "--:-- - 00: 00","departureTimeIntervalFormatted": "--:-- - 00: 00","hourPerDayFormatted": "08: 00"}],"normal-time": [{"startTime": 25200,"endTime": 57600,"isLocked": "false","isRequired": "false"}],"department":[{"id": "17","sortId": "!!!!!!!!17","desc": "HR Department","description": "HR Department"}]}]}}}
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. |