End point:
...
Список доступних методів
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","geozones":[{"geozoneID":8807,"start":1689593662},{"geozoneID":8806,"start": -4}, {"geozoneID":8806,"start1": -4}]}]
Приклади відповіді
...
] | дані для завантаження звіту |
Приклад правильної відповіді
Code Block | ||
---|---|---|
| ||
{ "result": "ok", "response": { "11111": { "geozones": [ { "geozoneID": 555, "start": 123456789, "in": 1694848118, "out": 1694849633 } ] }, "22222": { "geozones": [ { "geozoneID": 666, "start": 987654321, "12923in": { null, "geozonesout": [ 1700518262 }, { "geozoneID": -1777, "errorMessagestart": 123454321, "Can`t find ['geozoneID'] at the item list" "in": null, "out": null }, } ] } } } |
Опис відповіді
Параметр | Опис |
---|---|
11111, 22222, 33333 | ID пристрою |
geozones | список геозон, які перевірялись |
geozoneID | ID геозони, яка перевірялась |
start | час від якого почали вести пошук входження в геозону у форматі timestamp (UTC) |
in | час в'їзду у форматі timestamp (UTC), цей час може бути менший за той, який ми передали у запиті (якщо авто уже стояло в даній геозоні), може бути null, якщо авто ні разу не в'їжджало геозону |
out | час виїзду у форматі timestamp (UTC), може бути null, якщо авто ні разу не виїжджало геозону |
Приклад неправильної відповіді
Code Block | ||
---|---|---|
| ||
{ "result": "ok", "response": { "geozoneID": 8807,11111": { "geozones": [ { "ingeozoneID": null-1, "outerrorMessage": null "Can`t find ['geozoneID'] at the item list" }, { "geozoneID": 8806555, "errorMessage": "Wrong Timestamp" }, { "geozoneID": 8806666, "errorMessage": "Can`t find ['start'] at the item list" } ] }, "13433333": { "errorMessage": "User has not permission on the object with ID [134]" }, "22222": { "errorMessage": "Can`t find ['geozones'] at the item list" }, } |
Опис відповіді
...
Параметр
...
Опис
...
deviceID
...
dateFrom
...
dateTo
...
distance
"-1": {
"errorMessage": "Can`t find ['deviceID'] at the item list"
}
}
} |
Типи можливих помилок
Помилка |
---|
Пояснення |
---|
Can`t parse the parameter - [ |
data] |
не |
перeданий параметр [ |
data] |
Can`t find [ |
не перданий параметр [dateFrom]
[dateTo] parameter is missing
не перданий параметр [dateTo]
Wrong date! The [dateTo] can't be less than or equal the [dateFrom]
дата початку проміжку не може бути пізніша за дату кінця
Error in device list
'deviceID'] at the item list | не перeданий ключ [deviceID], “-1” замість ID пристрою у відповіді |
User has not permission on the object with ID [33333] | нема доступу до об'єкту з ID [33333] |
Can`t find ['geozones'] at the item list | не переданий ключ [geozones] |
Can`t find ['geozoneID'] at the item list | не перeданий ключ [geozoneID] |
Can`t find ['start'] at the item list | не переданий ключ [start] |
Wrong Timestamp | неправильний формат дати: дата має бути у форматі timestamp (UTC), не раніше, ніж поточний рік і не пізніше 2000 року |