OSR:API/V2/Opvragen informatie over dienst: verschil tussen versies

Versie van 15 jul 2021 13:55

Inleiding

Men kan informatie over diensten en dienstversies opvragen met behulp van deze functionaliteit.

Opvragen informatie over een dienst

Onderstaande request is het basisrequest om alle diensten op te vragen.

GET

 /services

Het is mogelijk om te zoeken naar een (deel van de) dienstnaam, onderstaande geeft een voorbeeld weer van het gebruik van deze parameter.

/api/v2/services?name=bron

Parameters	Omschrijving	Verplicht/Optioneel
Name	(Deel van de) Naam van de dienst.	Optioneel

Responsecodes

Route	Code	Melding
services/	200	Dienst object (gevuld bij resultaat of leeg bij geen matches)

Response

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"
      }
    }
  }
]

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.

@@ Regel 6: / Regel 6: @@
 Onderstaande request is het basisrequest om alle diensten op te vragen.
+<table><tr>
-GET Request<br>
+<td><span style="color:white;font-weight:bold;background-color:#61affe;padding:6px 15px">GET</span></td>
-<syntaxhighlight lang="json">
+<td><syntaxhighlight lang="json" style="display:inline";> /services</syntaxhighlight></td>
+</tr></table>
-/api/v2/services
-</syntaxhighlight>
 Het is mogelijk om te zoeken naar een (deel van de) dienstnaam, onderstaande geeft een voorbeeld weer van het gebruik van deze parameter.<br>