Geozonų sąrašo API

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:

ParametrasTipasAprašymasPrivalomas
api_keyTekstasVartotojo identifikacijos raktasTaip
versionSveikasis skaičiusAPI versijaTaip
limitSveikasis skaičiusApriboja geozonų skaičių atsakymeNe
continuation_tokenSveikasis 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

ParametrasTipasAprašymas
continuation_tokenSveikasis skaičiusTęstinumo simbolis gaunamas, kai užklausiamas didelis įrašų kiekis ilgam laikotarpiui, kai viršijamas nustatytas įrašų limitas
itemsMasyvasTalpina visas vartotojo geozonas
idTekstasIšorinės geozonos ID
nameTekstasGeozonos pavadinimas
notesTekstasGeozonos pastabos
typeEnumGeozonos tipas. Yra du tipai: taškinis ir poligonas
circleMasyvasTalpina taškinio tipo informaciją. Jei pasirinktas poligono tipas, šis parametras bus NULL
latitudeSkaičiustaškinio centro platuma
longitudeSkaičiustaškinio centro ilguma
radiusSkaičiusSkersmuo metrais