General - Sign-off an interval

API Url

Used for doing protime registration sign-offs

POST

http://localhost:16010/ProMarkREST/rest/General/sign-off

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.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
singoffs	Object[]	Collection of signoff intervals.
end	Date	End date of interval for signOff period.
start	Date	Start date of interval for signOff period.

Request example for adding signoffs via time interval:

{
    "request": {
        "data": {
            "signoffs": [
                {
                    "from": "2018-11-25",
                    "to": "2018-12-08"
                }
            ]
        }
    }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
errorCode	Number	Error Code if any
errorMessage	String	Error description.

Error example:

HTTP/1.1 422 Error example
 {
     "response": {
         "errorCode": 547,
         "errorMessage": "This period is already signoff!"
     }
 }