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
| Field | Type | Description |
|---|---|---|
| empId | String | Employee identifier |
Query parameters
| Field | Type | Description |
|---|---|---|
| type | String | Holiday type |
| year | Number | Holding year |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| transfers | Object[] | Collection of employee holiday transfer information |
accountIdoptional | String | Account identifier if transfer to acount else empty. |
| description | String | Transfer to type description. If its account than account description. |
| format | String | Account format ("HH:MM", "HH.CC", ".1", ".2" and so on) |
| maxValue | Number | Max possible transferrable value. |
| unit | Number | Accounts unit (1: hours, 2: days, 3: pieces). |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "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": ""}}