Dokumentace API pro vývojáře
Jednoduchý dotaz (GET)
Odešlete GET požadavek s parametry lat a long ve formátu WGS 84:
GET http://tools.jasnapaka.com/mestske-obvody-plzen/service.php?lat=49.738065&long=13.382195&format=json
| Parametr | Typ | Popis |
lat | float | Zeměpisná šířka (povinný) |
long | float | Zeměpisná délka (povinný) |
format | string | xml (výchozí) nebo json |
Dávkový dotaz (POST)
Odešlete POST požadavek s JSON polem souřadnic v těle:
[
{ "lat": 49.738065, "long": 13.382195 },
{ "lat": 49.777222, "long": 13.376033 }
]
Odpověď je pole výsledků ve stejném pořadí jako vstup. Každá položka obsahuje buď úspěšný výsledek, nebo chybový objekt.
Odpovědi
Úspěch (HTTP 200) — JSON:
{
"code": "umo3",
"umo": "Plzeň 3",
"part": "U zimního stadionu"
}
Úspěch (HTTP 200) — XML:
<area>
<code>umo3</code>
<umo>Plzeň 3</umo>
<part>U zimního stadionu</part>
</area>
| Pole | Typ | Popis |
code | string | Kód obvodu (umo1 – umo10) |
umo | string | Název městského obvodu (např. "Plzeň 3", "Plzeň 5 - Křimice") |
part | string | Název urbanistického obvodu / části obce |
Chybové odpovědi
Chyba — JSON:
{
"code": 3,
"msg": "Na základě vstupních parametrů 'lat' a 'long' nebyl nalezen žádný městský obvod."
}
Chyba — XML:
<error>
<code>3</code>
<msg>Na základě vstupních parametrů...</msg>
</error>
| Kód | HTTP | Význam |
1 | 500 | Služba je vypnuta |
2 | 500 | Parametry lat a long musí být reálná čísla |
3 | 404 | Pro dané souřadnice nebyl nalezen žádný městský obvod |
4 | 500 | Interní chyba — databáze není dostupná |
5 | 500 | V POST payloadu nebyl nalezen platný JSON |
Příklady volání
curl "http://tools.jasnapaka.com/mestske-obvody-plzen/service.php?lat=49.738065&long=13.382195&format=json"
curl "http://tools.jasnapaka.com/mestske-obvody-plzen/service.php?lat=49.738065&long=13.382195"
curl -X POST -H "Content-Type: application/json" \
-d '[{"lat":49.738065,"long":13.382195},{"lat":49.777222,"long":13.376033}]' \
"http://tools.jasnapaka.com/mestske-obvody-plzen/service.php?format=json"