|
|
| (6 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>
| |
|
| |
| 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><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:<br>
| |
|
| |
| <syntaxhighlight lang="json">
| |
| [
| |
| {
| |
| "name": "GBS De Morgenster",
| |
| "oin": "0000000700000AV00000",
| |
| "brin": "00AV",
| |
| "oa_id": "123A123",
| |
| "_links": {
| |
| "self": {"href": "/api/v1/schools/1"},
| |
| "board": {"href": "/api/v1/boards/1"}
| |
| }
| |
| },
| |
| {
| |
| "name": "Scholengemeenschap voor Voortgezet Vrije Schoolonderwijs",
| |
| "oin": "0000000700000CB00000",
| |
| "brin": "00CB",
| |
| "oa_id": "123A124",
| |
| "_links": {
| |
| "self": {"href": "/api/v1/schools/2"},
| |
| "board": {"href": "/api/v1/boards/2"}
| |
| }
| |
| }
| |
| ]
| |
|
| |
| </syntaxhighlight>
| |
|
| |
|
| |
| ==Response parameters==
| |
| {|class="wikitable"
| |
| ! style="text-align:left;"| Parameters
| |
| ! style="text-align:left;"| Omschrijving
| |
| !
| |
| |-
| |
| | | Name
| |
| | Naam van de onderwijsinstelling.
| |
| |-
| |
| | | oin
| |
| | Oin van de onderwijsinstelling
| |
| |-
| |
| | | brin
| |
| | Brin van de onderwijsinstelling
| |
| |-
| |
| | | oa_id
| |
| | Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO
| |
| |-
| |
| | | _link self
| |
| | Directe link naar informatie van deze onderwijsinstelling. Id is een interne ID van het OSR
| |
| |-
| |
| | | _link board
| |
| | Directe link naar informatie van het board van deze onderwijsinstelling. Id is een interne ID van het OSR
| |
| |}
| |
|
| |
|
| |
| ==Directe link naar board==
| |
| Informatie over het bestuur kan worden opgevraagd door de direct link naar board te gebruiken:
| |
|
| |
| <syntaxhighlight lang="json">
| |
| /api/v1/boards/3
| |
| </syntaxhighlight>
| |