OSR:API/V3/Opvragen mandaat token

Het opvragen van een mandaat token

Let op: Deze functionaliteit vereist authenticatie met behulp van een API key. Meer informatie over het gebruik hiervan staat vermeld in de API documentatie (link op de hoofdpagina).

Aanroep

API endpoint

GET	/mandates/services/{serviceCode}/schools/{oieCode}/suppliers/{supplierOin}

Voorbeeld

GET	/mandates/services/demoservice/schools/00AA/suppliers/00000003272448340204

Response

Voorbeeld

Voor een systeem die zijn eigen mandaat opvraagt kan de volgende response worden verwacht:

{ 
   "startDate": "2018-12-18", 
   "endDate": null, 
   "token": "d4fe5e12-bf0a-48b9-8844-edf58da93056", 
   "_links":    { 
      "self": {"href": "/api/v3/mandates/1"}, 
      "school": {"href": "/api/v3/schools/1"}, 
      "service": {"href": "/api/v3/services/1"} 
      "system": {"href": "/api/v3/systems/1"} 
      "board": {"href": "/api/v3/boards/1"} 
}

Responseveld	Omschrijving
startDate	Startdatum van het mandaat. Dit is de dag van aanmaak van het mandaat of een specifieke datum welke gekozen is door de onderwijsinstelling
endDate	Einddatum van het mandaat. Dit wordt specifiek ingevuld door de onderwijsinstelling
token	Mandaat token, dit is nodig voor de gemandateerde leverancier om een endpoint aan te kunnen maken
_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 onderwijsinstelling
_links service	Directe link naar informatie over de desbetreffende dienst
_links system	Directe link naar informatie over de desbetreffende systeem
_links board	Directe link naar informatie over de desbetreffende onderwijsbestuur

Over het gebruik van certificaten

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 Edukoppeling sinds Transactiestandaard versie 1.3.