OSR:2019/Valideren mandaat: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Response parameters)
(Response parameters)
Regel 52: Regel 52:
   
 
of 404 Mandate not found, indien er geen mandaat is aangemaakt voor de combinatie supplier_oin, school_oin en service_version_name_space
 
of 404 Mandate not found, indien er geen mandaat is aangemaakt voor de combinatie supplier_oin, school_oin en service_version_name_space
 
==Response parameters==
 
{|class="wikitable"
 
! style="text-align:left;"| Response
 
! style="text-align:left;"| Omschrijving
 
!
 
|-
 
| | 200 Mandate found
 
| Confirmatie dat er een mandaat is afgegeven voor de combinatie onderwijsinstelling, dienst versie en leverancier.
 
|-
 
| | 404 mandate not found
 
| Een van de parameters matcht niet met een mandaat
 
|}
 
   
 
==Voor wie?==
 
==Voor wie?==

Versie van 30 jan 2019 om 22:55

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 het zakelijk portaal.

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

Request parameters

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

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-sb.kennisnet.nl/api/v1/doc