General - Update employee registrations

API Url

Use for updating registrations for an employee.

PUT
http://localhost:16010/ProMarkREST/rest/General/employees/{emp_id}/registrations

Permissions: User

Path parameters

FieldTypeDescription
emp_idString

ID of the employee.

Query parameters

FieldTypeDescription
includeResultsoptionalBoolean

TRUE = return back the recalculation resulted postings. Use only with 'recalculate=true'.

recalculateoptionalBoolean

TRUE = recalculate the employee. No body data needed.

recalculateFromoptionalDate

If set, the recalculation will start from this date forward. Otherwise, it will be optimistically set based on changed registrations. Use only with 'recalculate=true'.

tolerantCalculationoptionalNumber

Tolerance level (0: Maximum tolerance, 1: Medium tolerance, 2: Reduced tolerance). Default is no tolerance.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

Success 200

FieldTypeDescription
    calculationoptionalObject

The recalculation results after all registrations are commited.

      calculationErroroptionalObject

If the calculation was not succesfull, this object includes the error details.

        empidObject

Unique ID of the employee containing the error.

        messageObject

The actual calculation error.

        regTimeObject

Time of the registration causing the calculation error.

        transSeqObject

Identifier of the registration causing the calculation error.

      calculationSuccessObject

If the calculation was succesfull, this object includes the outcome details.

        reportoptionalObject

Array of text lines for the recalculation report.

      completedSuccesfullyBoolean

TRUE = the recalculation completed without errors.

      resultMessageoptionalString

An optional recalculation message. Is more relevant when there are errors.