General - Get sign-off status

API Url

Used for checking if selected period signed-off or not

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/sign-offs

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
empId	String	Employee identifier

Query parameters

Field	Type	Description
from	Date	Period start date
to	Date	Period end date

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
signoffs	Object[]	Collection of signoff information
from	Date	Signoff period start date
signOff	Boolean	True = period is signed-off.
to	Date	Signoff period end date
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "signoffs": [
                {
                    "from": "2018-11-11",
                    "to": "2018-11-24",
                    "signOff": true
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}