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

Uit Kennisnet Developers Documentatie
< OSR:API‎ | V2
Naar navigatie springen Naar zoeken springen
 
(37 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
==Inleiding==
==Inleiding==


Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en leverancier. Het mandaat zelf wordt aangemaakt door de OSR beheerder van de onderwijsinstelling via de grafische beheeromgeving van het OSR. <br>
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. <br>


Het is mogelijk voor andere partijen om te verifiëren of een leverancier 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.
Hieronder is een voorbeeld weergegeven van het request:<br>
 
<syntaxhighlight lang="json">
/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
| | Verplicht
|-
| | Reference_date
| Datumveld om een mandaat welke bv in de toekomst 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 unieke 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.
 
 
Het volgende response kan terug worden gegeven:
 
<syntaxhighlight lang="json">
HTTP/1.1 200 OK
{
  "code": 200,
  "message": "Mandate found"
}
</syntaxhighlight>
 
of 404 Mandate not found, indien er geen mandaat is aangemaakt voor de combinatie supplier_oin, school_oin en service_version_name_space
 
 
Foutcodes
 
{|class="wikitable"
! style="text-align:left;"| Route
! style="text-align:left;"| Code
! style="text-align:left;"| Melding
|-
| | mandates
| | 200
| | mandate object
|-
| | mandates
| | 400
| | some error in query params
|-
| | mandates
| | 404
| | mandate not found
|}


==Eigen mandaat opvragen==
==Eigen mandaat opvragen==
Het is ook mogelijk om het eigen mandaat op te vragen. Het resultaat bevat een mandaat token wat van belang is bij het aanmaken van een endpoint.
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 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?==
Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR:API/V2/Opvragen_mandaat_token|Opvragen mandaat token]]
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-api-sb.kennisnet.nl/api/v1/doc<br>


{| cellspacing="5" cellpadding="0" style="margin:0em 0em 1em 0em; border:1px solid #1DA0E7; background:#fffdc4;width:100%"
[[Category:OSR]]
| ''' 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.
|}

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"