General - Create holiday transfer request
API Url
Used for creating holiday transfer request.
http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/holidays/transfers
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
| empId | String | Employee identifier |
Query parameters
| Field | Type | Description |
|---|---|---|
| validateOnly | Boolean | Only validate transfer request. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| transfers | Object[] | Collection of holiday transfer request |
accountIdoptional | String | Transfer to Account id |
| type | String | Holiday type |
| value | Number | Requested transfer value |
| year | Number | Holding year |
Request example:
{"request": {"data": {"transfers": [{"type": "HOLIDAY","year": 2018,"accountId": "S0200","value": 86400}]}}}
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 request is to account). It is empty for transferring to next year. |
| description | String | Account description. If its transferred to next year then it corresponding description. |
| format | String | Account format ("HH:MM", "HH.CC", ".1", ".2" and so on). |
| unit | Number | Accounts unit (1: hours, 2: days, 3: pieces). |
| value | Number | Transferred value. |
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": {"transferred": [{"value": 27000,"unit": 1,"format": "HH:MM"}]},"errorCode": 0,"errorMessage": ""}}