Methods

  • get - Roster Shift Metadata

Resource

{
    "leaveRequests": [
        {
            "accruedBalance": "double",
            "amount": "string",
            "attachment": {
                "dateCreated": "date-time",
                "dateScanned": "date-time",
                "friendlyName": "string",
                "id": "int32",
                "isInfected": "boolean",
                "url": "string"
            },
            "canApprove": "boolean",
            "canCancel": "boolean",
            "canModify": "boolean",
            "employeeId": "int32",
            "employeeName": "string",
            "exceedsBalance": "boolean",
            "fromDate": "date-time",
            "hoursPerDay": "double",
            "id": "int32",
            "inProgress": "boolean",
            "isApproved": "boolean",
            "isCancelled": "boolean",
            "isDeclined": "boolean",
            "isPending": "boolean",
            "leaveCategoryId": "int32",
            "leaveCategoryName": "string",
            "notes": "string",
            "requestedDate": "date-time",
            "requireNotesForLeaveRequests": "boolean",
            "status": "string",
            "statusUpdateNotes": "string",
            "terminationDate": "date-time",
            "toDate": "date-time",
            "totalDays": "double",
            "totalHours": "double",
            "totalUnits": "double",
            "unitType": "string"
        }
    ],
    "rosteredShifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "startTime": "date-time"
                }
            ],
            "classificationId": "int32",
            "classificationName": "string",
            "cost": "double",
            "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"
                }
            ],
            "roleId": "int32",
            "roleName": "string",
            "startTime": "date-time",
            "token": "string",
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "unassignedShifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "startTime": "date-time"
                }
            ],
            "classificationId": "int32",
            "classificationName": "string",
            "cost": "double",
            "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"
                }
            ],
            "roleId": "int32",
            "roleName": "string",
            "startTime": "date-time",
            "token": "string",
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "unavailability": [
        {
            "endDate": "date-time",
            "fromDate": "date-time",
            "id": "int32",
            "isAllDay": "boolean",
            "reason": "string",
            "recurring": "boolean",
            "recurringDay": "string",
            "toDate": "date-time",
            "viewOnly": "boolean"
        }
    ]
}

Properties

Name Type Description
leaveRequests[] array
leaveRequests[].accruedBalance double Nullable
leaveRequests[].amount string String
leaveRequests[].attachment object AttachmentModel
leaveRequests[].attachment.dateCreated date-time Nullable
leaveRequests[].attachment.dateScanned date-time Nullable
leaveRequests[].attachment.friendlyName string String
leaveRequests[].attachment.id int32 Nullable
leaveRequests[].attachment.isInfected boolean Nullable
leaveRequests[].attachment.url string String
leaveRequests[].canApprove boolean Boolean
leaveRequests[].canCancel boolean Boolean
leaveRequests[].canModify boolean Boolean
leaveRequests[].employeeId int32 Int32
leaveRequests[].employeeName string String
leaveRequests[].exceedsBalance boolean Boolean
leaveRequests[].fromDate date-time DateTime
leaveRequests[].hoursPerDay double Decimal
leaveRequests[].id int32 Int32
leaveRequests[].inProgress boolean Boolean
leaveRequests[].isApproved boolean Boolean
leaveRequests[].isCancelled boolean Boolean
leaveRequests[].isDeclined boolean Boolean
leaveRequests[].isPending boolean Boolean
leaveRequests[].leaveCategoryId int32 Int32
leaveRequests[].leaveCategoryName string String
leaveRequests[].notes string String
leaveRequests[].requestedDate date-time DateTime
leaveRequests[].requireNotesForLeaveRequests boolean Boolean
leaveRequests[].status string String
leaveRequests[].statusUpdateNotes string String
leaveRequests[].terminationDate date-time Nullable
leaveRequests[].toDate date-time DateTime
leaveRequests[].totalDays double Decimal
leaveRequests[].totalHours double Decimal
leaveRequests[].totalUnits double Decimal
leaveRequests[].unitType string LeaveUnitTypeEnum

Possible values are:

  • Hours
  • Days
  • Weeks
rosteredShifts[] array
rosteredShifts[].accepted boolean Boolean
rosteredShifts[].biddable boolean Boolean
rosteredShifts[].breaks[] array
rosteredShifts[].breaks[].endTime date-time DateTime
rosteredShifts[].breaks[].id int32 Int32
rosteredShifts[].breaks[].startTime date-time DateTime
rosteredShifts[].classificationId int32 Nullable
rosteredShifts[].classificationName string String
rosteredShifts[].cost double Nullable
rosteredShifts[].datePublished date-time Nullable
rosteredShifts[].employeeId int32 Nullable
rosteredShifts[].employeeName string String
rosteredShifts[].endTime date-time DateTime
rosteredShifts[].id int32 Int32
rosteredShifts[].locationId int32 Nullable
rosteredShifts[].locationName string String
rosteredShifts[].notes string String
rosteredShifts[].pendingSwap object RosterShiftSwapModel
rosteredShifts[].pendingSwap.dateCreated date-time DateTime
rosteredShifts[].pendingSwap.fromEmployee string String
rosteredShifts[].pendingSwap.fromEmployeeId int32 Int32
rosteredShifts[].pendingSwap.id int32 Int32
rosteredShifts[].pendingSwap.note string String
rosteredShifts[].pendingSwap.rejectedReason string String
rosteredShifts[].pendingSwap.status int32 Int32
rosteredShifts[].pendingSwap.statusDescription string String
rosteredShifts[].pendingSwap.toEmployee string String
rosteredShifts[].pendingSwap.toEmployeeId int32 Int32
rosteredShifts[].published boolean Boolean
rosteredShifts[].qualifications[] array
rosteredShifts[].qualifications[].id int32 Int32
rosteredShifts[].qualifications[].name string String
rosteredShifts[].roleId int32 Int32
rosteredShifts[].roleName string String
rosteredShifts[].startTime date-time DateTime
rosteredShifts[].token string String
rosteredShifts[].workTypeId int32 Nullable
rosteredShifts[].workTypeName string String
unassignedShifts[] array
unassignedShifts[].accepted boolean Boolean
unassignedShifts[].biddable boolean Boolean
unassignedShifts[].breaks[] array
unassignedShifts[].breaks[].endTime date-time DateTime
unassignedShifts[].breaks[].id int32 Int32
unassignedShifts[].breaks[].startTime date-time DateTime
unassignedShifts[].classificationId int32 Nullable
unassignedShifts[].classificationName string String
unassignedShifts[].cost double Nullable
unassignedShifts[].datePublished date-time Nullable
unassignedShifts[].employeeId int32 Nullable
unassignedShifts[].employeeName string String
unassignedShifts[].endTime date-time DateTime
unassignedShifts[].id int32 Int32
unassignedShifts[].locationId int32 Nullable
unassignedShifts[].locationName string String
unassignedShifts[].notes string String
unassignedShifts[].pendingSwap object RosterShiftSwapModel
unassignedShifts[].pendingSwap.dateCreated date-time DateTime
unassignedShifts[].pendingSwap.fromEmployee string String
unassignedShifts[].pendingSwap.fromEmployeeId int32 Int32
unassignedShifts[].pendingSwap.id int32 Int32
unassignedShifts[].pendingSwap.note string String
unassignedShifts[].pendingSwap.rejectedReason string String
unassignedShifts[].pendingSwap.status int32 Int32
unassignedShifts[].pendingSwap.statusDescription string String
unassignedShifts[].pendingSwap.toEmployee string String
unassignedShifts[].pendingSwap.toEmployeeId int32 Int32
unassignedShifts[].published boolean Boolean
unassignedShifts[].qualifications[] array
unassignedShifts[].qualifications[].id int32 Int32
unassignedShifts[].qualifications[].name string String
unassignedShifts[].roleId int32 Int32
unassignedShifts[].roleName string String
unassignedShifts[].startTime date-time DateTime
unassignedShifts[].token string String
unassignedShifts[].workTypeId int32 Nullable
unassignedShifts[].workTypeName string String
unavailability[] array
unavailability[].endDate date-time Nullable
unavailability[].fromDate date-time DateTime
unavailability[].id int32 Int32
unavailability[].isAllDay boolean Boolean
unavailability[].reason string String
unavailability[].recurring boolean Boolean
unavailability[].recurringDay string Nullable

Possible values are:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
unavailability[].toDate date-time Nullable
unavailability[].viewOnly boolean Boolean