Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Collective Schedules

Get a Collective Schedule from a Working Time Arrangement by id.

<Warning> **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. </Warning>

Get a Collective Schedule of a Working Time Arrangement by id

get/schedule/api/working-time-arrangements/{workingTimeArrangementId}/collective-schedules/{collectiveScheduleId}

Response

OK

idinteger required

The unique identifier of this Collective Schedule.

workingTimeArrangementIdinteger required

The unique identifier of the Working Time Arrangement this Collective Schedule belongs to.

startsOnstring date nullable

The date (included) from which this Collective Schedule is applicable. Must be left null for the very first Collective Schedule of a Working Time Arrangement.

endsOnstring date nullable

The date (included) from which this Collective Schedule is no longer applicable. Is null for the last Collective Schedule of a Working Time Arrangement. Can not be modified as its equal to the day before the next applicable Collective Schedule for this Working Time Arrangement.

splitsHalfDaysboolean required

Should half-days be discriminated? In other words, should shifts belong to half days rather than just the day itself?

Example response

{
  "pattern": {
    "monday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "tuesday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "wednesday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "thursday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "friday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "saturday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    },
    "sunday": {
      "shifts": [
        {
          "duration": {
            "iso": "PT7H30M"
          }
        }
      ],
      "workDuration": {
        "iso": "PT7H30M"
      }
    }
  }
}