SignOff - Get sign-off state per day
API Url
Read the sign-off state of every relevant day in an interval, for one or more subjects. A day the set-up does not require a sign-off for -- a non-working day with no registrations, say -- is NOT returned, so the response is not a complete calendar.
http://localhost:16010/ProMarkREST/web/SignOff/:resource/days
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 |
|---|---|---|
| resource | String | The subject type. Only "employees" today. |
Query parameters
| Field | Type | Description |
|---|---|---|
filteroptional | String | Selection filter as a json expression. See the Global Employee Filter for schema and structure. Its 'type' must be the employee filter type. |
| from | Date | First day of the interval. |
idsoptional | String | Comma separated subject ids. Employee ids (internal emp_id), not employee numbers. Mutually exclusive with 'filter'; one of the two is required. |
tooptional | Date | Last day of the interval. Defaults to 'from'. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| failures | Object[] | Subjects that could not be read. |
dateoptional | Date | The day, or null when the failure is not about one day. |
| errorCode | Number | GE/BASE message number. |
| errorMessage | String | The refusal, already translated. |
| id | String | Subject id. |
| signOffs | Object[] | One row per relevant day per subject. |
atoptional | String | When that change happened. |
byoptional | String | Who last changed the day's sign-off state. Null when the day has never been signed off. On an un-signed day this names whoever REMOVED the sign-off -- it is "last changed by", not "signed off by". |
| date | Date | The day. |
| id | String | Subject id. |
| signedOff | Boolean | TRUE = the day is signed off. |
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": {"data": {"signOffs": [{"id": "000123","date": "2026-08-03","signedOff": true,"by": "dma","at": "2026-08-04T09:12:00+02:00"},{"id": "000123","date": "2026-08-04","signedOff": false,"by": null,"at": null}],"failures": []},"errorCode": 0,"errorMessage": ""}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| BadRequest | Neither 'ids' nor 'filter' was given, both were, 'from' is missing, the interval is inverted, or the filter is malformed or of a type this resource does not accept. |