NextGen APIs
NextGen APIs
Breadcrumbs

DELETE /integration/workforce/r1/work-shifts

Http Verb

DELETE

Url

/integration/workforce/r1/work-shifts

Permissions required

Core Additional Parameters: Edit (fsm.core.additionalparameter.edit)

Resource Configuration: View (fsm.core.resource.configuration.view)

Last Modified Version

r1

Tech Tags


Available Async

No

BPMN Diagram

diagram (18).svg

Business Logic

This Integration API deletes the required Work Shift.

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.

API Verb: GET

Resource: External Systems

Input: externalSystemCode, active=true

Output: externalSystemId

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.

Error Type:

STEP 2 - Resource Validation

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

API Verb: GET

Resource: Resource

Input: identificationNumber, loan=false

Output: resourceId

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.

Error Type:

STEP 4 - Work Shift Retrieval

System takes Input fields and extract all the WorkShifts filtered by resourceId and dates in input (from and to).

API Verb: GET

Resource: Work Shift

Input: resourceId, from, to

Output: workShiftIdList

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.

Error Type:

STEP 5 - Work Shift Deletion

For each item in workShiftIdList, system takes Input field and deletes the required record.

API Verb: DELETE

Resource: Work Shift Delete

Input: workShiftId

Output: -

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

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

Error Type:

  • Others - see link in Resource

Path Parameters

Not present.

Query String Parameters

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

Filters


Field

Description

Mandatory

Constraint

1

externalSystemCode

External system code

Y

Not Blank

2

identificationNumber

Resource identification number

Y

Not Blank

3

from

Work Shift date from

Y

Not Null

4

to

Work Shift date to

Y

Not Null


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.

Request example

JSON
{baseUrl}/integration/workforce/r1/work-shifts?externalSystemCode=SAP&identificationNumber=MI0011&from=2024-04-17T05:30:00.000Z&to=2024-04-18T18:00:00.000Z

Response documentation

Response payload fields

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

Extension fields:

Field

Description

Note

code

Extension member of a Problem Details Object that contains the error code

Only for ERROR

Response example

Error example

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

Response error codes