General - Create holiday transfer request

API Url

Used for creating holiday transfer request.

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

Permissions: user

Path parameters

FieldTypeDescription
empIdString

Employee identifier

Query parameters

FieldTypeDescription
validateOnlyBoolean

Only validate transfer request.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    transfersObject[]

Collection of holiday transfer request

      accountIdoptionalString

Transfer to Account id

      typeString

Holiday type

      valueNumber

Requested transfer value

      yearNumber

Holding year

Request example:

{
"request": {
"data": {
"transfers": [
{
"type": "HOLIDAY",
"year": 2018,
"accountId": "S0200",
"value": 86400
}
]
}
}
}

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 request is to account). It is empty for transferring to next year.

      descriptionString

Account description. If its transferred to next year then it corresponding description.

      formatString

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

      unitNumber

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

      valueNumber

Transferred value.

  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": {
"transferred": [
{
"value": 27000,
"unit": 1,
"format": "HH:MM"
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}