PATCH /integration/workforce/r1/work-shift-exceptions

BPMN Diagram

Business Logic

This Integration API updates in batch Work Shift Exception records associated to the Resource retrieved by the identificationNumber in input.

The Private API Suite mandates the verification of OverITs’ software license and the required user permissions. Each call initiated by the Integration API will activate both validations. Only upon successful completion of these validations can the business processes commence.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 2 - Resource Retrieval

System takes Input fields and extract the Resource filtered by identificationNumber.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 3 - Work Shift Exception Type Retrieval

This step is performed only if workShiftExceptionTypeCode is passed in input.

System takes Input fields and extract the Work Shift Exception Type id filtered by workShiftExceptionTypeCode.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 4 - Work Shift Exception Retrieval

System takes Input fields and extract all Work Shift Exception records related to the resourceId and workShiftExceptionTypeId (if present), filtered in the startDate-endDate time frame.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 5 - Address Retrieval

This step is performed only if addressCode in input is set.

System takes Input fields and extract the addressId value.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 6 - Work Shift Exceptions Update

System takes workShiftExceptionList in input and updates all records in it.

If Creation outcome is SUCCESS → elaboration is stopped. See Response payload fields.

If Creation outcome is ERROR → elaboration is stopped. See Response payload fields.

Path Parameters

Not present.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Fields

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

The objects in input could have also the extension object that allows to add additional, customized data to this API. More info here How to use APIs: Custom data via Extension.

Request example

{baseUrl}/integration/workforce/r1/work-shift-exceptions?externalSystemCode=SAP&identificationNumber=MI0030&startDate=2024-08-10T08:00:00.000Z&endDate=2024-08-20T18:00:00.000Z&workShiftExceptionTypeCode=ASSN1

{
    "extension": {
        "myFieldName": "myValue"
    },
    "startTime": "06:30",
    "endTime": "16:30",
    "addressCode": "string",
    "note": "string"
}

Response documentation

Response payload fields

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Response example

Error example

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/workforce/r1/work-shift-exceptions",
  "code": "IA001_001"
}

Response error codes