General - Get employee holidays

API Url

Used for loading all available holidays for an employee under each valid vacation type.

GET

http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/holidays

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`optional`	integer	From holding period year (if viewDate is used this value is ignored)
to`optional`	integer	To holding period year (if viewDate is used this value is ignored)
type`optional`	String	Holiday type
viewDate`optional`	date	View available holidays to till this date

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`	Date	Accrued holidays in accrued period
accruedUntil`optional`	Date	Accrued holidays till "view at" date for periodic accrued holiday types
description	String	Holiday type description
empId	String	Employee Identifier
format`optional`	String	Account format ("HH:MM", "HH.CC", ".1", ".2" and so on)
fromLastYear`optional`	Date	Holidays from last year
leftToTransfer`optional`	Number	Left holidays to transfer
maxTransfer`optional`	Number	Maximun days to transfer
periodEnd	Date	Holiday period end date
periodStart	Date	Holiday period start date
planned`optional`	Number	Planned holidays in the holiday period in future. If "view at" is defined, planned holidays after that date
remaining`optional`	Number	Remaining holidays at the end of holiday period
remainingUntil`optional`	Number	Remaining holidays until "view at" date against accured until date
total`optional`	Number	Total holidays in the holiday period
transferred`optional`	Number	Transferred holidays in the holiday period
transferRequest`optional`	Number	Requested transfer holidays in the holdiday period
type	String	Holiday type identifier
unit`optional`	Number	Accounts unit (1: hours, 2: days).
used`optional`	Number	Used holidays in the holiday period until today. If "View at" is defined, used holidays till that 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": {
            "holidays": [
                {
                    "empId": "468",
                    "type": "EXTRA",
                    "description": "Extra Holiday",
                    "periodStart": "2017-01-01",
                    "periodEnd": "2017-12-31",
                    "fromLastYear": 0,
                    "accrued": 0,
                    "total": 0,
                    "used": 0,
                    "planned": 0,
                    "remaining": 0,
                    "maxTransfer": 0,
                    "transferRequest": 0,
                    "transferred": 0,
                    "leftToTransfer": 0,
                    "unit": 1,
                    "format": "HH:MM"
                },
                {
                    "empId": "468",
                    "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"
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}