OSR:2019/Opvragen onderwijsinstelling: verschil tussen versies
< OSR:2019
Naar navigatie springen
Naar zoeken springen
| Regel 16: | Regel 16: | ||
! style="text-align:left;"| Parameters |
! style="text-align:left;"| Parameters |
||
! style="text-align:left;"| Omschrijving |
! style="text-align:left;"| Omschrijving |
||
| − | ! style="text-align:left;"| Verplicht/ |
+ | ! style="text-align:left;"| Verplicht/Optioneel |
! |
! |
||
|- |
|- |
||
| | Name |
| | Name |
||
| Naam van de onderwijsinstelling. |
| Naam van de onderwijsinstelling. |
||
| − | | | |
+ | | | Optioneel |
| |
| |
||
|- |
|- |
||
| − | | | |
+ | | | oin |
| + | | Oin van de onderwijsinstelling |
||
| − | | A |
||
| + | | | Optioneel |
||
| − | | | Het Traffic Center is niet beschikbaar. Er vinden op dit moment onderhoudswerkzaamheden plaats. |
||
|- |
|- |
||
| − | | | |
+ | | | brin |
| + | | Brin van de onderwijsinstelling |
||
| − | | E |
||
| + | | | Optioneel |
||
| − | | | Indien het Traffic Center binnen 30 seconden geen response teruggeeft, moet de initiator een time-out (fout) afhandelen (en melden aan eindgebruiker). |
||
| + | |- |
||
| + | | | oa_id |
||
| + | | Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO |
||
| + | | | Optioneel |
||
|- |
|- |
||
|} |
|} |
||
Versie van 30 jan 2019 13:36
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 | |
|---|---|---|---|
| Name | Naam van de onderwijsinstelling. | Optioneel | |
| oin | Oin van de onderwijsinstelling | Optioneel | |
| brin | Brin van de onderwijsinstelling | Optioneel | |
| oa_id | Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO | Optioneel |