OSR:API/V2/Valideren mandaat: verschil tussen versies

Uit Kennisnet Developers Documentatie
< OSR:API‎ | V2
Naar navigatie springen Naar zoeken springen
Regel 5: Regel 5:
Het is mogelijk voor andere partijen om te verifiëren of een systeem gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.<br><br>
Het is mogelijk voor andere partijen om te verifiëren of een systeem gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.<br><br>


==Valideer mandaat==
Om de verschillende versies binnen een dienst te kunnen onderscheiden worden namespaces gebruikt als kenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt.
===Aanroep===
 
====API endpoint====
 
<table><tr>
<td><span style="color:white;font-weight:bold;background-color:#61affe;padding:6px 15px">GET</span></td>
<td><syntaxhighlight lang="json" style="display:inline";> /mandates</syntaxhighlight></td>
</tr></table>
 
====Voorbeeld====
 
Hieronder is een voorbeeld weergegeven van het request:<br>
 
<syntaxhighlight lang="json">
GET /api/v2/mandates?supplier_oin=00000003272448340204&school_oin=0000000700000AV00000&service_version_namespace=http://xml.eld.nl/schemas/Overstapservice/20180404&reference_date=2019-01-01
 
</syntaxhighlight>
 
{|class="wikitable"
! style="text-align:left;"| Parameters
! style="text-align:left;"| Omschrijving
! style="text-align:left;"| Verplicht/Optioneel
|-
| | School_oin
| OIN van de onderwijsinstelling.
| | Verplicht
|-
| | Service_version_namespace *
| Namespace van de dienst. Wanneer leeggelaten, is een Service_code verplicht.
| | Optioneel
|-
| | Supplier_oin
| OIN van de leverancier, behorende bij het systeem.
| | Verplicht
|-
| | Reference_date
| Datumveld om een mandaat welke op een specifieke datum in de toekomst of het verleden is ingesteld op te vragen.
| | Optioneel
|-
| | Service_code
| Code van de dienst. Wanneer leeggelaten, is een Service_version_namespace verplicht.
| | Optioneel
|}
 
<nowiki>*</nowiki> Om de verschillende versies binnen een dienst te kunnen onderscheiden worden namespaces gebruikt als kenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt.


==Eigen mandaat opvragen==
==Eigen mandaat opvragen==

Versie van 20 jun 2025 14:15

Inleiding

Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en systeem. Het mandaat zelf wordt aangemaakt door de OSR beheerder van de onderwijsinstelling via de grafische beheeromgeving van het OSR.

Het is mogelijk voor andere partijen om te verifiëren of een systeem gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.

Om de verschillende versies binnen een dienst te kunnen onderscheiden worden namespaces gebruikt als kenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt.

Eigen mandaat opvragen

Het is ook mogelijk om als systeem het eigen mandaat of een lijst van mandaten voor een dienst op te vragen. Bij een specifiek mandaat bevat het resultaat een mandaat token, welke benodigd is bij het registreren van een endpoint.

Op de volgende pagina kunt u hier informatie over terugvinden: Opvragen mandaat token

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSR:API/V2/Valideren_mandaat&oldid=13163"