Retrieve Requestable Shift Templates for Self-Scheduling

This operation retrieves requestable shift templates by request subtype, start date, end date, location, job, selected shift templates, filtering order, common shift templates, and optional additional filtering context.

The associated Access Control Point is WFF_EMPLOYEE_SELFSERVICE_REQUESTS.

Example call

Example request

{
  "where": {
    "requestSubtype": {
      "id": 652,
      "qualifier": "shift template"
    },
    "startDate": "2022-09-10",
    "endDate": "2022-09-25",
    "location": {
      "id": 1
    },
    "index": 0,
    "job": {
      "id": 122
    },
    "shiftTemplateFilteringContext": {
      "employees": [
        {
          "id": 69
        }
      ]
    },
    "count": 10,
    "showCommonShiftTemplates": false,
    "selfSchedulingFilteringOrder": "START_TIME_ASC"
  }
}

Example response

[
  {
    "day": "2022-09-21",
    "shiftTemplateDetails": [
      {
        "shiftTemplate": {
          "id": 21,
          "name": "N4-3A",
          "systemGenerated": false,
          "startDateTime": "2022-09-21T03:00:00",
          "endDateTime": "2022-09-21T07:30:00",
          "description": "3AM-7:30AM shift with 30 min supper",
          "version": "2018-04-22T15:37:41",
          "segments": [
            {
              "id": 61,
              "segmentType": {
                "id": 1,
                "qualifier": "REGULAR_SEGMENT"
              },
              "startDateTime": "2022-09-21T03:00:00",
              "endDateTime": "2022-09-21T05:00:00",
              "orgNode": {
                "id": 122,
                "qualifier": null
              },
              "orderNumber": 1,
              "segmentTemplateTags": [

              ]
            },
            {
              "id": 62,
              "segmentType": {
                "id": 4,
                "qualifier": "BREAK_SEGMENT"
              },
              "startDateTime": "2022-09-21T05:00:00",
              "endDateTime": "2022-09-21T05:30:00",
              "orderNumber": 2,
              "segmentTemplateTags": [

              ]
            },
            {
              "id": 63,
              "segmentType": {
                "id": 1,
                "qualifier": "REGULAR_SEGMENT"
              },
              "startDateTime": "2022-09-21T05:30:00",
              "endDateTime": "2022-09-21T07:30:00",
              "orgNode": {
                "id": 122,
                "qualifier": null
              },
              "orderNumber": 3,
              "segmentTemplateTags": [

              ]
            }
          ],
          "deleted": false,
          "locked": false
        }
      }
    ]
  }
]