Verwendung der CKAN API

CKAN- API
- Vorbedingungen für die Verwendung des API
Weg, um die aktuellste Version einer Ressourcezu finden

CKAN- API

“CKAN ist die führende Softwarelösung, mit der Open Data Portale aufgebaut werden können. CKAN unterstützt die Verwaltung bei der Zentralisierung der Open Data Aktivitäten. Katalogisierung, Versionierung, Speicherung und Protokollierung der veröffentlichten Daten.”

Vorbedingungen für die Verwendung des API

Sie sollten wissen, wie JSON zu lesen ist.
Sie sollten die Grundprinzipien von REST-APIs verstanden haben.
Sie verfügen über einen API-Schüssel aus dem Developer Dashboard.

Weg, um die aktuellste Version einer Ressourcezu finden

Wir verwenden als Beispiel ‘timetable-2016-hrdf’ (Periodenfahrplan) Mit der Abfrage ‘package_list’ (siehe unten) können Sie auch die anderen möglichen Datensätze nachschlagen.

Sie müssen den Umweg über die Schritte 3 und 4 machen, weil bei jedem Harvesting die Ressource-IDs wechseln. Jede Ressource hat dabei immer eine eindeutige Ressource-ID.

Ablauf:

Verwenden Sie das CKAN-API
Finden Sie den Slug des Datasets (hier ‘timetable-2016-hrdf’) oder generell nachschlagen mit https://api.opentransportdata.swiss/ckan-api/package_list
Inhalt des Data-Sets auslesen https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf
Innerhalb der resources suchen. Es muss der aktuellste Periodic Timetable geladen werden. Die Aktualität lässt sich am Datum feststellen (YYYY-MM-DD) im “url”-Feld.

{
   "license_title":"Andere (Offen)",
   "resources":[
      //…Other ressource
      {
         "byte_size":13851261,
         "coverage":"Coverage",
         // lot of attributes
         "title":"{\"fr\": \"Periodic timetable 2016 (HDRF)\", \"de\": \"Periodic timetable 2016 (HDRF)\", \"en\": \"Periodic timetable 2016 (HDRF)\", \"it\": \"Periodic timetable 2016 (HDRF)\"}",
         // lots of attributes
         "url":"https://opentransportdata.swiss/dataset/9f0babdc-0bdb-4400-b6fa-fd6d1f11cd5d/resource/e521f5d9-7f42-446f-9746-29ba2c26dfd8/download/fp20162016-09-24.zip",
         // lots of things
//
}

{

"license_title":"Andere (Offen)",

"resources":[

//…Other ressource

{

"byte_size":13851261,

"coverage":"Coverage",

// lot of attributes

"title":"{\"fr\": \"Periodic timetable 2016 (HDRF)\", \"de\": \"Periodic timetable 2016 (HDRF)\", \"en\": \"Periodic timetable 2016 (HDRF)\", \"it\": \"Periodic timetable 2016 (HDRF)\"}",

// lots of attributes

"url":"https://opentransportdata.swiss/dataset/9f0babdc-0bdb-4400-b6fa-fd6d1f11cd5d/resource/e521f5d9-7f42-446f-9746-29ba2c26dfd8/download/fp20162016-09-24.zip",

// lots of things

}

Mit der URL (‘url’) können sie die Datei herunterladen
Beachten Sie, dass immer ab ca. November der nächste Periodenfahrplan bereitsteht (der Jahresfahrplan schon früher). Andere Datensätze wie Didok bleiben und sind unabhängig vom Fahrplanjahr.

Wichtig zu wissen

Das CKAN-API nicht für sehr starke Belastung ausgelegt: D.h. verwenden sie das CKAN-API nicht als Datawarehouse, sondern für gelegentliche Abfragen und automatisches Identifizieren der Resourcen für den Download.

Andere Metadaten

Über https://api.opentransportdata.swiss/ckan-api/package_show?id=timetable-2016-hrdf erhalten Sie auch alle anderen relevanten Metadaten der Daten.

Im Element resources sind auch die relevanten Angaben zu einer einzelnen Ressource aufgeführt.

Zugriff auf einzelne Datenelemente

Der Zugriff in einzelne Felder wird anhand des Didok-Pseudoservices beschrieben.

Weiterführende Angaben