| Table of Contents |
|---|
...
Input can be provided in the form of HTTP GET URL parameters (which should be URL encoded properly) 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 (in milliseconds sinds 1970, so don't forget to multiply/divide by 1000);
- 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
...
| Code Block | ||
|---|---|---|
| ||
{
"timetableType": [
"location",
"zone",
"module",
"student",
"staff",
"pos",
"posss",
"studentset",
"studentsetgroup",
"modulegroup",
"user",
"tag"
]
} |
/timetabletypesdetails (since MyTimetable 3.0)
Method: GET
Description: Query all possible timetable types and return them including some details regards naming, whether or not they can include child timetables and their ordering in the menus.
...
/timetables/{key}/options (since MyTimetable 3.1)
Method: GET
Description: Query the available options for the specified timetable. These options can be set on the subscription using the PUT call on a subscription. The allEquivalent boolean in the output will be true if any choice of options results in the same timetable.
...
/timetables/{parent}/{key}/options (since MyTimetable 3.1)
Method: GET
Description: Query the available options for the specified child of a timetable. These options can be set on the subscription using the PUT call on a subscription. The allEquivalent boolean in the output will be true if any choice of options results in the same timetable.
...
/subscriptions/{key}/options (since MyTimetable 3.1)
Method: PUT
Description: Set selected options of a subscription. Specifying all possible options will cause the list of selected options to be cleared, showing the complete timetable to the user.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you with to set the options for. | - |
| option (required) | The id of the option, retrieved using the /timetables/{key}/options call. Can be specified multiple times. Should be specified as a form parameter. | - |
...
Description: Clear the list of selected options of a subscription, which will cause all activities of the timetable to be shown to the user.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you with to clear the options for. | - |
...
/subscriptions/{parent}/{key}/options (since MyTimetable 3.1)
Method: PUT
Description: Set selected options of a subscription nested under a parent. Specifying all possible options will cause the list of selected options to be cleared, showing the complete timetable to the user.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you with to set the options for. | - |
parent (required) | The key of the parent of the subscription. | - |
| option (required) | The id of the option, retrieved using the /timetables/{parent}/{key}/options call. Can be specified multiple times. Should be specified as a form parameter. | - |
...
Description: Clear the list of selected options of a subscription nested under a parent, which will cause all activities of the timetable to be shown to the user.
Parameters
| Name | Description | Default value |
key (required) | The key of the subscription you with to clear the options for. | - |
parent (required) | The key of the parent of the subscription. | - |
...
| Code Block | ||
|---|---|---|
| ||
{
"feedUrl": "http://myuniversity/ical?eu=FKW92Fawier&t=556cf8a1-704a-4997-bc4d-5acf395eccaf",
"username": "testuser"
} |
/weeklabels (deprecated since MyTimetable 2.7, replaced by: /weeklabelmaps)
Method: GET
Description: Query the weeklabels. This provides custom labels for the weeks when available. The response includes a value (the custom label) and a week (year - 1900 + the ISO week number).
...
| Code Block | ||
|---|---|---|
| ||
{
weeklabel: [
{
"week": 11223,
"value": "23"
},
{
"week": 11224,
"value": "24"
}
]
} |
/weeklabelmaps (since MyTimetable 2.7)
Method: GET
Description: Query the weeklabel maps. This provides the available maps with custom labels for the weeks. Per weeklabel map, the response includes a key and a boolean which indicates whether the map is the default weeklabel map for the requested user.
...
| Code Block | ||
|---|---|---|
| ||
{
"weeklabelmaps": [
{
"key": "SYLLABUS",
"isDefault": true
}
]
} |
/weeklabelmaps/{key} (since MyTimetable 2.7)
Method: GET
Description: Retrieve the specified weeklabel map. This provides the key, a boolean which indicates if this is the default weeklabel map for the requested user and the actiual map with custom labels for the weeks.
...
| Code Block | ||
|---|---|---|
| ||
{
"database": [
"2011"
]
} |
/eventtypegroups (since MyTimetable 3.0)
Method: GET
Description: Query the event type groups and event filtering settings.
...
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/eventtypegroups |
Request Content-Type
application/x-www-form-urlencoded
Example request body
| Code Block | ||
|---|---|---|
| ||
eventTypeGroups%5BExcursie%5D%5BisFiltered%5D=true&eventTypeGroups%5BHoorcollege%5D%5BisFiltered%5D=false&eventTypeGroups%5BOther%5D%5BisFiltered%5D=false |
...