OSR:2019/Opvragen informatie over dienst: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
k (Response)
k (Opvragen informatie over een dienstversie)
Regel 59: Regel 59:
   
 
==Opvragen informatie over een dienstversie==
 
==Opvragen informatie over een dienstversie==
  +
===Aanroep===
Onderstaande request is het basisrequest om alle dienstversies op te vragen.
 
   
  +
====API endpoint====
 
<table><tr>
 
<table><tr>
 
<td><span style="color:white;font-weight:bold;background-color:#61affe;padding:6px 15px">GET</span></td>
 
<td><span style="color:white;font-weight:bold;background-color:#61affe;padding:6px 15px">GET</span></td>
Regel 68: Regel 69:
 
Een lijst met dienstversies kan worden opgevraagd aan de hand van de code van de desbetreffende dienst.<br>
 
Een lijst met dienstversies kan worden opgevraagd aan de hand van de code van de desbetreffende dienst.<br>
   
  +
===Response===
   
  +
====Voorbeeld====
 
Responsecodes
 
 
{|class="wikitable"
 
! style="text-align:left;"| Code
 
! style="text-align:left;"| Melding
 
|-
 
| | 200
 
| | Dienstversies object (gevuld bij resultaat of leeg bij geen matches)
 
|}
 
 
===Response===
 
 
De response kan uit 0, 1 of meerdere dienstversies bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
 
De response kan uit 0, 1 of meerdere dienstversies bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
   
Regel 99: Regel 90:
 
]
 
]
 
</syntaxhighlight>
 
</syntaxhighlight>
  +
  +
====Codes====
  +
{|class="wikitable"
  +
! style="text-align:left;"| Code
  +
! style="text-align:left;"| Melding
  +
|-
  +
| | 200
  +
| | Dienstversies object (gevuld bij resultaat of leeg bij geen matches)
  +
|}
   
 
==Voor wie?==
 
==Voor wie?==

Versie van 15 jul 2021 om 14:29

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.

/api/v2/services?name=bron
Parameters Omschrijving Verplicht/Optioneel
Name (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 Melding
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 Melding
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

Info.gif 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.