Timetable Entries
https://api.activeintime.com/v1/timetables/[timetable_id]/timetable_entries.json
Will return information an array of Timetable Entries for a given timetable ID.
Parameters
Parameter | Required | Example | Description |
---|---|---|---|
timetable_id | Yes | 1 | The ID of a particular timetable. To get the ID you need to query a site to see which timetables have been created. |
fromDate | No | 2012-02-29 | The first date to get Timetable Entries from. Defaults to the current date if not present. |
numberOfDays | No | 7 | The amount of days to get Timetable Entries For from the fromDate, 1 is for the current day. Defaults to 1 if not present. Maximum 7 days including the fromDate. |
Response: An Array of Timetable Entry Objects
Object | Always present | Description |
---|---|---|
id | Yes | The ID of the Timetable Entry. |
start_time | Yes | The time the Timetable Entry begins. |
end_time | Yes | The time the Timetable Entry ends. |
date | Yes | The date the Timetable Entry occurs on. |
day | Yes | The day name that the Timetable Entry occurs on. |
term_type | Yes | The calendar period the Timetable Entry appears on. Term/Holiday/Special Event |
is_cancelled | Yes | Has the Timetable Entry been cancelled? |
cancellation_reason | No | The reason the Timetable Entry was cancelled. |
timetable_session | Yes | The Timetable Session of the Timetable Entry. |
facility | No | The Facility that the Timetable Entry occurs at. |
instructor | No | Instructor information for the Timetable Entry. |
level | Yes | The difficulty level associated with the Timetable Entry. |
ttentry_foreign_key | Yes | The CMS Booking code of the Timetable Entry. Can be blank or null. |
Example
{ "meta": { "X-RateLimit-Limit": 0, "X-RateLimit-Remaining": 0, "status": 200, "api_client": "", "locale": "en-gb" }, "response": [ ] }