...
- Visit http://demo.eveoh.nl/oauth/authorize?response_type=code&client_id=test&redirect_uri=http://localhost
- You will be prompted to log in. After logging in the application will request for your permission to access your personal timetable. Click Allow.
- After being redirected the URL will contain ?code=XXXXXX. Copy this code.
Open a Terminal window and enter the following command (replace XXXXXX with your personal code from step 3):
Code Block language none curl -d 'grant_type=authorization_code&client_id=test&client_secret=test&code=XXXXXX&redirect_uri=http://localhost' http://demo.eveoh.nl/oauth/token
- The command will return an access token. This token will allow you to request resources from the API.
Resources
/timetables
Description: Query all timetables with a specified type.
...
Code Block | ||
---|---|---|
| ||
[ { "description": "VMT for Informatics", "value": "2011!module!49CBD432F01E8C5057B344E02604A710" } ] |
/timetables/{key}
Description: Query all timetables corresponding with a specific timetable.
...
Code Block | ||
---|---|---|
| ||
[ { "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" ] } ] |
/timetable
Description: Query all timetables within a specific timerange.
...
Code Block | ||
---|---|---|
| ||
{ "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" ] } |
/timetabletypes
Description: Query all possible timetable types.
...
Code Block | ||
---|---|---|
| ||
{ "timetableType": [ "location", "zone", "module", "student", "staff", "pos", "posss", "studentset", "studentsetgroup", "modulegroup", "user" ] } |
/timetablefilters
Description: Query all filters available for a specific timetable type.
...
Code Block | ||
---|---|---|
| ||
{ "filterattribute": [ { "option": [ { "name": " Faculty of Informatics", "value": "646ADCA666D4A88402CA46C26A73803C" }, { "name": " Faculty of Law", "value": "646ADCA666D4A88402CA46C26A738046" } ], "type": "department" } ] } |
/databases
Description: Query the available databases.
...
Code Block | ||
---|---|---|
| ||
{ "database": [ "2011" ] } |
/weeklabels
Description: Query the weeklabels.
Type: GET
...
Code Block | ||
---|---|---|
| ||
{
"value": "23",
"week": 11223
} |
/subscriptions
Type: DELETE
Description: Delete all subscriptions
Parameters: none
Request URL
Code Block | ||
---|---|---|
| ||
http://demo.eveoh.nl/api/v0/subscriptions?access_token=your_token |
/subscriptions/{key}
Type: POST
Description: Add a new subscription
Parameters
key | the key of the subscription you wish to add |
Request URL
Code Block | ||
---|---|---|
| ||
http://demo.eveoh.nl/api/v0/subscriptions/XXXXXXXXXXXXXXXX?access_token=your_token |
Type: DELETE
Description: Delete a subscription.
Parameters
key | the key of the subscription you wish to delete |
Request URL
Code Block | ||
---|---|---|
| ||
http://demo.eveoh.nl/api/v0/subscriptions/XXXXXXXXXXXXXXXX?access_token=your_token |
Type: PUT
Description: Edit a subscription.
Parameters
key | the key of the subscription you wish to edit |
state | boolean value indicating the state of the subscription |
Request URL
Code Block | ||
---|---|---|
| ||
http://demo.eveoh.nl/api/v0/subscriptions/XXXXXXXXXXXXXXXX?access_token=your_token |
/subscriptions/{parent}/{key}
Type: PUT
Description: Edit a subscription.
Parameters
key | the key of the subscription you wish to edit |
parent | the key of the parent of the subscription |
state | boolean value indicating the state of the subscription |
Request URL
Code Block | ||
---|---|---|
| ||
http://demo.eveoh.nl/api/v0/subscriptions/XXXXXXXXXXXXXXXX?access_token=your_token |