Supplement - Put allowance rate

API Url

Used for updating allowance rate data

PUT
http://localhost:16010/ProMarkREST/rest/Supplements/allowance-rates/{objectId}

Permissions: user

Path parameters

FieldTypeDescription
objectIdNumber

Unique id.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    allowanceRatesObject[]

Collection of allowance rates to be updated

      addendaIdString

Supplement Id

      addendaTypeNumber

Supplement type

      employeeIdString

Employee Id

      fromDateDate

Allowance rate from date

      idNumber

Unique identifier for the allowance rate

      patchAreaString

Patch Area

      projectIdString

Project Id

      rateDecimal

Allowance rate

      toDateDate

Allowance rate to date

      unitTypeNumber

unitType

      versionNumber

Version

Request example:

{
"request": {
"data": {
"allowanceRates": [
{
"id": 2163959395,
"employeeId": "1292",
"projectId": "AARSLEFFII",
"addendaId": "0A",
"fromDate": "2019-09-01",
"rate": 94,
"version": 0,
"patchArea": "",
"addendaType": 0,
"unitType": 1
}
]
}
}
}

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

{
"response": {
"errorCode": 1,
"errorMessage": "error text"
}
}