OSR:API/V2/Valideren mandaat: verschil tussen versies
k (→Response) |
|||
| Regel 50: | Regel 50: | ||
==Response== |
==Response== |
||
| + | ====Voorbeeld==== |
||
| − | De volgende response kan terug worden gegeven: |
||
<syntaxhighlight lang="json"> |
<syntaxhighlight lang="json"> |
||
| Regel 60: | Regel 60: | ||
</syntaxhighlight> |
</syntaxhighlight> |
||
| + | ====Codes==== |
||
| − | of 404 Mandate not found, indien er geen mandaat is gevonden voor de combinatie van opgegeven parameters. |
||
| − | |||
| − | |||
| − | Response codes |
||
{|class="wikitable" |
{|class="wikitable" |
||
| Regel 70: | Regel 67: | ||
! style="text-align:left;"| Melding |
! style="text-align:left;"| Melding |
||
|- |
|- |
||
| − | | | mandates |
||
| | 200 |
| | 200 |
||
| | mandate object |
| | mandate object |
||
|- |
|- |
||
| − | | | mandates |
||
| | 400 |
| | 400 |
||
| | some error in query params |
| | some error in query params |
||
|- |
|- |
||
| − | | | mandates |
||
| | 404 |
| | 404 |
||
| | mandate not found |
| | mandate not found |
||
Versie van 15 jul 2021 14:32
Inleiding
Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en administratiesysteem. 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 administratiesysteem 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 | Verplicht |
| Supplier_oin | OIN van de leverancier, behorende bij het administratiesysteem | 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 uniek 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.
Response
Voorbeeld
HTTP/1.1 200 OK
{
"code": 200,
"message": "Mandate found"
}
Codes
| Route | Code | Melding |
|---|---|---|
| 200 | mandate object | |
| 400 | some error in query params | |
| 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.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. |