Get all Shift Schedules by Employee

Request

Retrieve all ShiftSchedules for a given Employee, identified by their id.

Security

clientCredentials

Path

employee_idstring^[a-zA-Z0-9.~\-_]{1,512}$required

The id of the Employee to retrieve ShiftSchedules for.

Payload

// No request payload

Responses

Known ShiftSchedules for the Employee. List may be empty if no ShiftSchedules were found.

Bodyapplication/json

Array [

idstringread-only

The unique ShiftSchedule ID, generated by the application upon creation.

Example:"f22896d0-ed42-4a14-a935-7a29072bc5ac"

namestring

An optional name for this ShiftSchedule.

Example:"Standard 38H"

startobject(ShiftScheduleStart)required

The start date and start week number of this shift schedule

templatesArray of objects, non-empty(RecurrencePeriod)required

List of non-null objects describing one calendar week (MON-SUN) worth of shifts.

versioninteger(Version)

The version of the shift schedule. Present when the shift schedule is returned in a list in a response.

Example:42

]

Response

[
  {
    "id": "f22896d0-ed42-4a14-a935-7a29072bc5ac",
    "name": "Standard 38H",
    "start": { … },
    "templates": [ … ],
    "version": 42
  }
]