application to help student accessing their timetable
This is a REST API in json format.
All request response formated like this:
{
"status": int,
"data": {} // the format of data is specified for each endpoints below
}Only the data object is specified afterwards.
The type date is a string with a special format: yyyymmddThhmmssZ (ex: 20180912T214850Z, but why? -> this is the format used by the university and its very simple to sort)
GET
Retrieve all the known ressources
data = {
"ressources": [ // sorted by id
{
"id": int,
"name": string
},
]
}GET
Get the metadata on a particular ressource
payload = {
"id": int
}
data = {
"name": string,
"lastUpdate": date
}POST
Propose a name for a particular ressource.
payload = {
"id": int,
"name": string
}GET
- get all the data for this ressource
payload = {
"id": int,
}- get only the updated data
payload = {
"id": int,
"since": date
}In both cases you will receive:
data = {
"items": [ // sorted by date
{
"uid":string // a unique identifier
"dtstart":date, // starting date
"dtend":date, // ending date
"lastmodified":date,
"summary":string, // usually the name of the course
"location":string, // the name of the building and the room number
"groups":[string], // which groups of student (maybe more than 1)
"teachers":[string], // which teacher (maybe more than 1)
}
]
}