Geozonų sąrašo API yra skirtas pateikti informaciją apie vartotojo geozonas (visos matomos geozonos: sukurtos ir pasidalintos su vartotoju).
Užklausos struktūra:
GET /geozones?api_key=<...>&version=1&limit=<...>&continuation_token=<...> HTTP/1.1
Host: api.fm-track.com
Content-Type: application/json;charset=UTF-8
Užklausos parametrai:
| Parametras | Tipas | Aprašymas | Privalomas |
|---|---|---|---|
| api_key | Tekstas | Vartotojo identifikacijos raktas | Taip |
| version | Sveikasis skaičius | API versija | Taip |
| limit | Sveikasis skaičius | Apriboja geozonų skaičių atsakyme | Ne |
| continuation_token | Sveikasis skaičius | Įterpia tęstinumo simbolį bei rodo sekantį duomenų komplektą, pasiekus praeitą įrašų limitą | Ne |
Atsakymo pavyzdys
{
"continuation_token": 1,
"items": [
{
"id": "d4e18901",
"name": "asdada",
"notes": "aaa fff",
"type": "POINT",
"circle": {
"latitude": 54.689538538142585,
"longitude": 25.270938071441606,
"radius": 250.0
}
},
...
]
}Jei parametras arba API raktas įvestas neteisingai, sistema pateiks klaidos kodą, visi klaidų kodai aprašyti API skyriuje. Parametrai, kuriems duomenys nėra pateikti, nėra įtraukiami į atsakymą. Parametrai aprašyti šio skyriaus pabaigoje.
Atsakymo pavyzdys
| Parametras | Tipas | Aprašymas |
|---|---|---|
| continuation_token | Sveikasis skaičius | Tęstinumo simbolis gaunamas, kai užklausiamas didelis įrašų kiekis ilgam laikotarpiui, kai viršijamas nustatytas įrašų limitas |
| items | Masyvas | Talpina visas vartotojo geozonas |
| id | Tekstas | Išorinės geozonos ID |
| name | Tekstas | Geozonos pavadinimas |
| notes | Tekstas | Geozonos pastabos |
| type | Enum | Geozonos tipas. Yra du tipai: taškinis ir poligonas |
| circle | Masyvas | Talpina taškinio tipo informaciją. Jei pasirinktas poligono tipas, šis parametras bus NULL |
| latitude | Skaičius | taškinio centro platuma |
| longitude | Skaičius | taškinio centro ilguma |
| radius | Skaičius | Skersmuo metrais |