NextGen APIs
NextGen APIs
Breadcrumbs

POST /integration/workforce/r1/work-shift-exception-types

Http Verb

POST

Url

/integration/workforce/r1/work-shift-exception-types

Permissions required

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

Last Modified Version

r1

Tech Tags


Available Async

No

BPMN Diagram

diagram (19).svg

Business Logic

This Integration API creates a new Work Shift Exception Type.

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 - Work Shift Exception Class Retrieval

System takes Input fields and extract the Work Shift Exception classId.

API Verb: GET

Resource: Work Shift Exception Classes

Input: workShiftExceptionClassCode, active=true

Output: workShiftExceptionClassId

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 3 - Work Shift Exception Management Retrieval

System takes Input fields and extract the Work Shift Exception managementId.

API Verb: GET

Resource: Work Shift Exception Managements

Input: workShiftExceptionManagementCode

Output: managementId

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 Exception Impact Retrieval

System takes Input fields and extract the Work Shift Exception impactId.

API Verb: GET

Resource: Work Shift Exception Impacts

Input: workShiftExceptionImpactCode

Output: impactId

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 Exception Type Creation

System takes Input fields and creates a new record.

API Verb: POST

Resource: Work Shift Exception Types

Input: code, description, order, active, loan, note, color, externalCode, editable, workShiftExceptionClassId, impactId, managementId

Output: workShiftExceptionTypeId

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 &.

Not applicable.

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.

Field

Description

Mandatory

Constraint

1

externalSystemCode

External system code

Y

Not Blank

2

code

Work Shift Exception Type unique code

Y

Not Blank

3

description

Work Shift Exception Type description

Multilanguage field (see Conventions )

Y

Not Null

4

order

Work Shift Exception Type order

N


5

active

Work Shift Exception Type is enabled

N

default true

6

loan

Work Shift Exception Type is loan

Y

Not Null

7

note

Note

N


8

color

Work Shift Exception Type Color

N


9

externalCode

Work Shift Exception Type External Code

N


10

editable

Work Shift Exception Type is editable

N


11

workShiftExceptionClassCode

Work Shift Exception Class code

Y

Not Blank

12

workShiftExceptionImpactCode

Work Shift Exception Impact code

N

Null or Not Blank

13

workShiftExceptionManagementCode

Work Shift Exception Management code

N

Null or Not Blank

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

JSON
{
    "extension": {
        "myFieldName": "myValue"
    },
    "externalSystemCode": "string",
    "code": "string",
    "description": [
        {
            "lang": "string",
            "value": "string"
        }
    ],
    "order": 0,
    "active": true,
    "loan": true,
    "note": "string",
    "color": "string",
    "externalCode": "string",
    "editable": true,
    "workShiftExceptionClassCode": "string",
    "workShiftExceptionImpactCode": "string",
    "workShiftExceptionManagementCode": "string"
}

Response documentation

Response payload fields

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

Extension fields:

Field

Description

Note

id

Created instance id

Only for SUCCESS

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-shift-exception-types",
  "code": "IA001_001"
}

Response error codes