Appearance
Ruimtes
INFO
Ontvang een overzicht van ruimtes of pas bestaande ruimtes aan. U heeft een API-key nodig. Nog geen key? Vraag hem aan via support@classie.eu.
GET Rooms
Dit API-endpoint geeft een object terug met daarin alle ruimtes in uw school.
Url:
https://api.classie.eu/2.5/schools/[schoolid]/rooms
Parameters
| naam | type | beschrijving |
|---|---|---|
| Path | ---- | ---- |
| [schoolid] | integer | Het numerieke ID van uw school. We hebben u dit ID toegestuurd samen met de API key. Weet u dit numerieke ID niet? Vraag het ons via support@classie.eu. |
| Header | ---- | ---- |
| Authorization | string | Uw API key, voorafgegaan voor de prefix 'Bearer '. Voorbeeld: 'Bearer P5nZiT6pEbEp2x21dxynozqI1NGRZnBx' |
Response
200 Response
Succesvol resultaat. Het results-object geeft een overzicht van alle ruimtes met hun kenmerken.
javascript
{
"status": "success",
"processing_time": "0.10353207588196s",
"results": [{
"id": 34251,
"name": "Zaal",
"type": "Sport",
"no_exams": true,
"students": 60,
"shorthand": "Zaal"
}, {
"id": 34266,
"name": "M1.01",
"type": "",
"no_exams": false,
"students": 30,
"shorthand": "M1.01"
}, {
"id": 34268,
"name": "M1.02",
"type": "",
"no_exams": true,
"students": 30,
"shorthand": "M1.02"
}]
}
403 Response
De authenticatie is niet gelukt. Mogelijk gebruikt u een niet-kloppende API key (error 16) of is uw API key niet gekoppeld aan de data van uw school (error 41). Neem contact met ons op voor meer informatie.
javascript
{
"status": "error",
"code": 16,
"message": "Invalid authorization token"
}
PATCH Rooms
Dit API-endpoint biedt de mogelijkheid een ruimte aan te passen.
Url:
https://api.classie.eu/2.5/schools/[schoolid]/rooms/[ruimte-id]
Parameters
| naam | type | beschrijving |
|---|---|---|
| Path | ---- | ---- |
| [ruimte-id] | integer | Het numerieke ID van de ruimte die u wil updaten. Het ID vindt u via GET rooms (bovenstaand). |
| [schoolid] | integer | Het numerieke ID van uw school. We hebben u dit ID toegestuurd samen met de API key. Weet u dit numerieke ID niet? Vraag het ons via support@classie.eu. |
| Header | ---- | ---- |
| Authorization | string | Uw API key, voorafgegaan voor de prefix 'Bearer '. Voorbeeld: 'Bearer P5nZiT6pEbEp2x21dxynozqI1NGRZnBx' |
| Bpdy | ---- | ---- |
| Data (JSON) | object | In de body van uw request komt de nieuwe data van de ruimte. Voorbeeld: { "name": "M1.06", "type": "", "no_exams": true, "students": 30, "shorthand": "M1.06" } |
Response
200 Response
Succesvol resultaat. De ruimte is aangepast
javascript
{
"status": "success",
"processing_time": "0.020453929901123s"
}
403 Response
De authenticatie is niet gelukt. Mogelijk gebruikt u een niet-kloppende API key (error 16) of is uw API key niet gekoppeld aan de data van uw school (error 41). Neem contact met ons op voor meer informatie.
javascript
{
"status": "error",
"code": 16,
"message": "Invalid authorization token"
}