Versions Compared

Key

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

...

The MyTimeTable API allows you to retrieve timetables and alter user's MyTimetable profiles. Most of the data in MyTimetable can be accessed using the API, and the possibilities are expanded continuously.  The API is based on REST principles, and is currently on version 0. Requests can be done using the various available HTTP verbs (GET, POST, PUT and DELETE).

The API documentation uses the variable $base_url to refer to the base URL of MyTimetable. This URL depends on the customer and can be found on the Customer-specific API information page.

Not 

Output format

The resources support both JSON and XML. To switch from JSON to XML, just add .xml after the resource name in any of the request URLs. . 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.

Authentication and authorisation

...

A machine readable XML based description of the API can be viewed using the following url:

Code Block
http://demo.eveoh.nl$base_url/api/v0?_wadl

Resources

/timetables

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl/$base_url/api/v0/timetables?type=module&access_token=your_token module 

Response Body

Code Block
languagenone
[
    {
    	"description": "VMT for Informatics", 
    	"value": "2011!module!49CBD432F01E8C5057B344E02604A710"
    }
]

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/timetables/2011!module!49CBD432F01E8C5057B344E02604A710?access_token=your_token

Response Body

Code Block
languagenone
[
   {
        "activityDescription": "VMT for Informatics", 
        "activityTypeDescription": "Lecture", 
        "activityTypeName": "Class", 
        "endDate": 1341930600000, 
        "locations": [
            {
                "capacity": 18, 
                "id": "D2D0C6A8E334B242289FBAA7F69759C3", 
                "key": "#SPLUS9759C3", 
                "name": "B3.022"
            }
        ], 
        "moduleCode": "#SPLUS04A710", 
        "notes": null, 
        "staffMembers": [
            "Mr. Moore (Moo)"
        ], 
        "startDate": 1341919800000, 
        "studentSets": [
            "BI group  1A", 
            "BI group  1B"
        ]
    }
]

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl/$base_url/api/v0/timetable?startDate=2012/07/10&endDate=2012/07/10&access_token=your_token

Response Body

Code Block
languagenone
{
        "activityDescription": "System biology", 
        "activityTypeDescription": "Lecture", 
        "activityTypeName": "Class", 
        "endDate": 1341916200000, 
        "locations": [
            {
                "capacity": 24, 
                "id": "D2D0C6A8E334B242289FBAA7F69759BB", 
                "key": "#SPLUS9759BB", 
                "name": "G3.104"
            }, 
            {
                "capacity": 24, 
                "id": "D2D0C6A8E334B242289FBAA7F69759BC", 
                "key": "#SPLUS9759BC", 
                "name": "G3.110"
            }
        ], 
        "moduleCode": "#SPLUS969C58", 
        "notes": null, 
        "staffMembers": [
            "Mr. Martinez (Maz)", 
            "Ms. Adams (Ada)"
        ], 
        "startDate": 1341909000000, 
        "studentSets": [
            "BI group  3A"
        ]
}

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/timetabletypes?access_token=your_token

Response Body

Code Block
languagenone
{
    "timetableType": [
        "location", 
        "zone", 
        "module", 
        "student", 
        "staff", 
        "pos", 
        "posss", 
        "studentset", 
        "studentsetgroup", 
        "modulegroup", 
        "user"
    ]
}

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/timetablefilters?type=pos&access_token=your_token pos 

Response Body

Code Block
languagenone
{
    "filterattribute": [
        {
            "option": [
                {
                    "name": " Faculty of Informatics", 
                    "value": "646ADCA666D4A88402CA46C26A73803C"
                }, 
                {
                    "name": " Faculty of Law", 
                    "value": "646ADCA666D4A88402CA46C26A738046"
                }
            ], 
            "type": "department"
        }
    ]
}

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl/$base_url/api/v0/databases?access_token=your_token

Response Body

Code Block
languagenone
{
    "database": [
        "2011"
    ]
}

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/weeklabels?access_token=your_token

Response Body

Code Block
languagenone
{
     "value": "23", 
     "week": 11223
}

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl/$base_url/api/v0/subscriptions?access_token=your_token

/subscriptions/{key}

Type: POST

...

Request URL 

Code Block
languagenone
http://demo.eveoh.nl/$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6?access_token=your_token

Response code: 204 (No content)

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6?access_token=your_token

Response code: 204 (No content)

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6?state=false&access_token=your_token

Response Code: 204 (No content)

...

Request URL

Code Block
languagenone
http://demo.eveoh.nl$base_url/api/v0/subscriptions/2011!location!D2D0C6A8E334B242289FBAA7F69759C3/2011!module!49CBD432F01E8C5057B344E02604A773?state=false&access_token=your_token

Response Code: 204 (No content)