API miest / PSČ

Správa miest a PSČ — získanie, vytvorenie, úprava a odstránenie

Základná URL

https://{tenant}.logzi.com/api/city/

Každá požiadavka vracia JSON odpoveď. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0.

GET /api/city/get

Získanie jedného záznamu mesta / PSČ — podľa identifikátora, PSČ alebo krajiny.

Parametre dotazu

ParameterTypPovinnéPopis
idintJedinečný identifikátor záznamu
zipstringVyhľadávanie podľa PSČ
country_idintFiltrovanie podľa identifikátora krajiny

Príklad požiadavky

GET /api/city/get?zip=1234
X-API-KEY: {vas_api_kluc}
GET /api/city/list

Získanie úplného zoznamu všetkých záznamov miest / PSČ bez filtračných parametrov.

Tento koncový bod neprijíma filtračné parametre — vráti úplný zoznam.

Príklad požiadavky

GET /api/city/list
X-API-KEY: {vas_api_kluc}
POST /api/city/save

Vytvorenie alebo úprava záznamu mesta / PSČ. Pre nový záznam data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový záznam, >0 = úprava
zipstringPSČ
citystringNázov mesta
country_idintIdentifikátor krajiny

Príklad požiadavky

POST /api/city/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "zip": "1234",
    "city": "Budapest",
    "country_id": 1
  }
}
POST /api/city/delete

Odstránenie záznamu mesta / PSČ podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor záznamu, ktorý sa má odstrániť

Príklad požiadavky

POST /api/city/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 10 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!