General - Get requested holiday transfers

API Url

Used for loading holiday transfer registrations.

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

Permissions: @apiPrivate

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
empIDString

Employee identifier

Query parameters

FieldTypeDescription
holidayTypeString

Holiday type identifier

holidayYearoptionalNumber

Holiday year, if not defined then current year

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    transfersObject[]

Collection of holiday transfer registrations

      approvalTimeoptionalDate

Approved/rejected time as date-time ISO-8601

      approvedByoptionalString

User id who has approved/rejected the transfer

      fromFormatString

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

      fromUnitNumber

Accounts unit that is used to transfer from. Possible values 1: hours, 2: days.

      fromValueNumber

The value that is requested to transfer from(It is formatted based on fromUnit and fromFormat on FE)

      idString

Transfer registrations identifier (used for internal purpose)

      requestedTimeDate

Holiday transfer requested date and time as ISO-8601

      statusNumber

Approval status. Possible values are: 1 = Untreated, 2 = Approved, 3 = Rejected. If status = 1 then only it is allowed to regret holiday transfer.

      statusDescNumber

Approval status description.

      toString

Transferred to account name

      toFormatString

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

      toUnitNumber

Accounts unit that is used to transfer to. Possible values 1: hours, 2: days.

      toValueNumber

The value that is requested to transfer to (It is formatted based on toUnit and toFormat on FE)

  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": [
{
"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": ""
}
}