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

Uit Kennisnet Developers Documentatie
< OSR:API‎ | V2
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met 'Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en een leverancier. Het mandaat zelf wordt aangemaakt door de OSR beheerder van de onderwijsinst...')
 
 
(58 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en een leverancier. Het mandaat zelf wordt aangemaakt door de OSR beheerder van de onderwijsinstelling via het zakelijk portaal. <br>
==Inleiding==


Door het aanmaken van een mandaat is het mogelijk voor een leverancier om een endpoint aan te kunnen maken (of wijzigen) in 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>
Daarnaast is het mogelijk voor andere partijen om te verifiëren of een leverancier gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.<br><br>


De opvraging van mandaten kan 2 mogelijke antwoorden teruggeven.<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>
* Voor andere partijen die willen verifiëren of een bepaalde leverancier gemandateerd is, wordt alleen een OK of NOK teruggegeven.<br>
* Voor de leverancier die zijn eigen mandaat opvraagt wordt er detail informatie teruggegeven over het mandaat.<br><br>


Een mandaat heeft altijd een startdatum en mogelijk een einddatum.<br>
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.
Het kan dus zo zijn dat een mandaat in het verleden wel aanwezig was, maar inmiddels al is beëindigd.<br>
Of een mandaat kan in de toekomst ingesteld zijn. Hiervoor is de reference_date parameter bedacht om een mandaat van het verleden of de toekomst op te vragen.  


==Eigen mandaat opvragen==
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.


Hieronder is een voorbeeld weergegeven van de request:<br>
Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR:API/V2/Opvragen_mandaat_token|Opvragen mandaat token]]


<syntaxhighlight lang="json">
[[Category:OSR]]
/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>
 
==Request parameters==
{|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
| BOIN 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.''''<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==
 
Voor de leverancier die zijn eigen mandaat opvraagt kan het volgende response worden teruggegeven:
 
<syntaxhighlight lang="json">
{
  "token": "d4fe5e12-bf0a-48b9-8844-edf58da93056",
  "start_date": "2018-12-18",
  "end_date": null,
  "_links":    {
      "self": {"href": "/api/v1/mandates/1"},
      "school": {"href": "/api/v1/schools/1"},
      "service": {"href": "/api/v1/services/2"}
  }
}
</syntaxhighlight>
 
==Response parameters==
{|class="wikitable"
! style="text-align:left;"| Parameters
! style="text-align:left;"| Omschrijving
!
|-
| | token
| Mandaat token, dit is nodig voor de gemandateerde leverancier om een endpoint aan te kunnen maken
|-
| | start_date
| Startdatum van het mandaat. Dit is de dag van aanmaak van het mandaat of een specifieke datum welke gekozen is door de onderwijsinstelling
|-
| | end_date
| Einddatum van het mandaat. Dit wordt specifiek ingevuld door de onderwijsinstelling
|-
| | _links self
| Directe link om het mandaat op te kunnen vragen. Dit kan alleen worden gebruikt door de leverancier die gemandateerd is
|-
| | _links school
| Directe link naar informatie over de desbetreffende gekoppelde onderwijsinstelling
|-
| | _links service
| Directe link naar informatie over de desbetreffende gekoppelde dienst
|}
 
Voor de leverancier die het mandaat van een andere leverancier opvraagt kan het volgende worden teruggegeven:
 
 
<syntaxhighlight lang="json">
HTTP/1.1 200 OK
{
  "code": 404,
  "message": "Mandate not found"
}
</syntaxhighlight>
 
==Response parameters==
{|class="wikitable"
! style="text-align:left;"| Response
! style="text-align:left;"| Omschrijving
!
|-
| | 200 OK
| 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?==
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-sb.kennisnet.nl/api/v1/doc<br>

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"