General - Save/delete a list of temporary registrations

API Url

Use it to save/edit a list of temporary registrations

PUT
http://localhost:16010/ProMarkREST/web/General/employees/{empId}/temporary-registrations?date=2021-08-01

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
emp_idString

Employee id.

Query parameters

FieldTypeDescription
dateoptionalDate

Selected day for the break intervals

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    cancelBreakObject

Employees cancel break

      breakProfIdString

Break profile id

      breaksObject[]

Collection of temporary cancel breaks

        endNumber

Break interval end

        isCanceledLogical

True -> create temporary cancel break if it doesn't exists False -> delete temporary cancel break if exists

        startNumber

Break interval start

    temporaryRegistrationsObject

Employees temporary registrations

Request example:

{
"request": {
"data": {
"temporaryRegistrations":
[
{
"type":"CB",
"empId" :"400",
"cancelBreak":
{
"breakProfId":"vpeid",
"isCanceled": yes,
break:{
"start": 14400,
"end": 16200
}
}
},
{}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.