Versions Compared

Version Old Version 43 New Version 44
Changes made by

Former user

Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

NameDescription
activityDescriptionThe description of the activity, could be the course, module or activity name. This should be shown to the user as 'main description'.
moduleCodeSome customers have a separate module code available which is a (semi-) unique identifier for a certain course of module.
activityTypeNameThe 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.
activityTypeDescriptionThe 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.
startDateStart date and time of the event. See below for the date format.
endDateEnd date and time of the event. See below for the date format.
studentSetsList of student sets (e.g., classes, groups) associated with the event.
locationsList of locations associated with the event (consists of identifier, name, key and capacity, capacity, url and avoidConcurrencyLocationIds (MyTimetable v2.5+, list of id's of locations that are also occupied if this location is occupied)).
staffMembersList of staff members associated with the event.
notesSome notes or additional information about the event, not all customers use this field.

...

timetableKeys

Contains the list of subscriptions (timetables) this event is part of (MyTimetable v2.5+)
highlightedTrue iff the event should be highlighted in the interface (reason is customer or department specific) (MyTimetable v2.5+)

New fields may be added to objects without incrementing the version number. See API Documentation for details.

...

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

...

Example response body

Code Block
languagenone
[
    {
        "activityDescription": "VMTTsjechische forletterkunde Informatics2",
         "activityTypeDescription": "LectureWerkcollege",
         "activityTypeName": "ClassWerkcollege",
         "endDate": 13419306000001355320800000,
         "locationshighlighted": [false,
        "locations": [
  {          {
                "avoidConcurrencyLocationIds": [],
                "capacity": 1816, 
                "id": "D2D0C6A8E334B242289FBAA7F69759C3492E26C5A6F3BDE74C11240C046C3257", 
                "key": "#SPLUS9759C3908K04SEM1", 
                "name": "B3.022"Bungehuis K.04",
                "url": null
            }
        ], 
        "moduleCode": "#SPLUS04A710UvA/FGW/TLK_133214266", 
        "notes": null, 
        "staffMembers": [
            "Mrdr. Moore (Moo)E.R.G. Metz"
        ], 
        "startDate": 13419198000001355313600000, 
        "studentSets": [
   ],
        "BI group  1A", timetableKeys": [
            "BI group  1B2010!module!40B7FB6233A4AD9834C7B999276851F5"
        ]
    }
]

/timetable

Method: GET

...