OSR:2019/Valideren mandaat: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Valideer mandaat)
(Valideer mandaat)
Regel 59: Regel 59:
 
! style="text-align:left;"| Melding
 
! style="text-align:left;"| Melding
 
|-
 
|-
| | mandates/{id}
+
| | mandates}
 
| | 200
 
| | 200
 
| | mandate object
 
| | mandate object
 
|-
 
|-
| | schools/{id}
+
| | mandates}
 
| | 400
 
| | 400
 
| | some error in query params
 
| | some error in query params
 
|-
 
|-
| | schools/{id}
+
| | mandates}
 
| | 404
 
| | 404
 
| | mandate not found
 
| | mandate not found

Versie van 20 mrt 2019 om 15:32

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.

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

Valideer mandaat

Hieronder is een voorbeeld weergegeven van het request:

/api/v1/mandates?supplier_oin=00000003272448340204&school_oin=0000000700000AV00000&service_version_namespace=http://xml.eld.nl/schemas/Overstapservice/20180404&reference_date=2019-01-01
Parameters Omschrijving 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

* Om de verschillende versies van een dienst te kunnen onderscheiden wordt de namespace van de dienst gebruikt als unieke dienstkenmerk.
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:

HTTP/1.1 200 OK 
{ 
   "code": 200, 
   "message": "Mandate found" 
}

of 404 Mandate not found, indien er geen mandaat is aangemaakt voor de combinatie supplier_oin, school_oin en service_version_name_space


Foutcodes

Route Code Melding
mandates} 200 mandate object
mandates} 400 some error in query params
mandates} 404 mandate not found

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.

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

Voor wie?

Deze service is beschikbaar voor iedereen.
Voor TLS verbindingen (minimaal TLS 1.2) moet een aanvragende partij een geldige PKI overheidscertifcaat/ODOC certificaat gebruiken
Zie meer informatie over de API op https://osr-api-sb.kennisnet.nl/api/v1/doc

Let op:
Bij nieuw aan te vragen certificaten wordt sterk aangeraden te kiezen voor een PKI-overheidscertificaat.
Dit omdat ODOC-certificaten geen onderdeel meer uitmaken van de aankomende Edukoppeling Transactiestandaard versie 1.3.