OSR:API/V2/Opvragen endpoints: verschil tussen versies
Naar navigatie springen
Naar zoeken springen
Geen bewerkingssamenvatting |
Geen bewerkingssamenvatting |
||
| Regel 20: | Regel 20: | ||
|- | |- | ||
| | administration_id of school_oin | | | administration_id of school_oin | ||
| Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een | | Men kan het endpoint van een specifiek administratiekenmerk opvragen of alle endpoints behorende bij een onderwijsinstelling* | ||
| | Verplicht | | | Verplicht | ||
|- | |- | ||
| | | | | service_version_namespace | ||
| Namespace van de diens | | Namespace van de diens | ||
| | Verplicht | | | Verplicht | ||
| Regel 36: | Regel 36: | ||
| | Optioneel | | | Optioneel | ||
|} | |} | ||
'''* De lijst is leeg of bevat 1 endpoint indien administration_id is opgegeve | |||
Versie van 30 jan 2019 15:34
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 diens | 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 opgegeve