General - Update employee registrations
API Url
Use for updating registrations for an employee.
http://localhost:16010/ProMarkREST/rest/General/employees/{emp_id}/registrations
Permissions: User
Path parameters
| Field | Type | Description |
|---|---|---|
| emp_id | String | ID of the employee. |
Query parameters
| Field | Type | Description |
|---|---|---|
includeResultsoptional | Boolean | TRUE = return back the recalculation resulted postings. Use only with 'recalculate=true'. |
recalculateoptional | Boolean | TRUE = recalculate the employee. No body data needed. |
recalculateFromoptional | Date | 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'. |
tolerantCalculationoptional | Number | Tolerance level (0: Maximum tolerance, 1: Medium tolerance, 2: Reduced tolerance). Default is no tolerance. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
Success 200
| Field | Type | Description |
|---|---|---|
calculationoptional | Object | The recalculation results after all registrations are commited. |
calculationErroroptional | Object | If the calculation was not succesfull, this object includes the error details. |
| empid | Object | Unique ID of the employee containing the error. |
| message | Object | The actual calculation error. |
| regTime | Object | Time of the registration causing the calculation error. |
| transSeq | Object | Identifier of the registration causing the calculation error. |
| calculationSuccess | Object | If the calculation was succesfull, this object includes the outcome details. |
reportoptional | Object | Array of text lines for the recalculation report. |
| completedSuccesfully | Boolean | TRUE = the recalculation completed without errors. |
resultMessageoptional | String | An optional recalculation message. Is more relevant when there are errors. |