Technické standardy pro aplikační rozhraní lokálních katalogů

Aby mohl být lokální katalog registrován v NKOD, musí nabízet aplikační rozhraní (API) splňující následující specifikaci. API je webová služba obsahující funkce package_list a package_show ze specifikace CKAN API verze 3. Výstup funkce package_show je rozšířen o dodatečná metadata. Výstupy obou funkcí jsou ve formátu JSON (ECMA-404).

Obě funkce musí být přístupné na adrese lokálního katalogu pod pevně stanovenými URL.

Příklad: lokální katalog běží na adrese http://data.organizace.cz. Funkce package_list je pak přístupná na adrese http://data.organizace.cz/api/3/action/package_list a funkce package_show je pak přístupná na adrese http://data.organizace.cz/api/3/action/package_show?id=datova-sada-1 kde „datova-sada-1“ je ID konkrétní datové sady v lokálním katalogu sestávající z malých písmen bez diakritiky, čísel, podtržítek a pomlček.

Odpověď na volání funkce package_list obsahuje v poli result seznam ID všech datových sad obsažených v katalogu. Tato ID se pak použijí pro volání funkce package_show. Odpověď má tvar:

{
   "success": true, 
   "result": [
      "datova-sada-1", 
      "datova-sada-2", 
      "datova-sada-3"
   ]
}

Odpověď na volání funkce package_show s parametrem id obsahujícím ID datové sady obsahuje mimo jiné kompletní metadata datové sady a všech jejích distribucí. Pole result obsahuje mimo jiné následující parametry:

Navíc pole result obsahuje:

• položku name obsahující ID datové sady použité jako parametr funkce package_show a zobrazené v seznamu vráceném funkcí package_list.

Příklad:

"name": "coi-kontroly"

• Pole klíčových slov, kde každé je reprezenováno objektem o dvou položkách se stejným obsahem name a display_name.

Příklad:

"tags": [{
	"display_name": "kontroly",
	"name": "kontroly"
}],

• Pole obsahující metadata jednotlivých datových zdrojů resources, viz popis distribuce.

V poli resources má každá distribuce (datový zdroj) mimo jiné následující parametry:

Kompletní příklad výstupu funkce package_show