| Table of Contents |
|---|
...
Input can be provided in the form of HTTP GET URL parameters 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 should be specified in the following format (which is totally inconsistent with the rest of our API, we will fix this in the next version): YYYY/MM/DD HH:MM. The time part is optional and will be regarded as 0:00 if not specified.
Authentication and authorisation
...
Example response body
| 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" ] } ] |
/timetablefilters
Method: GET
...
| Name | Description | Default value |
type (required) | the The type of the timetabletimetables to retrieve the filters for. | - |
departmentFilter | Filter results on a specific department. | - |
departmentGroupFilter | Filter results on a specific department group. | - |
zoneFilter | Filter results on a specific zone. | - |
...
Description: Add a new subscription
Parameters
| Name | Description | Default value |
key (required) | the The key of the timetable you wish to add. | - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6 |
...
Description: Delete a subscription.
Parameters
| Name | Description | Default value |
key (required) | the The key of the subscription you wish to delete. | - |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6 |
...
Description: Edit a subscription. Use boolean values to trigger the subscription on or off.
Parameters
| Name | Description | Default value |
key (required) | the The key of the subscription you wish to edit. | - |
state | boolean Boolean value indicating the state of the subscription. | false |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/subscriptions/2011!pos!0F2C927DF37F3A2BEF1F1713768E4EE6 |
...
Description: Edit a subscription nested under a parent. Use boolean values to trigger the subscription on or off.
Parameters
| Name | Description | Default value |
key (required) | the The key of the subscription you wish to edit. | - |
parent (required) | the The key of the parent of the subscription. | - |
state | boolean Boolean value indicating the state of the subscription. | false |
Example request URL
| Code Block | ||
|---|---|---|
| ||
$base_url/api/v0/subscriptions/2011!location!D2D0C6A8E334B242289FBAA7F69759C3/2011!module!49CBD432F01E8C5057B344E02604A773 |
...