OSR:2019/Opvragen endpoints

Uit Kennisnet Developers Documentatie
< OSR:2019
Versie door Bindadin01 (overleg | bijdragen) op 20 mrt 2019 om 15:37 (Response)
Ga naar: navigatie, zoeken

Inleiding

Het endpoint bevat de url waarmee de leverancier namens de onderwijsinstelling communiceert.
Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een onderwijsinstelling
Het opvragen van endpoints zal worden gelimiteerd om te voorkomen dat partijen het OSR volledig uitlezen.


Opvragen endpoint

Onderstaande is een voorbeeld van het request:

/api/v1/endpoints?service_version_namespace=http://xml.eld.nl/schemas/VVA/20181101&school_oin=0000000700004HR00000


Parameters Omschrijving Verplicht/Optioneel
administration_id of school_oin Dit is om specifiek een administratiekenmerk te bevragen of alle endpoints behorende bij een school_oin* Verplicht
service_version_namespace Namespace van de dienst Verplicht
attributes Hier kan gezocht worden op specifieke attributen.

Dit zal in eerste instantie nog niet veel gebruikt worden, maar kan later gebruikt worden om bijvoorbeeld te zoeken op type LAS/RIS etc...

Optioneel
Reference_date Datumveld om een endpoint welke bijvoorbeeld in de toekomst is ingesteld op te vragen. Optioneel

* De response is leeg of bevat 1 endpoint indien administration_id is opgegeven

Response

Het volgende response kan terug worden gegeven (onderstaand voorbeeld is voor school_oin):

[ 
      { 
      "attributes": "endpoint1", 
      "administration_id": "0000000700004HR7778D", 
      "url": "https://magister-schoolmaster.nl/vroegtijdig-aanmelden-mbo/123a132", 
      "start_date": "2017-12-18", 
      "end_date": "2019-12-18", 
      "_links":       { 
         "self": {"href": "/api/v1/endpoints/9"}, 
         "school": {"href": "/api/v1/schools/10"}, 
         "service": {"href": "/api/v1/services/1"}, 
         "service-version": {"href": "/api/v1/service-versions/4"} 
      } 
   }, 
      { 
      "attributes": "endpoint2", 
      "administration_id": "0000000700004HR7778E", 
      "url": "https://elk.nl/vroegtijdig-aanmelden-mbo/123a132", 
      "start_date": "2018-12-18", 
      "end_date": "2019-12-18", 
      "_links":       { 
         "self": {"href": "/api/v1/endpoints/10"}, 
         "school": {"href": "/api/v1/schools/10"}, 
         "service": {"href": "/api/v1/services/1"}, 
         "service-version": {"href": "/api/v1/service-versions/4"} 
      } 
   } 
]
Parameters Omschrijving
attributes Attributen die zijn ingegeven voor dit endpoint. Veld kan leeg zijn
administration_id Het administratiekenmerk
url De technische locatie van het endpoint
start_date Start datum van het endpoint
end_date Direct link om het endpoint op te kunnen vragen.
_links self Eind datum van het endpoint
_links school Direct link om informatie van de gekoppelde onderwijsinstelling op te vragen
_links service Direct link om informatie van de gekoppelde dienst op te vragen
_links service_version Direct link om informatie van de gekoppelde service version namespace op te vragen

De lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven
De lijst is leeg of bevat 1 of meerdere endpoints indien onderwijsinstelling_oin is opgegeven
De lijst is leeg [], als geen endpoint matcht


Foutcodes

Route Code Melding
endpoints 200 endpoint object of lege array
endpoints 400 some error in query params

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-api-sb.kennisnet.nl/api/v1/doc

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.