Schedules

Types

The Schedule object

Field Type Description
ScheduleId int unique id for the schedule
ScheduleName string Schedule name
Shifts array of Shift objects List of shifts associated with the schedule

The Shift Object

Field Type Description
ShiftId int unique id for the shift
ShiftName string Shift name

Endpoints

Get Schedule List

Returns a list of company’s schedules.

Authorization needed

Request
GET https://api.ninthbrain.com/Schedule/GetList?api-version=2.0
Example response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1342521939
{
  "ScheduleId": 123,
  "ScheduleName": "Sample Schedule"
  "Shifts": [
        {
          "ShiftId" : 123,
          "ShiftName" : "Sample Shift"
        },
        {
          "ShiftId" : 124,
          "ShiftName" : "Sample Shift 2"
        }
  ]
}
Errors
  • bad_request (HTTP 400)
  • unauthorized (HTTP 401) - This APIKey is not valid for this service.
  • internal_error (HTTP 500)