General - Get holidays for all employees

API Url

Used for loading available holidays for employees under the current logged in user for manage holiday web-part.

GET

http://localhost:16010/ProMarkREST/rest/General/holidays

Permissions: user

Query parameters

Field	Type	Description
viewDate`optional`	date	Holding view at date, if not defined today's date is taken by default

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
holidays	Object[]	Collection of employee holidays.
accrued`optional`	Number	Accrued vacation
avatarURI`optional`	String	URI used for loading the employee avatar.
description	String	Vacation type description
empId	String	Employee Identifier.
empName	String	Employee Name.
empNo	String	Employee Number.
format`optional`	String	Account format ("HH:MM", "HH.CC", ".1", ".2" and so on)
fromLastYear`optional`	Number	Vacation from last year
initials	String	Employee initials.
leftToTransfer`optional`	Number	Left vacations to transfer
maxTransfer`optional`	Number	Maximun days to transfer
periodEnd	Date	Holding period end date
periodStart	Date	Holding period start date
planned`optional`	Number	Planned Vacation in the holding period
remaining`optional`	Number	Remaining vacation in the holding period
sortEmpNo	String	Sort employee Number.
total`optional`	Number	Total Vacation in the holding period
transferred`optional`	Number	Transferred vacation in the holding period
transferRequest`optional`	Number	Requested transfer vacation in the holding period
type	String	Vacation type identifier
unit`optional`	Number	Accounts unit (1: hours, 2: days).
used`optional`	Number	Used Vacation in the holding period
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": {
            "holidays": [
                {
                 "empId": "468",
                 "empNo": "HLC4",
                 "sortEmpNo": "!!!!HLC4",
                 "empName": "Henrik Lykke4",
                 "type": "EXTRA",
                 "description": "Extra Holiday",
                 "periodStart": "2018-01-01",
                 "periodEnd": "2018-12-31",
                 "fromLastYear": 0,
                 "accrued": 180000,
                 "total": 180000,
                 "used": 0,
                 "planned": 0,
                 "remaining": 180000,
                 "maxTransfer": 36000,
                 "transferRequest": 0,
                 "transferred": 0,
                 "leftToTransfer": 36000,
                 "unit": 1,
                 "format": "HH:MM"
             },
             {
                 "empId": "468",
                 "empNo": "HLC4",
                 "sortEmpNo": "!!!!HLC4",
                 "empName": "Henrik Lykke4",
                 "type": "HOLIDAY",
                 "description": "Holiday",
                 "periodStart": "2018-01-01",
                 "periodEnd": "2018-12-31",
                 "fromLastYear": 259200,
                 "accrued": 2160000,
                 "total": 2419200,
                 "used": 432000,
                 "planned": 432000,
                 "remaining": 1382400,
                 "maxTransfer": 950400,
                 "transferRequest": 86400,
                 "transferred": 172800,
                 "leftToTransfer": 691200,
                 "unit": 2,
                 "format": ".2"
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}