OSR:2019/Opvragen onderwijsinstelling: verschil tussen versies
< OSR:2019
Naar navigatie springen
Naar zoeken springen
Geen bewerkingssamenvatting |
Geen bewerkingssamenvatting |
||
| Regel 9: | Regel 9: | ||
GET Request<br> | GET Request<br> | ||
/api/v1/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125 | /api/v1/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125<br> | ||
==Request parameters== | |||
{|class="wikitable" | |||
! style="text-align:left;"| Parameters | |||
! style="text-align:left;"| Omschrijving | |||
! style="text-align:left;"| Verplicht/optioneel | |||
! | |||
|- | |||
| | True | |||
| N | |||
| | Het Traffic Center is beschikbaar. | |||
| | |||
|- | |||
| | False | |||
| A | |||
| | Het Traffic Center is niet beschikbaar. Er vinden op dit moment onderhoudswerkzaamheden plaats. | |||
|- | |||
| | Timeout | |||
| E | |||
| | Indien het Traffic Center binnen 30 seconden geen response teruggeeft, moet de initiator een time-out (fout) afhandelen (en melden aan eindgebruiker). | |||
|- | |||
|} | |||
[[Categorie:Overstapservice Onderwijs]] | |||
[[Categorie:Book OSO|43]] | |||
Versie van 30 jan 2019 13:34
Men kan informatie over onderwijsinstellingen opvragen met behulp van deze operatie. De aanwezige data is afkomstig van DUO Open data / RIO.
Onderstaande request is het basisrequest om alle onderwijsinstellingen op te vragen.
GET Request
/api/v1/schools
Het is mogelijk om specifiek te zoeken, onderstaande geeft een voorbeeld weer van de verschillende parameters.
Let op, de parameters worden met een ‘AND’ operator gecombineerd.
GET Request
/api/v1/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125
Request parameters
| Parameters | Omschrijving | Verplicht/optioneel | |
|---|---|---|---|
| True | N | Het Traffic Center is beschikbaar. | |
| False | A | Het Traffic Center is niet beschikbaar. Er vinden op dit moment onderhoudswerkzaamheden plaats. | |
| Timeout | E | Indien het Traffic Center binnen 30 seconden geen response teruggeeft, moet de initiator een time-out (fout) afhandelen (en melden aan eindgebruiker). |