OSR:2019/Opvragen onderwijsinstelling: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Geen bewerkingssamenvatting
Regel 50: Regel 50:


<syntaxhighlight lang="json">
<syntaxhighlight lang="json">
[{  
[
  "name": "Hubertus Vakschool",  
      {
  "oin": "0000000700000EF00000",  
      "name": "GBS De Morgenster",
  "brin": "00EF",  
      "oin": "0000000700000AV00000",
  "oa_id": "123A125",  
      "brin": "00AV",
  "_links":    {  
      "oa_id": "123A123",
       "self": {"href": "/api/v1/schools/3"},  
      "_links":       {
      "board": {"href": "/api/v1/boards/3"}  
        "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>
</syntaxhighlight>

Versie van 30 jan 2019 14:09

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:    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"}
      }
   }]