End point:
https://gps.freetrack.com.ua/api/
...
Список доступних методів
geozones-SE- вибираємо перше входження пристроїв в множину геозон
Приклади використання
*червоні параметри є обов'язковими
Параметр | Приклад | Опис |
|---|---|---|
auth_token | { ваш токен авторизації } | POST/GET параметр або Bearer Authentication |
api_type | reports | тип запиту |
api_name | geozones-SE | метод, який викликаємо |
Content-Type
data | data=[{"deviceID":" |
11111","geozones":[{" |
geozoneID": |
555,"start":1689593662}]},{"deviceID":" |
22222","geozones":[{"geozoneID": |
666,"start":1689593662},{"geozoneID": |
777,"start":1689593662}]} |
,{"deviceID":"12923",
] | дані для завантаження звіту |
Приклади відповіді
Правильна відповідь
| Code Block |
|---|
{ "result": "ok", "response": { "11111": { "geozones": [ { "geozoneID": |
...
555,
"in": 1694848118,
"out": 1694849633
}
]
},
"22222": {
"geozones": [
{
"geozoneID": 666,
"in": null,
"out": 1700518262
},
{
"geozoneID": 777,
"in": null,
"out": null
}
]
}
}
} |
Неправильна відповідь
| Code Block |
|---|
{
"result": "ok",
"response": {
"12923": {
"geozones": [
{
"geozoneID": -1,
"errorMessage": "Can`t find ['geozoneID'] at the item list"
},
{
"geozoneID": 8807,
"in": null,
"out": null
},
{
"geozoneID": 8806,
"errorMessage": "Wrong Timestamp"
},
{
"geozoneID": 8806,
"errorMessage": "Can`t find ['start'] at the item list"
}
]
},
"134": {
"errorMessage": "User has not permission on the object with ID [134]"
}
}
} |
Опис відповіді
Параметр | Опис |
|---|
deviceID
dateFrom
dateTo
11111 | ID девайсу |
geozones | список геозон, які перевірялись |
geozoneID | ID геозони, яка перевірялась |
in | час в'їзду у форматі timestamp (UTC), цей час може бути менший за той, який ми передали у запиті (якщо авто уже стояло в даній геозоні) |
out | час виїзду у форматі timestamp (UTC) |
Типи можливих помилок
Помилка |
|---|
Пояснення |
|---|
Can`t parse the parameter - [ |
data] |
не |
перeданий параметр [ |
data] |
[dateFrom] parameter is missing
не перданий параметр [dateFrom]
[dateTo] parameter is missing
не перданий параметр [dateTo]
Wrong date! The [dateTo] can't be less than or equal the [dateFrom]
дата початку проміжку не може бути пізніша за дату кінця
Error in device list
"Can`t find ['deviceID'] at the item list | не перeданий ключ [deviceID] |
Can`t find ['geozoneID'] at the item list | не перeданий ключ [geozoneID] |
Wrong Timestamp | дата має бути у форматі timestamp (UTC), не раніше, ніж поточний рік і не пізніше 2000 року |
Can`t find ['start'] at the item list | не переданий ключ [start] |
User has not permission on the object with ID [134] | нема доступу до об'єкту з ID [134] |
Can`t find ['geozones'] at the item list | не переданий ключ [geozones] |