OSR:2019/Opvragen informatie over onderwijsinstelling

Uit Kennisnet Developers Documentatie
< OSR:2019
Versie door Bindadin01 (overleg | bijdragen) op 30 jan 2019 om 22:56 (Opvragen informatie onderwijsinstellingen)
Ga naar: navigatie, zoeken

Onderwijs Serviceregister-symbol.png Onderwijs Serviceregister: 2019/Opvragen informatie over onderwijsinstelling

Inleiding

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


De response kan uit 0, 1 of meerdere onderwijsinstellingen bestaan. Hieronder is een voorbeeld weergegeven van de response:

[
      {
      "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"}
      }
   }
]

De Lijst kan leeg zijn als er geen match is gevonden. HTTP/1.1 200 OK wordt geretourneerd

Response parameters

Parameters 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:

GET Request

/api/v1/boards/3

Hieronder is een voorbeeld weergegeven van de response:

{ 
   "number": "41646", 
   "name": "GPO-WN", 
   "_links":    { 
      "self": {"href": "/api/v1/boards/1"}, 
      "schools":       [ 
         {"href": "/api/v1/schools/1"}, 
         {"href": "/api/v1/schools/16"}, 
         {"href": "/api/v1/schools/17"} 
      ] 
   } 
}

Response parameters

Parameter Omschrijving
number Bestuursnummer
name Naam van het bestuur
_links self Directe link naar informatie over het bestuur. Id is een intern ID van het OSR
_links schools Er kunnen 1 of meerdere scholen onder een bestuur vallen.
In dit voorbeeld wordt een array teruggegeven van scholen. Direct link naar informatie over de desbetreffende onderwijsinstelling

Voor wie?

Deze service is beschikbaar voor iedereen.
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken
Zie meer informatie over de API op https://osr-sb.kennisnet.nl/api/v1/doc