OSR:2019/Opvragen informatie over onderwijsinstelling: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(21 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 10: Regel 10:
   
 
<syntaxhighlight lang="json">
  
<syntaxhighlight lang="json">
−
/api/v1/schools
 +
/api/v2/schools
 
</syntaxhighlight>
  
</syntaxhighlight>
   
Regel 17: Regel 17:
   
 
<syntaxhighlight lang="json">
  
<syntaxhighlight lang="json">
−
/api/v1/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125
 +
/api/v2/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125
 
</syntaxhighlight>
  
</syntaxhighlight>
   
Regel 24: Regel 24:
 
! style="text-align:left;"| Omschrijving
  
! style="text-align:left;"| Omschrijving
 
! style="text-align:left;"| Verplicht/Optioneel
  
! style="text-align:left;"| Verplicht/Optioneel
−
!
 
 
|-
  
|-
 
| | Name
  
| | Name
Regel 31: Regel 30:
 
|-
  
|-
 
| | oin
  
| | oin
−
| Oin van de onderwijsinstelling
 +
| OIN van de onderwijsinstelling
 
| | Optioneel
  
| | Optioneel
 
|-
  
|-
 
| | brin
  
| | brin
−
| Brin van de onderwijsinstelling
 +
| BRIN4 van de onderwijsinstelling
 
| | Optioneel
  
| | Optioneel
 
|-
  
|-
 
| | oa_id
  
| | oa_id
−
| Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO
 +
| Onderwijs aanbieder id van de onderwijsinstelling (momenteel niet gevuld).
 
| | Optioneel
  
| | Optioneel
 
|}
  
|}
   
   
  +
Responsecodes
⚫
Foutcodes
  
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 71: Regel 70:
 
"oa_id": "123A123",
  
"oa_id": "123A123",
 
"_links": {
  
"_links": {
−
"self": {"href": "/api/v1/schools/1"},
 +
"self": {"href": "/api/v2/schools/1"},
−
"board": {"href": "/api/v1/boards/1"}
 +
"board": {"href": "/api/v2/boards/1"}
 
}
  
}
 
},
  
},
Regel 81: Regel 80:
 
"oa_id": "123A124",
  
"oa_id": "123A124",
 
"_links": {
  
"_links": {
−
"self": {"href": "/api/v1/schools/2"},
 +
"self": {"href": "/api/v2/schools/2"},
−
"board": {"href": "/api/v1/boards/2"}
 +
"board": {"href": "/api/v2/boards/2"}
 
}
  
}
 
}
  
}
Regel 95: Regel 94:
 
! style="text-align:left;"| Parameters
  
! style="text-align:left;"| Parameters
 
! style="text-align:left;"| Omschrijving
  
! style="text-align:left;"| Omschrijving
−
!
 
 
|-
  
|-
 
| | Name
  
| | Name
Regel 101: Regel 99:
 
|-
  
|-
 
| | oin
  
| | oin
−
| Oin van de onderwijsinstelling
 +
| OIN van de onderwijsinstelling
 
|-
  
|-
 
| | brin
  
| | brin
−
| Brin van de onderwijsinstelling
 +
| BRIN4 van de onderwijsinstelling
 
|-
  
|-
 
| | oa_id
  
| | oa_id
−
| Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO
 +
| Onderwijs aanbieder id van de onderwijsinstelling (momenteel niet gevuld).
 
|-
  
|-
 
| | _link self
  
| | _link self
Regel 114: Regel 112:
 
| | _link board
  
| | _link board
 
| Directe link naar informatie van het board van deze onderwijsinstelling. Id is een interne ID van het OSR
  
| Directe link naar informatie van het board van deze onderwijsinstelling. Id is een interne ID van het OSR
  ⚫
|}
  +
  ⚫
Foutcodes
  +
  +
{|class="wikitable"
  +
! style="text-align:left;"| Route
  +
! style="text-align:left;"| Code
  +
! style="text-align:left;"| Melding
  +
|-
  +
| | schools
  +
| | 200
  +
| | Lijst met scholen of lege lijst
 
|}
  
|}
   
Regel 122: Regel 132:
   
 
<syntaxhighlight lang="json">
  
<syntaxhighlight lang="json">
−
/api/v1/boards/3
 +
/api/v2/boards/3
 
</syntaxhighlight>
  
</syntaxhighlight>
   
Regel 132: Regel 142:
 
"name": "GPO-WN",
 
"name": "GPO-WN",
 
"_links": {
 
"_links": {
−
"self": {"href": "/api/v1/boards/1"},
+
"self": {"href": "/api/v2/boards/1"},
 
"schools": [
 
"schools": [
−
{"href": "/api/v1/schools/1"},
+
{"href": "/api/v2/schools/1"},
−
{"href": "/api/v1/schools/16"},
+
{"href": "/api/v2/schools/16"},
−
{"href": "/api/v1/schools/17"}
+
{"href": "/api/v2/schools/17"}
 
]
 
]
 
}
 
}
Regel 146: Regel 156:
 
! style="text-align:left;"| Parameter
  
! style="text-align:left;"| Parameter
 
! style="text-align:left;"| Omschrijving
  
! style="text-align:left;"| Omschrijving
−
!
 
 
|-
  
|-
 
| | number
  
| | number
Regel 158: Regel 167:
 
|-
  
|-
 
| | _links schools
  
| | _links schools
−
| Er kunnen 1 of meerdere scholen onder een bestuur vallen. <br> In dit voorbeeld wordt een array teruggegeven van scholen. Direct link naar informatie over de desbetreffende onderwijsinstelling
 +
| Er kunnen 1 of meerdere scholen onder een bestuur vallen. <br> In dit voorbeeld wordt een lijst teruggegeven van scholen met een direct link naar informatie over de desbetreffende onderwijsinstelling(en).
  +
|}
  +
  +
  +
Foutcodes
  +
  +
{|class="wikitable"
  +
! style="text-align:left;"| Route
  +
! style="text-align:left;"| Code
  +
! style="text-align:left;"| Melding
  +
|-
  +
| | boards/{id}
  +
| | 200
  +
| | board object
  +
|-
  +
| | boards/{id}
  +
| | 404
  +
| | board with {id} does not exist
 
|}
  
|}
   
Regel 164: Regel 190:
 
Deze service is beschikbaar voor iedereen.<br>
  
Deze service is beschikbaar voor iedereen.<br>
 
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken<br>
  
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken<br>
−
Zie meer informatie over de API op https://osr-api-sb.kennisnet.nl/api/v1/doc<br>
 +
Zie meer informatie over de API op https://osr.kennisnet.nl/api/v2/documentation<br>
   
  +
==Over het gebruik van certificaten==
−
==Validaties==
  
   
  ⚫
{{Info|''' Let op:'''<br>Bij nieuw aan te vragen certificaten wordt sterk aangeraden te kiezen voor een PKI-overheidscertificaat.<br>Dit omdat ODOC-certificaten geen onderdeel meer uitmaken van de aankomende Edukoppeling Transactiestandaard versie 1.3.}}
−
Het VO-koppelpunt hanteert de volgende validaties voor binnenkomende berichten.
  
   
  +
[[Category:OSR]]
−
{| cellspacing="5" cellpadding="0" style="margin:0em 0em 1em 0em; border:1px solid #1DA0E7; background:#fffdc4;width:100%"
  
⚫
| ''' Let op:'''<br>Bij nieuw aan te vragen certificaten wordt sterk aangeraden te kiezen voor een PKI-overheidscertificaat.<br>Dit omdat ODOC-certificaten geen onderdeel meer uitmaken van de aankomende Edukoppeling Transactiestandaard versie 1.3.
  
⚫
|}
  

Versie van 15 jun 2020 14:47

Inleiding

Men kan informatie over onderwijsinstellingen opvragen met behulp van deze operatie. De aanwezige data is afkomstig van DUO Open data / RIO.


Opvragen informatie onderwijsinstelling

Onderstaande request is het basisrequest om alle onderwijsinstellingen op te vragen.

GET Request

/api/v2/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.

/api/v2/schools?name=Vakschool&oin=0000000700000EF00000&brin=00EF&oa_id=123A125
Parameters Omschrijving Verplicht/Optioneel
Name Naam van de onderwijsinstelling. Optioneel
oin OIN van de onderwijsinstelling Optioneel
brin BRIN4 van de onderwijsinstelling Optioneel
oa_id Onderwijs aanbieder id van de onderwijsinstelling (momenteel niet gevuld). Optioneel


Responsecodes

Route Code Melding
schools/{id} 200 school object
schools/{id} 404 school with {id} does not exist

Response

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/v2/schools/1"},
         "board": {"href": "/api/v2/boards/1"}
      }
   },
      {
      "name": "Scholengemeenschap voor Voortgezet Vrije Schoolonderwijs",
      "oin": "0000000700000CB00000",
      "brin": "00CB",
      "oa_id": "123A124",
      "_links":       {
         "self": {"href": "/api/v2/schools/2"},
         "board": {"href": "/api/v2/boards/2"}
      }
   }
]

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

Parameters Omschrijving
Name Naam van de onderwijsinstelling.
oin OIN van de onderwijsinstelling
brin BRIN4 van de onderwijsinstelling
oa_id Onderwijs aanbieder id van de onderwijsinstelling (momenteel niet gevuld).
_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

Foutcodes

Route Code Melding
schools 200 Lijst met scholen of lege lijst

Directe link naar board

Informatie over het bestuur kan worden opgevraagd door de direct link naar board te gebruiken:

GET Request 

/api/v2/boards/3

Hieronder is een voorbeeld weergegeven van de response:

{ 
   "number": "41646", 
   "name": "GPO-WN", 
   "_links":    { 
      "self": {"href": "/api/v2/boards/1"}, 
      "schools":       [ 
         {"href": "/api/v2/schools/1"}, 
         {"href": "/api/v2/schools/16"}, 
         {"href": "/api/v2/schools/17"} 
      ] 
   } 
}
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 lijst teruggegeven van scholen met een direct link naar informatie over de desbetreffende onderwijsinstelling(en).


Foutcodes

Route Code Melding
boards/{id} 200 board object
boards/{id} 404 board with {id} does not exist

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.kennisnet.nl/api/v2/documentation

Over het gebruik van certificaten

Info.gif Let op:
Bij nieuw aan te vragen certificaten wordt sterk aangeraden te kiezen voor een PKI-overheidscertificaat.
Dit omdat ODOC-certificaten geen onderdeel meer uitmaken van de aankomende Edukoppeling Transactiestandaard versie 1.3.
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSR:2019/Opvragen_informatie_over_onderwijsinstelling&oldid=10690"