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

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Nieuwe pagina aangemaakt met ' ==Inleiding== Men kan informatie over diensten en dienstversies opvragen met behulp van deze operatie. ==Opvragen informatie over een dienst== Onderstaande reque...')
 
k (Response)
Regel 42: Regel 42:
 
|}
 
|}
  
==Response==
+
===Response===
 
De response kan uit 0, 1 of meerdere diensten bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
 
De response kan uit 0, 1 of meerdere diensten bestaan. Hieronder is een voorbeeld weergegeven van de response:<br>
  
Regel 59: Regel 59:
 
]
 
]
 
</syntaxhighlight>
 
</syntaxhighlight>
 
 
  
 
==Voor wie?==
 
==Voor wie?==

Versie van 23 apr 2020 om 09:43

Inleiding

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


Opvragen informatie over een dienst

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

GET Request

/api/v2/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-sb.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.