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

Huidige versie van 4 nov 2022 om 15: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.

@@ Regel 4: / Regel 4: @@
 ==Opvragen informatie over een dienst==
+===Aanroep===
-Onderstaande request is het basisrequest om alle diensten op te vragen.
+====API endpoint====
-GET Request<br>
+<table><tr>
+<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>
-/api/v2/services
+</tr></table>
-</syntaxhighlight>
+====Voorbeeld====
 Het is mogelijk om te zoeken naar een (deel van de) dienstnaam, onderstaande geeft een voorbeeld weer van het gebruik van deze parameter.<br>
 <syntaxhighlight lang="json">
-/api/v2/services?name=bron
+/services?name=bron
 </syntaxhighlight>
@@ Regel 24: / Regel 25: @@
 |-
 | | Name
-| (Deel van de) Naam van de dienst.
+| (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:<br>
+<syntaxhighlight lang="json">
+[
+  {
+    "code": "DIENST01",
+    "name": "Eerste voorbeeldienst",
+    "description": "Deze dienst dient ter illustratie",
+    "_links": {
+      "self": {
+        "href": "string"
+      }
+    }
+  }
+]
+</syntaxhighlight>
+====Codes====
-Responsecodes
 {|class="wikitable"
-! style="text-align:left;"| Route
 ! style="text-align:left;"| Code
-! style="text-align:left;"| Melding
+! style="text-align:left;"| Inhoud response
 |-
-| | services/
 | | 200
-| | Dienst object (gevuld bij resultaat of leeg bij geen matches)
+| | Dienst object (gevuld bij resultaat of leeg bij geen matches).
 |}
+==Opvragen informatie over een dienstversie==
+===Aanroep===
+====API endpoint====
+<table><tr>
+<td><span style="color:white;font-weight:bold;background-color:#61affe;padding:6px 15px">GET</span></td>
+<td><syntaxhighlight lang="json" style="display:inline";> /service-versions</syntaxhighlight></td>
+</tr></table>
+Een lijst met dienstversies kan worden opgevraagd aan de hand van de code van de desbetreffende dienst.<br>
 ===Response===
-De response kan uit 0, 1 of meerdere diensten bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
+====Voorbeeld====
+De response kan uit 0, 1 of meerdere dienstversies bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
 <syntaxhighlight lang="json">
 [
   {
-    "code": "DIENST01",
+    "namespace": "http://example.com/v1",
-    "name": "Eerste voorbeeldienst",
+    "status": "active",
-    "description": "Deze dienst dient ter illustratie",
     "_links": {
       "self": {
         "href": "string"
-      }
+      },
+     "service": {
+        "href": "http://example.com"
+      },
     }
   }
 ]
 </syntaxhighlight>
+====Codes====
+{|class="wikitable"
+! style="text-align:left;"| Code
+! style="text-align:left;"| Inhoud response
+|-
+| | 200
+| | Dienstversies object (gevuld bij resultaat of leeg bij geen matches).
+|}
 ==Voor wie?==
 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>
-Zie meer informatie over de API op https://osr-sb.kennisnet.nl/api/v2/documentation<br>
+Zie meer informatie over de API op https://osr.kennisnet.nl/api/v2/documentation<br>
 ==Over het gebruik van certificaten==

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

Huidige versie van 4 nov 2022 om 15:22

Inhoud

Inleiding

Opvragen informatie over een dienst

Aanroep

API endpoint

Voorbeeld

Response

Voorbeeld

Codes

Opvragen informatie over een dienstversie

Aanroep

API endpoint

Response

Voorbeeld

Codes

Voor wie?

Over het gebruik van certificaten

Navigatiemenu

Zoeken