...
- Personal timetable
- Request access to the user's personal timetable by using OAuth, or use impersonation using an API token (if available).
- Retrieve a list of a user's subscriptions using the
/subscriptionscall. - Retrieve the timetable of a user using the
/timetablecall. - Add or remove subscriptions to a user's profile by using the
/subscriptionscalls. To retrieve a list of timetables that can be added, one can use the/timetablescall.
- Single timetable
- Retrieve a list of timetables for a certain type by using the /timetables call.
- The list of the previous call can be filtered using several filter options. The values for these filters can be retrieved using the
/timetablefilterscall. - After choosing the right timetable, the contents of the timetable can be retrieved using the
/timetables/<key>call.
A timetable always consists of a list of Event objects and is sorted by event start and end date. The events contain the following values:
| Name | Description |
|---|---|
| activityDescription | The description of the activity, could be the course, module or activity name. This should be shown to the user as 'main description'. |
| moduleCode | Some customers have a separate module code available which is a (semi-) unique identifier for a certain course of module. |
| activityTypeName | The name of the activity type this event belongs to. Key value which can be used to group and colour activities. Should not be shown to the end-user directly. |
| activityTypeDescription | The description of the activity type of this event. This value should be shown to the user and indicates whether the activity is a lecture, practical, exam, etc. Not all institutions provide (sensible) activity type information. |
| startDate | |
| endDate | |
| studentSets | |
| locations | |
| staffMembers | |
| notes |
Multiple databases
Output format
The resources support both JSON and XML. 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.
Authentication and authorisation
...
| Code Block |
|---|
$base_url/api/v0?_wadl |
Version numbering
Resources
/timetables
Description: Query all timetables with a specified type.
...