| Table of Contents |
|---|
...
The resources support both JSON and XML output. By default, the returned format depends on the HTTP Accept header. Use application/json for JSON and application/xml for XML. It is also possible to specify the output format in the URL, by appending .json or .xml to the resource name, before the query string. Dates and times are returned in ISO 8601 format (yyyy-MM-ddTHH:mm:ss±HH:mm) when retrieving results in XML, and in Unix timestamp format when retrieving JSON.
Output can be available in multiple languages. Use the Accept-Language HTTP header to specify the locale, for example NL-nl. When the specified locale is not available, the default locale will be used.
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
...
Description: Query a list of timetables for a specified type. The filters that can be specified can be retrieved using the /timetablefilters call. Returns a list of descriptions and identifiers. The identifiers can be used in subsequent calls to /timetables/{key} and /subscriptions/{key}.
Parameters
| Name | Description | Default value |
type(required) | The type of the timetables, e.g. 'module'. | - |
limit | The maximum amount of records returned. | 0 |
offset | Starting position of the records returned (e.g. offset=5 skips the first 5 records). | 0 |
departmentFilter | Filter results on a specific department. | - |
departmentGroupFilter | Filter results on a specific department group. | - |
posFilter | Filter results on a specific pos. | - |
zoneFilter | Filter results on a specific zone. | - |
...
Description: Query the schedule for the specified timetable identifier.
Parameters
| Name | Description | Default value |
key (required) | The key corresponding with the specific timetable, as retrieved using the /timetables call. | - |
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 |
...
Description: Query the personal timetable for the current user (as identified by the OAuth token or elevated API token).
Parameters
| Name | Description | Default value |
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 |
type | Specifies the type of the subscriptions to include when returning the timetable, can be specified multiple times, useful to exclude zone and location subscriptions when requesting the timetable. If not specified all subscriptions will be included in the result. | - |
...
Description: Query all filters available for a specific timetable type. Using the results it is possible to filter the output of this call and of the /timetables call. Returns a list of possible filtertypes. For each type a list of possible filter descriptions and identifiers is provided.
Parameters
| Name | Description | Default value |
type (required) | The type of the timetables to retrieve the filters for. | - |
departmentFilter | Filter results on a specific department. | - |
departmentGroupFilter | Filter results on a specific department group. | - |
zoneFilter | Filter results on a specific zone. | - |
...
Description: Retrieves all subscriptions for the current user (as identified by the OAuth token or elevated API token).
Parameters:
| Name | Description | Default value |
type | Specifies the type of the subscriptions to include, can be specified multiple times, useful to exclude zone and location subscriptions when requesting a personal list of subscriptions. If not specified all subscriptions will be included in the result. | - |
...
Description: Add a new subscription
Parameters
| Name | Description | Default value |
key (required) | The key of the timetable you wish to add. | - |
...
Description: Delete a subscription.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you wish to delete. | - |
...
Description: Edit a subscription. Use boolean values to trigger the subscription on or off.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you wish to edit. | - |
state | Boolean value indicating the state of the subscription. | false |
...
Description: Edit a subscription nested under a parent. Use boolean values to trigger the subscription on or off.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you wish to edit. | - |
parent (required) | The key of the parent of the subscription. | - |
state | Boolean value indicating the state of the subscription. | false |
...