/
API-Spezifikation der I14Y

API-Spezifikation der I14Y

Work in Progress

Stammdatenbezug

Für das Beziehen der Codelisten stellt die I14Y Interoperabilitätsplattform den nachfolgenden API Endpunkte zur Verfügung.

API-Spezifikation

Die OpenAPI-Konfiguration ist hier zu finden: https://www.i14y.admin.ch/swagger/v1/swagger.json

Endpunkt

Endpunkt

https://www.i14y.admin.ch/api/CodeLists/{identifier}/exports/{format}/{formatVersion}

Methode

GET

Beschreibung

Export einer Codeliste

weiterführende Informationen

siehe https://github.com/sdmx-twg/sdmx-json/blob/master/structure-message/docs/1-sdmx-json-field-guide.md#codelist

Input Parameter

Name

Erforderlich

Beschreibung

Beispiel

Name

Erforderlich

Beschreibung

Beispiel

annotations

Nein

Zusatzinformationen zur Codeliste

 

format

Ja

Format für den Export

CSV
XLSX
SDMX-ML
SDMX-JSON

formatVersion

Abhängig vom angegebenen format
Swagger: setEmptyValue

Version des Formates für den Export (relevant wenn SDMX-ML)

2.0
2.1

identifier

Ja

ID der Codeliste

CL_NCL1040

Output Parameter

http-Code

Beschreibung

http-Code

Beschreibung

200

Success

Response Body: Download der Codeliste im entsprechenden Format

400

Bad Request

403

Forbidden

404

Not Found

Q&A