OSR:2019/Opvragen endpoints: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Request parameters)
Regel 13: Regel 13:
  
 
==Request parameters==
 
==Request parameters==
 +
{|class="wikitable"
 +
! style="text-align:left;"| Parameters
 +
! style="text-align:left;"| Omschrijving
 +
! style="text-align:left;"| Verplicht/Optioneel
 +
!
 +
|-
 +
| | administration_id of school_oin
 +
| Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een onderwijsinstelling*
 +
| | Verplicht
 +
|-
 +
| | service_version_namespace
 +
| Namespace van de dienst
 +
| | Verplicht
 +
|-
 +
| | attributes
 +
| Hier kan gezocht worden op specifieke attributen.<br>
 +
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 lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven '''<br>
 +
 +
De volgende response kan terug worden gegeven:<br>
 +
 +
<syntaxhighlight lang="json">
 +
 +
      { 
 +
      "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"} 
 +
      } 
 +
   } 
 +
]
 +
</syntaxhighlight>
 +
 +
==Response parameters==
 
{|class="wikitable"
 
{|class="wikitable"
 
! style="text-align:left;"| Parameters
 
! style="text-align:left;"| Parameters
Regel 38: Regel 98:
  
 
'''* De lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven
 
'''* De lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven
 
De volgende response kan terug worden gegeven
 

Versie van 30 jan 2019 om 15:40

Het endpoint bevat de url waarmee de leverancier namens de onderwijsinstelling communiceert.
Elke partij die een PKI-overheidscertificaat heeft kan endpoints opvragen.
 

Het opvragen van endpoints zal worden gelimiteerd om te voorkomen dat partijen het OSR volledig uitlezen.

Onderstaande is een voorbeeld GET endpoint request:


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


Request parameters

Parameters Omschrijving Verplicht/Optioneel
administration_id of school_oin Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een onderwijsinstelling* 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 lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven

De volgende response kan terug worden gegeven:

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

Response parameters

Parameters Omschrijving Verplicht/Optioneel
administration_id of school_oin Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een onderwijsinstelling* 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 lijst is leeg of bevat 1 endpoint indien administration_id is opgegeven