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

Uit Kennisnet Developers Documentatie
< OSR:API‎ | V2
Naar navigatie springen Naar zoeken springen
 
(11 tussenliggende versies door 2 gebruikers niet weergegeven)
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 verschillende versies van 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/v1/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.
| | Verplicht
|-
| | Supplier_oin
| OIN van de leverancier, behorende bij het administratiesysteem.
| | Verplicht
|-
| | Reference_date
| Datumveld om een mandaat welke op een specifieke datum in de toekomst of het verleden is ingesteld op te vragen.
| | Optioneel
|}
 
<nowiki>*</nowiki> Om de verschillende versies van een dienst te kunnen onderscheiden wordt de namespace van de dienst gebruikt als uniek dienstkenmerk.<br>In de WSDL wordt dit meestal aangeduid met de targetnamespace. De namespace is een unieke URI die voor alle services/operaties in de dienst gebruikt worden.
 
==Response==
 
====Voorbeeld====
 
<syntaxhighlight lang="json">
HTTP/1.1 200 OK
{
  "code": 200,
  "message": "Mandate for administration system exists and is valid"
}
</syntaxhighlight>
 
====Codes====
 
{|class="wikitable"
! style="text-align:left;"| Code
! style="text-align:left;"| Inhoud response
|-
| | 200
| | Mandaatobject.<br>Deze response wordt gegeven wanneer de API-gebruiker het administratiesysteem is, behorende bij het mandaat.
|-
| | 204
| | Melding: "Mandate for administration system exists and is valid".<br>Deze response wordt gegeven wanneer de API-gebruiker niet het administratiesysteem is, behorende bij het mandaat.
|-
| | 400
| | Melding: "There is a problem with the administration system query parameters".
|-
| | 404
| | Melding: "Mandate not found".
|}


==Eigen mandaat opvragen==
==Eigen mandaat opvragen==
Het is ook mogelijk om als administratiesysteen het eigen mandaat of een lijst van mandaten voor een dienst op te vragen.  
Het is ook mogelijk om als systeem het eigen mandaat of een lijst van mandaten voor een dienst op te vragen.<br>
Bij een specifiek mandaat bevat het resultaat een mandaat token, welke benodigd is bij het registreren van een endpoint.
Bij een specifiek mandaat bevat het resultaat een mandaattoken, welke benodigd is bij het registreren van een endpoint.
 
Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR:2019/Opvragen_mandaat_token|Opvragen mandaat token]]
 
==Voor wie?==
Deze service is beschikbaar voor iedereen.<br>
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken<br>
Zie meer informatie over de API op https://osr.kennisnet.nl/api/v2/documentation<br>


{{Info|''' Let op:'''<br>Bij nieuw aan te vragen certificaten wordt sterk aangeraden te kiezen voor een PKI-overheidscertificaat.<br>Dit omdat ODOC-certificaten geen onderdeel meer uitmaken van de aankomende Edukoppeling Transactiestandaard versie 1.3.}}
Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR:API/V2/Opvragen_mandaat_token|Opvragen mandaat token]]


[[Category:OSR]]
[[Category:OSR]]

Huidige versie van 20 jun 2025 14:16

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 verschillende versies van 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 mandaattoken, 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=13165"