OSR:API/V2/Opvragen informatie over dienst

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).