OSR:API/V2/Opvragen endpoints
< OSR:API | V2
Naar navigatie springen
Naar zoeken springen
Versie door Bindadin01 (overleg | bijdragen) op 30 jan 2019 om 15:33
De printervriendelijke versie wordt niet langer ondersteund en kan weergavefouten bevatten. Werk uw browserbladwijzers bij en gebruik de gewone afdrukfunctie van de browser.
Onderwijs Serviceregister: API/V2/Opvragen endpoints
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 onderwijsinstellin | Verplicht | |
| service_version_namespac | 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 |