OSR:API/V2/Valideren mandaat: verschil tussen versies
Naar navigatie springen
Naar zoeken springen
k |
|||
| (8 tussenliggende versies door een andere gebruiker niet weergegeven) | |||
| Regel 20: | Regel 20: | ||
<syntaxhighlight lang="json"> |
<syntaxhighlight lang="json"> |
||
| − | GET /api/ |
+ | GET /api/v2/mandates?supplier_oin=00000003272448340204&school_oin=0000000700000AV00000&service_version_namespace=http://xml.eld.nl/schemas/Overstapservice/20180404&reference_date=2019-01-01 |
</syntaxhighlight> |
</syntaxhighlight> |
||
| Regel 34: | Regel 34: | ||
|- |
|- |
||
| | Service_version_namespace * |
| | Service_version_namespace * |
||
| − | | Namespace van de dienst. |
+ | | Namespace van de dienst. Wanneer leeggelaten, is een Service_code verplicht. |
| − | | | |
+ | | | Optioneel |
|- |
|- |
||
| | Supplier_oin |
| | Supplier_oin |
||
| − | | OIN van de leverancier, behorende bij het systeem. |
+ | | OIN van de leverancier, behorende bij het systeem. |
| | Verplicht |
| | Verplicht |
||
|- |
|- |
||
| | Reference_date |
| | Reference_date |
||
| Datumveld om een mandaat welke op een specifieke datum in de toekomst of het verleden is ingesteld op te vragen. |
| Datumveld om een mandaat welke op een specifieke datum in de toekomst of het verleden is ingesteld op te vragen. |
||
| + | | | Optioneel |
||
| + | |- |
||
| + | | | Service_code |
||
| + | | Code van de dienst. Wanneer leeggelaten, is een Service_version_namespace verplicht. |
||
| | Optioneel |
| | Optioneel |
||
|} |
|} |
||
| − | <nowiki>*</nowiki> Om de verschillende versies |
+ | <nowiki>*</nowiki> Om de verschillende versies binnen een dienst te kunnen onderscheiden worden namespaces gebruikt als kenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt. |
==Response== |
==Response== |
||
| Regel 56: | Regel 60: | ||
{ |
{ |
||
"code": 200, |
"code": 200, |
||
| − | "message": "Mandate for |
+ | "message": "Mandate for system exists and is valid" |
} |
} |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
| Regel 70: | Regel 74: | ||
|- |
|- |
||
| | 204 |
| | 204 |
||
| − | | | Melding: "Mandate for |
+ | | | Melding: "Mandate for system exists and is valid".<br>Deze response wordt gegeven wanneer de API-gebruiker niet het systeem is, behorende bij het mandaat. |
|- |
|- |
||
| | 400 |
| | 400 |
||
| − | | | Melding: "There is a problem with the |
+ | | | Melding: "There is a problem with the system query parameters". |
|- |
|- |
||
| | 404 |
| | 404 |
||
| Regel 83: | Regel 87: | ||
Bij een specifiek mandaat bevat het resultaat een mandaat token, welke benodigd is bij het registreren van een endpoint. |
Bij een specifiek mandaat bevat het resultaat een mandaat token, welke benodigd is bij het registreren van een endpoint. |
||
| − | Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR: |
+ | Op de volgende pagina kunt u hier informatie over terugvinden: [[OSR:API/V2/Opvragen_mandaat_token|Opvragen mandaat token]] |
==Voor wie?== |
==Voor wie?== |
||
Huidige versie van 21 jun 2023 om 11:09
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.
Valideer mandaat
Aanroep
API endpoint
| GET | /mandates
|
Voorbeeld
Hieronder is een voorbeeld weergegeven van het request:
GET /api/v2/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. Wanneer leeggelaten, is een Service_code verplicht. | Optioneel |
| Supplier_oin | OIN van de leverancier, behorende bij het systeem. | Verplicht |
| Reference_date | Datumveld om een mandaat welke op een specifieke datum in de toekomst of het verleden is ingesteld op te vragen. | Optioneel |
| Service_code | Code van de dienst. Wanneer leeggelaten, is een Service_version_namespace verplicht. | Optioneel |
* Om de verschillende versies binnen een dienst te kunnen onderscheiden worden namespaces gebruikt als kenmerk. De namespace is een unieke URI die voor alle services/operaties gebruikt wordt.
Response
Voorbeeld
HTTP/1.1 200 OK
{
"code": 200,
"message": "Mandate for system exists and is valid"
}
Codes
| Code | Inhoud response |
|---|---|
| 200 | Mandaatobject. Deze response wordt gegeven wanneer de API-gebruiker het systeem is, behorende bij het mandaat. |
| 204 | Melding: "Mandate for system exists and is valid". Deze response wordt gegeven wanneer de API-gebruiker niet het systeem is, behorende bij het mandaat. |
| 400 | Melding: "There is a problem with the system query parameters". |
| 404 | Melding: "Mandate not found". |
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 mandaat token, welke benodigd is bij het registreren 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. |