UkEssBulkRosterShiftActionResponse resource

Methods

  • post - Bulk Accept Roster Shift Swaps
  • post - Bulk Cancel Roster Shift Swaps
  • post - Bulk Decline Roster Shift Swaps

Resource

{
    "notAcceptedShiftsCount": "int32",
    "pendingShiftCount": "int32",
    "proposedSwapCount": "int32",
    "shifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "isPaidBreak": "boolean",
                    "startTime": "date-time"
                }
            ],
            "datePublished": "date-time",
            "employeeId": "int32",
            "employeeName": "string",
            "endTime": "date-time",
            "id": "int32",
            "locationId": "int32",
            "locationName": "string",
            "notes": "string",
            "pendingSwap": {
                "dateCreated": "date-time",
                "fromEmployee": "string",
                "fromEmployeeId": "int32",
                "id": "int32",
                "note": "string",
                "rejectedReason": "string",
                "status": "int32",
                "statusDescription": "string",
                "toEmployee": "string",
                "toEmployeeId": "int32"
            },
            "published": "boolean",
            "qualifications": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "role": {
                "className": "string",
                "hexColourCode": "string",
                "id": "int32",
                "name": "string"
            },
            "shiftAssignmentStatus": "string",
            "shiftSwapCutoffTime": "date-time",
            "startTime": "date-time",
            "token": "string",
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ]
}

Properties

Name Type Description
notAcceptedShiftsCount int32 Int32
pendingShiftCount int32 Int32
proposedSwapCount int32 Int32
shifts[] array
shifts[].accepted boolean Boolean
shifts[].biddable boolean Boolean
shifts[].breaks[] array
shifts[].breaks[].endTime date-time DateTime
shifts[].breaks[].id int32 Int32
shifts[].breaks[].isPaidBreak boolean Boolean
shifts[].breaks[].startTime date-time DateTime
shifts[].datePublished date-time Nullable
shifts[].employeeId int32 Nullable
shifts[].employeeName string String
shifts[].endTime date-time DateTime
shifts[].id int32 Int32
shifts[].locationId int32 Nullable
shifts[].locationName string String
shifts[].notes string String
shifts[].pendingSwap object RosterShiftSwapModel
shifts[].pendingSwap.dateCreated date-time DateTime
shifts[].pendingSwap.fromEmployee string String
shifts[].pendingSwap.fromEmployeeId int32 Int32
shifts[].pendingSwap.id int32 Int32
shifts[].pendingSwap.note string String
shifts[].pendingSwap.rejectedReason string String
shifts[].pendingSwap.status int32 Int32
shifts[].pendingSwap.statusDescription string String
shifts[].pendingSwap.toEmployee string String
shifts[].pendingSwap.toEmployeeId int32 Int32
shifts[].published boolean Boolean
shifts[].qualifications[] array
shifts[].qualifications[].id int32 Int32
shifts[].qualifications[].name string String
shifts[].role object RosterShiftRole
shifts[].role.className string String
shifts[].role.hexColourCode string String
shifts[].role.id int32 Int32
shifts[].role.name string String
shifts[].shiftAssignmentStatus string Nullable

Possible values are:

  • Pending
  • Assigned
  • Bidding
  • PendingShiftSwap
  • PendingShiftSwapAwaitingApproval
  • ProposedShiftSwap
  • ProposedShiftSwapAwaitingApproval
shifts[].shiftSwapCutoffTime date-time Nullable
shifts[].startTime date-time DateTime
shifts[].token string String
shifts[].workTypeId int32 Nullable
shifts[].workTypeName string String