OSR:API/V2/Valideren mandaat

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.

Valideer mandaat

Aanroep

API endpoint

GET

/mandates

Voorbeeld

Hieronder is een voorbeeld weergegeven van het request:

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

Parameters	Omschrijving	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

* Om de verschillende versies van een dienst te kunnen onderscheiden wordt de code of namespace van de dienst gebruikt als uniek dienstkenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt.

Response

Voorbeeld

HTTP/1.1 200 OK 
{ 
   "code": 200, 
   "message": "Mandate for system exists and is valid" 
}

Codes

Code	Inhoud response
200	Mandaatobject. Deze response wordt gegeven wanneer de API-gebruiker het systeem is, behorende bij het mandaat.
204	Melding: "Mandate for system exists and is valid". Deze response wordt gegeven wanneer de API-gebruiker niet het systeem is, behorende bij het mandaat.
400	Melding: "There is a problem with the system query parameters".
404	Melding: "Mandate not found".

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

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.kennisnet.nl/api/v2/documentation

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.