| Table of Contents |
|---|
...
Input can be provided in the form of HTTP GET URL parameters or an HTTP POST/PUT body that is in application/x-www-form-urlencoded. Most parameters are optional, when this is not the case this is mentioned in the documentation. Dates and times can be specified in one of the following format:
- 'today' or 'tomorrow' for the current or next day at 0:00;
- Unix timestamp format;
- ISO 8601 format (
yyyy-MM-ddTHH:mm:ss±HH:mm): elements on the right side (time, time zone) are optional; - Legacy format (
YYYY/MM/DD HH:MM): the time is optional.
Authentication and authorisation
...
| Name | Description | Default value |
key (required) | The key corresponding with the specific timetable, as retrieved using the /timetables call. | - |
| fetchBy | Use 'hostKey' to retrieve the events by it's timetable host key instead of timetable key. (MyTimetable v2.3 and higher) | - |
startDate | The start date to retrieve events from, or 'today' for the current date at 0:00, or 'tomorrow' for tomorrow at 0:00, or none for the beginning of times. | - |
endDate | The end date to retrieve events till, or 'today' for the current date at 0:00, or 'tomorrow' for tomorrow at 0:00, or none for the end of times. | - |
limit | The maximum amount of records returned, 0 for no limit. | 0 |
Example request URLURLs
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/timetables/2011!module!49CBD432F01E8C5057B344E02604A710 |
...