General - Get holidays list that uses input account

API Url

Load a holidays that uses input account id.

GET
http://localhost:16010/ProMarkREST/rest/General/accounts/{id}/holidays

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
idString

Unique account identifier.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    holidaysObject[]

Collection of holiday types.

      descriptionString

Holiday description.

      idString

Unique holiday type.

  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": {
"holidays": [
{
"id": "HOLIDAY",
"description": "Standard Holidays",
},
{
"id": "SERVICE",
"description": "Extra Service Days",
}
]
}
},
"errorCode": 0,
"errorMessage": ""
}