Geozones list API is dedicated to output information about the user’s geozones (all visible geozones: created by the user and shared with the user).
Request structure:
GET /geozones?api_key=<...>&version=1&limit=<...>&continuation_token=<...> HTTP/1.1
Host: api.fm-track.com
Content-Type: application/json;charset=UTF-8
Request parameters:
| 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 |
Response example:
{
"continuation_token": 1,
"items": [
{
"id": "d4e18901",
"name": "asdada",
"notes": "aaa fff",
"type": "POINT",
"circle": {
"latitude": 54.689538538142585,
"longitude": 25.270938071441606,
"radius": 250.0
}
},
...
]
}If a parameter was entered incorrectly, the system will respond with an error code. All error codes are described in the APIs section. Parameters for which no data is provided are not included in the response. A full list of response parameters is available at the end of this section.
Response parameters:
| 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 |