General - Get requested holiday transfers
API Url
Used for loading holiday transfer registrations.
http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/holidays/transfers
Permissions: @apiPrivate
Request headers
| Field | Type | Description |
|---|---|---|
Accept-Languageoptional | String | =en-GB Language use for localization. |
X-Clientoptional | String | =Client type. "Portal""Mobile""Admin" |
X-Roleoptional | Number | ProMark role (1: Employee, 2: User). {12} |
X-WebPart-Idoptional | Number | Unique web-part identifier. |
Path parameters
| Field | Type | Description |
|---|---|---|
| empID | String | Employee identifier |
Query parameters
| Field | Type | Description |
|---|---|---|
| holidayType | String | Holiday type identifier |
holidayYearoptional | Number | Holiday year, if not defined then current 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 holiday transfer registrations |
approvalTimeoptional | Date | Approved/rejected time as date-time ISO-8601 |
approvedByoptional | String | User id who has approved/rejected the transfer |
| fromFormat | String | Account unit format ("HH:MM", "HH.CC", ".1", ".2" and so on). |
| fromUnit | Number | Accounts unit that is used to transfer from. Possible values 1: hours, 2: days. |
| fromValue | Number | The value that is requested to transfer from(It is formatted based on fromUnit and fromFormat on FE) |
| id | String | Transfer registrations identifier (used for internal purpose) |
| requestedTime | Date | Holiday transfer requested date and time as ISO-8601 |
| status | Number | Approval status. Possible values are: 1 = Untreated, 2 = Approved, 3 = Rejected. If status = 1 then only it is allowed to regret holiday transfer. |
| statusDesc | Number | Approval status description. |
| to | String | Transferred to account name |
| toFormat | String | Account unit format ("HH:MM", "HH.CC", ".1", ".2" and so on). |
| toUnit | Number | Accounts unit that is used to transfer to. Possible values 1: hours, 2: days. |
| toValue | Number | The value that is requested to transfer to (It is formatted based on toUnit and toFormat on FE) |
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": [{"requestedTime": "2018-10-16T13:51:39.000","to": "Transfer to next year","fromValue": 86400,"fromUnit": 2,"fromFormat": ".2","toValue": 27000,"toUnit": 1,"toFormat": "HH:MM","status": 2,"statusDesc": "Approved","approvalTime": "2018-11-30T13:02:50.000","approvedBy": "STB","id": "0x0000000000309291"},{"requestedTime": "2018-10-16T15:57:42.000","to": "Holidays","fromValue": 86400,"fromUnit": 2,"fromFormat": ".2","toValue": 86400,"toUnit": 2,"toFormat": ".2","status": 2,"statusDesc": "Approved","approvalTime": "2018-10-16T15:59:49.000","id": "0x0000000000309292"},{"requestedTime": "2018-11-30T12:43:53.000","to": "Holidays","fromValue": 43200,"fromUnit": 2,"fromFormat": ".2","toValue": 43200,"toUnit": 2,"toFormat": ".2","status": 2,"statusDesc": "Approved","approvalTime": "2018-11-30T12:49:11.000","approvedBy": "STB","id": "0x0000000000309293"}]},"errorCode": 0,"errorMessage": ""}}