Kontaktynaurady.cz API

Zde naleznete návod k použití API, včetně výrazů pro hledání a formátu odpovědí.

O API

Zdrojem informací pro API je Seznam držitelů datových schránek z Portálu veřejné zprávy.

Api vzniklo během hackathonu RHoK Prague 2012 na základě nápadu od Jakuba Mráčka a Míšy Rybičkové za Open Society Fund respektive otevrenadata.cz

Všechny data jako CSV

Pres API lze ziskat aktuální seznam všech úřadů jako CSV soubor (oddělený středníky) :

/api/v1/organizations/csv

Formát dotazu

Dotaz na API se provádí HTTP GET dotazem s parametry, pomocí kterých se vyhledávají organizace.

Je možné / nutné určit 1-n parametrů pro hledání. Tyto parametry se skládají pomocí logického operátoru AND. Možné parametry a jejich významy jsou popsány v sekci Popis atributů

Je možné používat zástupný znak * pro 0-n libovolných znaků.

Příklady:

/api/v1/organizations?name=*Praha*   Nalezne organizace s názvem začínajícím slovem "Praha" (např. Praha 1, Praha 2, ..)

/api/v1/organizations?code=BRECLAV   Nalezne všechny orgány státní správy s názvem začínajícím slovem "Praha"

Poznámka: parametry URL requestů je potřeba escapovat viz Percent encoding


Formát odpovědi

Data odpovědi API jsou ve formátu JSON. Atributy datových objektů jsou popsány v sekci Popis atributů

Výsledkem dotazu je pole s 0-N organizacemi.


Popis atributů / Field explanation

Field Name Description
name Název organizace
addressStreet Adresa organizace - ulice a číslo popisné
addressCity Adresa organizace - město
addressZipCode Adresa organizace - PSČ
eRegistry e-podatelna
organizationId
taxId DIČ
bankAccount Bankovní spojení
code Kód organizace
type Typ instituce
www Adresa webové prezentace
email E-mail
phone Telefon
officeHours Úřední hodiny
dataBoxId Identifikátor datové schránky
radiusAroundLatitude Zeměpisná šířka (latitude) bodu, okolo kterého chceme hledat daný úřad. Např. 49.0815275.
radiusAroundLongitude Zeměpisná šířka (longitude) bodu, okolo kterého chceme hledat daný úřad. Např. např. 12.022
radius Poloměr kruhu v metrech, kolem souřadnic vyjádřených radiusAroundLatitude respektive radiusAroundLongitude. Úřady se omezí jen na ty, které polohou spadají do této kružnice.

Příklady použití / Examples

Mashup with map

JSFiddle sample