API за списък на геозоните е предназначен за извеждане на информация за геозоните на потребителя (всички видими геозони: създадени от потребителя и споделени с него).
Структура на заявката:
GET /geozones?api_key=&version=1&limit=&continuation_token=<...><...><...> HTTP/1.1
Домакин: api.fm-track.com
Content-Type: application/json;charset=UTF-8
Параметри на заявката:
| Parameter | Type | Description | Required |
|---|---|---|---|
| api_key | String | User identification key | Yes |
| version | Integer | API version | Yes |
| limit | Integer | Limits geozones count in response | No |
| continuation_token | Integer | Displays from what date and time the data is shown if the record limit was reached | No |
Пример за отговор:
{
"continuation_token": 1,
"items": [
{
"id": "d4e18901",
"name": "asdada",
"notes": "aaa fff",
"type": "POINT",
"circle": {
"latitude": 54.689538538142585,
"longitude": 25.270938071441606,
"radius": 250.0
}
},
...
]
}Ако даден параметър е въведен неправилно, системата ще отговори с код за грешка. Всички кодове за грешки са описани в раздела API. Параметри, за които не са предоставени данни, не се включват в отговора. Пълен списък на параметрите на отговора е наличен в края на този раздел.
Параметри на отговора:
| Parameter | Type | Description |
|---|---|---|
| continuation_token | Integer | Continuation token is sent when number of geozones in response exceed limit |
| items | Array | Container for all user geozones |
| id | String | External geozone ID |
| name | String | Geozone name |
| notes | String | Geozone notes |
| type | Enum | Geozone type. There are two types: point and polygon |
| circle | Array | Container for point information. If it is a polygon type, this parameter will be NULL |
| latitude | Double | Latitude of point center |
| longitude | Double | Longitude of point center |
| radius | Double | Radius in meters |