OSR:API/V2/Valideren mandaat: verschil tussen versies
(10 tussenliggende versies door een andere gebruiker niet weergegeven) | |||
Regel 1: | Regel 1: | ||
==Inleiding== |
==Inleiding== |
||
− | Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en |
+ | 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. <br> |
− | Het is mogelijk voor andere partijen om te verifiëren of een |
+ | Het is mogelijk voor andere partijen om te verifiëren of een administratiesysteem gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.<br><br> |
==Valideer mandaat== |
==Valideer mandaat== |
||
Regel 17: | Regel 17: | ||
! style="text-align:left;"| Omschrijving |
! style="text-align:left;"| Omschrijving |
||
! style="text-align:left;"| Verplicht/Optioneel |
! style="text-align:left;"| Verplicht/Optioneel |
||
− | ! |
||
|- |
|- |
||
− | | | |
+ | | | School_oin |
| OIN van de onderwijsinstelling |
| OIN van de onderwijsinstelling |
||
| | Verplicht |
| | Verplicht |
||
|- |
|- |
||
− | | | Service_version_namespace |
+ | | | Service_version_namespace * |
− | | Namespace van de dienst |
+ | | Namespace van de dienst |
| | Verplicht |
| | Verplicht |
||
|- |
|- |
||
| | Supplier_oin |
| | Supplier_oin |
||
− | | OIN van de leverancier |
+ | | OIN van de leverancier, behorende bij het administratiesysteem |
| | Verplicht |
| | Verplicht |
||
|- |
|- |
||
Regel 36: | Regel 35: | ||
|} |
|} |
||
− | <nowiki>*</nowiki> Om de verschillende versies van een dienst te kunnen onderscheiden wordt de namespace van de dienst gebruikt als |
+ | <nowiki>*</nowiki> Om de verschillende versies van een dienst te kunnen onderscheiden wordt de namespace van de dienst gebruikt als uniek 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== |
||
− | + | De volgende response kan terug worden gegeven: |
|
<syntaxhighlight lang="json"> |
<syntaxhighlight lang="json"> |
||
Regel 49: | Regel 49: | ||
</syntaxhighlight> |
</syntaxhighlight> |
||
− | of 404 Mandate not found, indien er geen mandaat is |
+ | of 404 Mandate not found, indien er geen mandaat is gevonden voor de combinatie van opgegeven parameters. |
Regel 80: | Regel 80: | ||
Deze service is beschikbaar voor iedereen.<br> |
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> |
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 |
+ | Zie meer informatie over de API op https://osr.kennisnet.nl/api/v2/documentation<br> |
⚫ | |||
− | {| cellspacing="5" cellpadding="0" style="margin:0em 0em 1em 0em; border:1px solid #1DA0E7; background:#fffdc4;width:100%" |
||
+ | |||
⚫ | |||
+ | [[Category:OSR]] |
||
− | |} |
Versie van 15 jun 2020 13:49
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
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
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
De 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 gevonden voor de combinatie van opgegeven parameters.
Response codes
Route | Code | Melding |
---|---|---|
mandates | 200 | mandate object |
mandates | 400 | some error in query params |
mandates | 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