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.

GET
http://localhost:16010/ProMarkREST/web/SignOff/:resource/days

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
resourceString

The subject type. Only "employees" today.

Query parameters

FieldTypeDescription
filteroptionalString

Selection filter as a json expression. See the Global Employee Filter for schema and structure. Its 'type' must be the employee filter type.

fromDate

First day of the interval.

idsoptionalString

Comma separated subject ids. Employee ids (internal emp_id), not employee numbers. Mutually exclusive with 'filter'; one of the two is required.

tooptionalDate

Last day of the interval. Defaults to 'from'.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    failuresObject[]

Subjects that could not be read.

      dateoptionalDate

The day, or null when the failure is not about one day.

      errorCodeNumber

GE/BASE message number.

      errorMessageString

The refusal, already translated.

      idString

Subject id.

    signOffsObject[]

One row per relevant day per subject.

      atoptionalString

When that change happened.

      byoptionalString

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".

      dateDate

The day.

      idString

Subject id.

      signedOffBoolean

TRUE = the day is signed off.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"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

FieldTypeDescription
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.