Rozdíly
Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze | ||
nastroj:ckan-api [2018/06/18 07:58] – Jakub Klímek | nastroj:ckan-api [2021/03/23 18:09] (aktuální) – odstraněno Jakub Klímek | ||
---|---|---|---|
Řádek 1: | Řádek 1: | ||
- | ====== 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 [[http:// | ||
- | |||
- | 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 https:// | ||
- | |||
- | ===== package_list ===== | ||
- | 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: | ||
- | < | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ] | ||
- | }</ | ||
- | ===== package_show ===== | ||
- | |||
- | Odpověď na volání funkce **package_show** s parametrem id obsahujícím ID datové sady obsahuje mimo jiné [[cinnost: | ||
- | |||
- | |||
- | ^Název pole ^Název položky ^Datový typ ^Povinnost ^Příklad hodnoty ^ | ||
- | | title | Název datové sady | Řetězec | Ano | Kontroly | | ||
- | | notes | Popis datové sady | Řetězec | Ano | Seznam kontrol od 1.1.2012 | | ||
- | | frequency | Periodicita aktualizace | Řetězec dle [[https:// | ||
- | | ruian_type | Související geografické území - typ prvku RÚIAN | Typ prvku RÚIAN | Ano | ST | | ||
- | | ruian_code | Související geografické území - kód prvku RÚIAN | Řetězec | Ano | 1 | | ||
- | | theme | Klasifikace dle EuroVoc |Seznam URL oddělený mezerou |Ne|http:// | ||
- | | maintainer_email | Email Kurátora dat | E-mail | Ne | verejnadata@INSTITUCE.cz | | ||
- | | maintainer | Jméno Kurátora dat | Řetězec | Ne | Jan Novák | | ||
- | | schema |Odkaz na dokumentaci datové sady |URL | Ne| https:// | ||
- | | tags | Klíčová slova| pole objektů |Ano| viz níže | | ||
- | | temporal_start | Dotčené časové období od |datum ve formátu xsd:date | Ne | 2012-01-01 | | ||
- | | temporal_end | Dotčené časové období do | datum ve formátu xsd:date | Ne | 2014-12-31 | | ||
- | | publisher_uri | URL poskytovatele dat | URL | Ano | https:// | ||
- | | publisher_name | Název poskytovatele dat | Řetězec | Ano | INSTITUCE | | ||
- | | resources | Datové zdroje | pole objektů | Ano | viz níže | | ||
- | |||
- | 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: | ||
- | < | ||
- | * 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: | ||
- | < | ||
- | " | ||
- | " | ||
- | }],</ | ||
- | * Pole obsahující metadata jednotlivých datových zdrojů **resources**, | ||
- | |||
- | V poli resources má každá distribuce (datový zdroj) mimo jiné následující parametry: | ||
- | |||
- | |||
- | ^ Název pole ^Název položky ^Datový typ ^Povinnost ^Příklad hodnoty ^ | ||
- | | url | Odkaz na stažení datového zdroje | URL | Ano | https:// | ||
- | | format | Formát datového zdroje | [[https:// | ||
- | | license_link | Odkaz na podmínky užití | URL | Ano | [[https:// | ||
- | | name | Název datového zdroje | Řetězec | Ne | Kontroly | | ||
- | | describedBy | Odkaz na strojově čitelné schéma datového zdroje | URL | Ne | https:// | ||
- | | describedByType | Formát schématu datového zdroje | [[https:// | ||
- | | temporal_start | Dotčené časové období od | datum ve formátu xsd:date | Ne | 2015-01-01 | | ||
- | | temporal_end | Dotčené časové období do | datum ve formátu xsd:date | Ne | 2015-12-31 | | ||
- | |||
- | {{: | ||
- | |||
- | <WRAP center round info 60%> | ||
- | Dle standardu DCAT jsou podmínky užití vlastností datového zdroje, jelikož každý datový zdroj může mít podmínky jiné. Položku **license_link** lze uvést i v poli datové sady **result**, pak se interpretuje jako že jsou podmínky užití stejné pro všechny datové zdroje. | ||
- | </ | ||
- | |||
- | ==== Příklady existujících rozhraní ==== | ||
- | Zde uvádíme příklady existujících rozhraní pro harvestaci NKOD. Upozorňujeme ale, že [[statistika: | ||
- | * Český statistický úřad: [[http:// | ||
- | * [[https:// | ||
- | * [[http:// | ||