NzRosterShiftMatchingResultModel resource

Methods

  • get - Find Matching Clock Off Roster Shift
  • get - Find Matching Clock On Roster Shift
  • get - Find Matching Clock Off Roster Shift
  • get - Find Matching Clock On Roster Shift
  • get - Find Matching Clock Off Roster Shift
  • get - Find Matching Clock On Roster Shift

Resource

{
    "shift": {
        "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
shift object NzEssRosterShiftModel
shift.accepted boolean Boolean
shift.biddable boolean Boolean
shift.breaks[] array
shift.breaks[].endTime date-time DateTime
shift.breaks[].id int32 Int32
shift.breaks[].isPaidBreak boolean Boolean
shift.breaks[].startTime date-time DateTime
shift.datePublished date-time Nullable
shift.employeeId int32 Nullable
shift.employeeName string String
shift.endTime date-time DateTime
shift.id int32 Int32
shift.locationId int32 Nullable
shift.locationName string String
shift.notes string String
shift.pendingSwap object RosterShiftSwapModel
shift.pendingSwap.dateCreated date-time DateTime
shift.pendingSwap.fromEmployee string String
shift.pendingSwap.fromEmployeeId int32 Int32
shift.pendingSwap.id int32 Int32
shift.pendingSwap.note string String
shift.pendingSwap.rejectedReason string String
shift.pendingSwap.status int32 Int32
shift.pendingSwap.statusDescription string String
shift.pendingSwap.toEmployee string String
shift.pendingSwap.toEmployeeId int32 Int32
shift.published boolean Boolean
shift.qualifications[] array
shift.qualifications[].id int32 Int32
shift.qualifications[].name string String
shift.role object RosterShiftRole
shift.role.className string String
shift.role.hexColourCode string String
shift.role.id int32 Int32
shift.role.name string String
shift.shiftAssignmentStatus string Nullable

Possible values are:

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