OSR:2019/Opvragen onderwijsinstelling: verschil tussen versies
< OSR:2019
Naar navigatie springen
Naar zoeken springen
(De pagina is leeggehaald) |
|||
| (16 tussenliggende versies door dezelfde gebruiker niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
| − | Men kan informatie over onderwijsinstellingen opvragen met behulp van deze operatie. De aanwezige data is afkomstig van DUO Open data / RIO.<br> |
||
| − | Onderstaande request is het basisrequest om alle onderwijsinstellingen op te vragen. |
||
| − | |||
| − | GET Request<br> |
||
| − | |||
| − | <syntaxhighlight lang="json"> |
||
| − | /api/v1/schools |
||
| − | </syntaxhighlight> |
||
| − | |||
| − | <br> |
||
| − | Het is mogelijk om specifiek te zoeken, onderstaande geeft een voorbeeld weer van de verschillende parameters.<br> |
||
| − | Let op, de parameters worden met een ‘AND’ operator gecombineerd.<br> |
||
| − | |||
| − | GET Request<br> |
||
| − | <syntaxhighlight lang="json"> |
||
| − | /api/v1/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125 |
||
| − | </syntaxhighlight> |
||
| − | |||
| − | ==Request parameters== |
||
| − | {|class="wikitable" |
||
| − | ! style="text-align:left;"| Parameters |
||
| − | ! style="text-align:left;"| Omschrijving |
||
| − | ! style="text-align:left;"| 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 |
||
| − | |} |
||
| − | |||
| − | |||
| − | |||
| − | De response kan uit 0, 1 of meerdere onderwijsinstellingen bestaan. Hieronder is een voorbeeld weergegeven van de response: |
||
| − | |||
| − | Response |
||
| − | |||
| − | |||
| − | |||
| − | |||
| − | <syntaxhighlight lang="json"> |
||
| − | [{ |
||
| − | "name": "Hubertus Vakschool", |
||
| − | "oin": "0000000700000EF00000", |
||
| − | "brin": "00EF", |
||
| − | "oa_id": "123A125", |
||
| − | "_links": { |
||
| − | "self": {"href": "/api/v1/schools/3"}, |
||
| − | "board": {"href": "/api/v1/boards/3"} |
||
| − | } |
||
| − | }] |
||
| − | |||
| − | </syntaxhighlight> |
||