Methods

  • get - Get Roster Shift by ID

Resource

{
    "accepted": "boolean",
    "biddable": "boolean",
    "breaks": [
        {
            "endTime": "date-time",
            "id": "int32",
            "startTime": "date-time"
        }
    ],
    "classificationId": "int32",
    "classificationName": "string",
    "cost": "double",
    "costFormatted": "string",
    "currentShift": {
        "isLate": "boolean",
        "isNotClockedOff": "boolean",
        "status": "string"
    },
    "datePublished": "date-time",
    "employeeId": "int32",
    "employeeName": "string",
    "employeePhoneNumber": "string",
    "endTime": "date-time",
    "id": "int32",
    "isLeaveBasedRosterShift": "boolean",
    "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"
    },
    "startTime": "date-time",
    "token": "string",
    "warnings": [
        "string"
    ],
    "workTypeId": "int32",
    "workTypeName": "string"
}

Properties

Name Type Description
accepted boolean Boolean
biddable boolean Boolean
breaks[] array
breaks[].endTime date-time DateTime
breaks[].id int32 Int32
breaks[].startTime date-time DateTime
classificationId int32 Nullable
classificationName string String
cost double Nullable
costFormatted string String
currentShift object ManagerCurrentRosterShift
currentShift.isLate boolean Boolean
currentShift.isNotClockedOff boolean Boolean
currentShift.status string TimeAttendanceStatus

Possible values are:

  • NotClockedOn
  • ClockedOn
  • OnBreak
  • ClockedOff
datePublished date-time Nullable
employeeId int32 Nullable
employeeName string String
employeePhoneNumber string String
endTime date-time DateTime
id int32 Int32
isLeaveBasedRosterShift boolean Boolean
locationId int32 Nullable
locationName string String
notes string String
pendingSwap object RosterShiftSwapModel
pendingSwap.dateCreated date-time DateTime
pendingSwap.fromEmployee string String
pendingSwap.fromEmployeeId int32 Int32
pendingSwap.id int32 Int32
pendingSwap.note string String
pendingSwap.rejectedReason string String
pendingSwap.status int32 Int32
pendingSwap.statusDescription string String
pendingSwap.toEmployee string String
pendingSwap.toEmployeeId int32 Int32
published boolean Boolean
qualifications[] array
qualifications[].id int32 Int32
qualifications[].name string String
role object RosterShiftRole
role.className string String
role.hexColourCode string String
role.id int32 Int32
role.name string String
startTime date-time DateTime
token string String
warnings[] array of string
workTypeId int32 Nullable
workTypeName string String