End point:
...
geozones-SE
- вибираємо перше входження пристроїв в множину геозон
Приклади використання
*червоні параметри є обов'язковими
Параметр | Приклад | Опис |
---|---|---|
auth_token | { ваш токен авторизації } | POST/GET параметр або Bearer Authentication |
api_type | reports | тип запиту |
api_name | geozones-SE | метод, який викликаємо |
data | data=[{"deviceID":"11111","geozones":[{"geozoneID":555,"start":1689593662}]},{"deviceID":"22222","geozones":[{"geozoneID":666,"start":1689593662},{"geozoneID":777,"start":1689593662}]}] | дані для завантаження звіту |
...
Приклад правильної відповіді
Code Block |
---|
...
| |
| |
{ "result": "ok", "response": { "11111": { "geozones": [ { "geozoneID": 555, "start": 123456789, "in": 1694848118, "out": 1694849633 } ] }, "22222": { "geozones": [ { "geozoneID": 666, "start": 987654321, "in": null, "out": 1700518262 }, { "geozoneID": 777, "start": 123454321, "in": null, "out": null } ] } } } |
Неправильна відповідь
Code Block |
---|
Опис відповіді
Параметр | Опис |
---|---|
11111, 22222, 33333 | ID пристрою |
geozones | список геозон, які перевірялись |
geozoneID | ID геозони, яка перевірялась |
start | час від якого почали вести пошук входження в геозону у форматі timestamp (UTC) |
in | час в'їзду у форматі timestamp (UTC), цей час може бути менший за той, який ми передали у запиті (якщо авто уже стояло в даній геозоні), може бути null, якщо авто ні разу не в'їжджало геозону |
out | час виїзду у форматі timestamp (UTC), може бути null, якщо авто ні разу не виїжджало геозону |
Приклад неправильної відповіді
Code Block | ||
---|---|---|
| ||
{ "result": "ok", "response": { "1292311111": { "geozones": [ { "geozoneID": -1, "errorMessage": "Can`t find ['geozoneID'] at the item list" }, { "geozoneID": 8807555, "inerrorMessage": null, "out": null"Wrong Timestamp" }, { "geozoneID": 8806666, "errorMessage": "WrongCan`t Timestamp" find ['start'] at the item list" }, } { ] }, "geozoneID33333": 8806,{ "errorMessage": "User has not permission on the object "errorMessage": "Can`t find ['start'] at the item list"with ID [134]" }, "22222": { } "errorMessage": "Can`t find ['geozones'] at the item list" }, "134-1": { "errorMessage": "UserCan`t has not permission onfind ['deviceID'] at the object with ID [134]item list" } } } |
Опис відповіді
...
Параметр
...
Опис
...
11111
...
ID девайсу
...
geozones
...
список геозон, які перевірялись
...
geozoneID
...
ID геозони, яка перевірялась
...
in
...
час в'їзду у форматі timestamp (UTC), цей час може бути менший за той, який ми передали у запиті (якщо авто уже стояло в даній геозоні)
...
out
...
Типи можливих помилок
Помилка | Пояснення | ||
---|---|---|---|
Can`t parse the parameter - [data] | не перeданий параметр [data] | ||
"Can`t find ['deviceID'] at the item list | не перeданий ключ [deviceID], “-1” замість ID пристрою у відповіді | ||
User has not permission on the object with ID [33333] | нема доступу до об'єкту з ID [33333] | ||
Can`t find ['geozoneIDgeozones'] at the item list | неперeданийпереданий ключ [geozoneID] | Wrong Timestamp | дата має бути у форматі timestamp (UTC), не раніше, ніж поточний рік і не пізніше 2000 рокуgeozones] |
Can`t find ['startgeozoneID'] at the item list | непереданийперeданий ключ [startgeozoneID] | ||
User has not permission on the object with ID [134] | нема доступу до об'єкту з ID [134] | ||
Can`t find ['geozonesstart'] at the item list | не переданий ключ [geozones]start] | ||
Wrong Timestamp | неправильний формат дати: дата має бути у форматі timestamp (UTC), не раніше, ніж поточний рік і не пізніше 2000 року |