v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Employee Service

getSchedulesV1

List schedules of employees.

get/employee/v1/getSchedules

Query parameters

includeNullboolean

Specify 'true' to output null data elements.

locationCodestring required

The Code that identifies the Location in Crunchtime.

minutesSinceUpdateinteger

The number of minutes since the schedule record was last updated. Use to set how far back to search.

startDatestring required

Start date of schedule to retrieve, in 'YYYYMMDD' format.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

employeeNumberstring

The Employee Number for the scheduled employee/shift.

employeePosCodestring

The POS Code for the scheduled employee/shift.

endDatetimestring date-time

The End Date & Time for the employee's scheduled shift.

laborDatestring

The Labor Date for the schedule.

locationCodestring

The Code for the Location associated with the schedule.

positionCodestring

The Position Code for the scheduled employee/shift.

positionNamestring

The Position Name for the scheduled employee/shift.

startDatetimestring date-time

The Start Date & Time for the employee's scheduled shift.

Example response

[
  {
    "employeeNumber": "0000000285",
    "endDatetime": "06/05/2012 10:00:00",
    "positionName": "CLEANING (GT)",
    "startDatetime": "06/05/2012 06:00:00"
  }
]