OSR:API/V2/Opvragen informatie over dienst: verschil tussen versies
k (→Voorbeeld) |
k (→Voorbeeld) |
||
| (4 tussenliggende versies door dezelfde gebruiker niet weergegeven) | |||
| Regel 16: | Regel 16: | ||
<syntaxhighlight lang="json"> |
<syntaxhighlight lang="json"> |
||
| − | + | /services?name=bron |
|
</syntaxhighlight> |
</syntaxhighlight> |
||
| Regel 52: | Regel 52: | ||
{|class="wikitable" |
{|class="wikitable" |
||
! style="text-align:left;"| Code |
! style="text-align:left;"| Code |
||
| − | ! style="text-align:left;"| |
+ | ! style="text-align:left;"| Inhoud response |
|- |
|- |
||
| | 200 |
| | 200 |
||
| − | | | Dienst object (gevuld bij resultaat of leeg bij geen matches) |
+ | | | Dienst object (gevuld bij resultaat of leeg bij geen matches). |
|} |
|} |
||
| Regel 94: | Regel 94: | ||
{|class="wikitable" |
{|class="wikitable" |
||
! style="text-align:left;"| Code |
! style="text-align:left;"| Code |
||
| − | ! style="text-align:left;"| |
+ | ! style="text-align:left;"| Inhoud response |
|- |
|- |
||
| | 200 |
| | 200 |
||
| − | | | Dienstversies object (gevuld bij resultaat of leeg bij geen matches) |
+ | | | Dienstversies object (gevuld bij resultaat of leeg bij geen matches). |
|} |
|} |
||
Huidige versie van 4 nov 2022 om 14:22
Inleiding
Men kan informatie over diensten en dienstversies opvragen met behulp van deze functionaliteit.
Opvragen informatie over een dienst
Aanroep
API endpoint
| GET | /services
|
Voorbeeld
Het is mogelijk om te zoeken naar een (deel van de) dienstnaam, onderstaande geeft een voorbeeld weer van het gebruik van deze parameter.
/services?name=bron
| Parameters | Omschrijving | Verplicht/Optioneel |
|---|---|---|
| Name | (Een deel van de) Naam van de dienst. | Optioneel |
Response
Voorbeeld
De response kan uit 0, 1 of meerdere diensten bestaan. Hieronder is een voorbeeld weergegeven van de response:
[
{
"code": "DIENST01",
"name": "Eerste voorbeeldienst",
"description": "Deze dienst dient ter illustratie",
"_links": {
"self": {
"href": "string"
}
}
}
]
Codes
| Code | Inhoud response |
|---|---|
| 200 | Dienst object (gevuld bij resultaat of leeg bij geen matches). |
Opvragen informatie over een dienstversie
Aanroep
API endpoint
| GET | /service-versions
|
Een lijst met dienstversies kan worden opgevraagd aan de hand van de code van de desbetreffende dienst.
Response
Voorbeeld
De response kan uit 0, 1 of meerdere dienstversies bestaan. Hieronder is een voorbeeld weergegeven van de response:
[
{
"namespace": "http://example.com/v1",
"status": "active",
"_links": {
"self": {
"href": "string"
},
"service": {
"href": "http://example.com"
},
}
}
]
Codes
| Code | Inhoud response |
|---|---|
| 200 | Dienstversies object (gevuld bij resultaat of leeg bij geen matches). |
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
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 de aankomende Edukoppeling Transactiestandaard versie 1.3. |