GET /integration/workforce/r1/timesheets/resources-calendars

BPMN Diagram

Business Logic

This Integration API returns a list of resource calendar within a specific time range.

The system checks that the date range in the filter object calendarDate does not exceed 7 days and that both the from and to values ​​are filled in.

One of operationCenterCode or identificationNumber/secondaryIdentificationNumber must be present.

System will return only work shift or work shift exceptions related to active Operations Center.

System verifies Permission Required and starts the elaboration that is organized in steps.

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 - Operation Center Validation and Retrieve

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

This step is skipped if operationCenterCode is absent

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 - Resource Retrieve

System takes Input fields and checks their existence.

This section is used only if input fields identificationNumber and/or secondaryIdentificationNumber are present

STEP 3a - Resource Retrieve

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

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

STEP 3b - Operation Center Retrieve

System takes Input fields and retrieve output values.

This step is skipped if operationCenterCode is present

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 3c - Work Shift Retrieve

System takes Input fields and checks their existence.

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

If System can’t obtain the Output fields → continue to step Work Shift Exceptions Retrieve.

STEP 3c - Work Shift Types Retrieve

System takes Input fields and checks their existence.

This step is skipped if input fields are absent.

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 3d - Work Shift Exceptions Retrieve

System takes Input fields and checks their existence.

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

If System can’t obtain the Output fields → continue to step Work Center Retrieve.

STEP 3e - Work Shift Exception Types Retrieve

System takes Input fields and checks their existence.

This step is skipped if input fields are absent.

If System can obtain the Output fields → continue to step Work Center Retrieve.

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

STEP 4 - Work Shift Retrieve

System takes Input fields and checks their existence.

This section is used only if both input fields identificationNumber and secondaryIdentificationNumber are absent.

STEP 4a - Work Shift Retrieve

System takes Input fields and checks their existence.

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

If System can’t obtain the Output fields → continue to step Work Shift Exceptions Retrieve.

STEP 4b - Work Shift Types Retrieve

System takes Input fields and checks their existence.

This step is skipped if input fields are absent.

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 4c - Work Shift Exceptions Retrieve

System takes Input fields and checks their existence.

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

If System can’t obtain the Output fields → continue to step Resources Retrieve.

STEP 4d - Work Shift Exception Types Retrieve

System takes Input fields and checks their existence.

This step is skipped if input fields are absent.

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 4f - Resources Retrieve

System takes Input fields and checks their existence.

This step is skipped if both Work Shift list and Work Shift Exception list are empty.

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 - Work Center Retrieve

System takes Input fields and checks their existence.

If System can obtain the Output fields → elaboration is stopped. See Response payload fields (it is possible to have in response an empty array)

If System can’t obtain the Output fields → elaboration is stopped. See Response payload fields

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

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

Filter

Fields

The parameter _fields allows to choose output fields. More info here How to use APIs: Output fields selection.

Header Parameters

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

Default.

Request Example

{baseUrl}/integration/timeesheets/r1/resources-calendars?externalSystemCode=SAP&identificationNumber=MI0030&calendarDate=from,2024-04-17T00:00:00.000Z,to,2024-04-20T00:00:00.000Z&operationCenterCode=OC61

Response documentation

Response payload fields

operationCenterObject

workCenterObject

workShiftTypeObject

workShiftExceptionTypeObject

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

Extension fields:

Response example

{     
  "extension": {},
  "content": [
    {
      "extension": {},
      "id": 3681,
      "name": "John",
      "surname": "Doe",
      "email": "john.doe@example.com",
      "mobilePhone": "+123456789",
      "identificationNumber": "JD3681",
      "identificationNumber2": "JD3681",
      "operationCenter": {
        "extension": {},
        "code": "OC61",
        "description": [
          {
            "lang": "en",
            "value": "Metro OC"
          }
        ]
      },
      "workCenter": {
        "extension": {},
        "code": "WCN61",
        "description": [
          {
            "lang": "en",
            "value": "Metro workCenter"
          }
        ]
      },
      "workShifts": [
        {
          "extension": {},
          "id": 50220,
          "startDate": "2024-10-10T08:00:00Z",
          "endDate": "2024-10-10T17:00:00Z",
          "breakStart": "2024-10-10T12:00:00Z",
          "breakEnd": "2024-10-10T13:00:00Z",
          "note": "note123",
          "type": {
            "code": "REGULAR",
            "description": "Regular"
          }
        },
        {
          "extension": {},
          "id": 50221,
          "startDate": "2024-10-11T08:00:00Z",
          "endDate": "2024-10-11T17:00:00Z",
          "breakStart": "2024-10-11T12:00:00Z",
          "breakEnd": "2024-10-11T13:00:00Z",
          "type": {
            "code": "REGULAR",
            "description": "Regular"
          }
        },
        {    
         "extension": {},
          "id": 54717,
          "startDate": "2024-10-10T22:00:00Z",
          "endDate": "2024-10-11T06:00:00Z",
          "type": {
            "code": "NIGHT",
            "description": "Night"
          }
        }
      ],
      "unavailabilities": [
        {   
          "extension": {},
          "id": 1261,
          "startDate": "2024-10-10T15:00:00Z",
          "endDate": "2024-10-10T16:00:00Z",
          "note": "security training",
          "workShiftExceptionType": {
            "code": "TRN",
            "description": [
              {
                "lang": "en",
                "value": "Training"
              }
            ]
          }
        }
      ]
    }
  ],
  "_page": {
    "num": 0,
    "hasMore": false
  }
}

Error example

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/timesheets/r1/resources-calendars",
  "code": "IA001_001"
}

Response error codes