General - Get holiday transfers options

API Url

Used for loading possible tranferrable holidays for the employee, includimg maximum transferrable value.

GET
http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/holidays/transfer-options

Permissions: user

Path parameters

FieldTypeDescription
empIdString

Employee identifier

Query parameters

FieldTypeDescription
typeString

Holiday type

yearNumber

Holding year

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    transfersObject[]

Collection of employee holiday transfer information

      accountIdoptionalString

Account identifier if transfer to acount else empty.

      descriptionString

Transfer to type description. If its account than account description.

      formatString

Account format ("HH:MM", "HH.CC", ".1", ".2" and so on)

      maxValueNumber

Max possible transferrable value.

      unitNumber

Accounts unit (1: hours, 2: days, 3: pieces).

  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": {
"transfers": [
{
"accountId": "",
"description": "Transfer to next year",
"maxValue": 86400,
},
{
"accountId": "S0200",
"description": "Hours bank total",
"maxValue": 86400,
},
{
"accountId": "S0210",
"description": "Holiday payout",
"maxValue": 86400,
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}