Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

End point:

https://gps.freetrack.com.ua/api/

...

  • distance - отримання пройденої дистанції девайсом

Приклади використання

*червоні параметри є обов'язковими

Один/кілька девайсів з однаковими датами

Параметр

Приклад

Опис

auth_token

{ ваш токен авторизації }

FreeTrack token або bearer token

POST/GET параметр або Bearer Authentication

api_type

reports

тип запиту

api_name

distance

метод, який викликаємо

id

777,555

id

девайсу

об'єкту (через кому, якщо потрібно передати кілька)

dateFrom

1689022800

дата початку відліку timestamp UTC +0

dateTo

1689454799

дата кінця відліку timestamp UTC +0

Кілька девайсів з різними датами

Параметр

Приклад

Опис

auth_token

{ ваш токен авторизації }

POST/GET параметр або Bearer Authentication

api_type

reports

тип запиту

api_name

distance

метод, який викликаємо

devices

[{

"id": 777,

"dateFrom": 1689022800,

"dateTo": 1689454799

},

{"id": 888,

"dateFrom": 1690837200,

"dateTo": 1692056800

}

]

дані про девайси у форматі JSON

Приклади відповіді

Один девайс

Code Block
languagejson
{
    "result": "ok",
    "response": [
        {
            "deviceID": 777,
            "dateFrom": 1689022800,
            "dateTo": 1689454799,
            "distance": 465.95
        }
    ]
}

Кілька девайсів з однаковими датами

Code Block
languagejson
{
    "result": "ok",
    "response": [
        {
            "deviceID": 777,
            "dateFrom": 1689022800,
            "dateTo": 1689454799,
            "distance": 465.95
        },
        {
            "deviceID": 888,
            "dateFrom": 1689022800,
            "dateTo": 1689454799,
            "distance": 69.47
        }
    ]
}

Кілька девайсів з різними датами

Code Block
languagejson
{
    "result": "ok",
    "response": [
        {
            "deviceID": 777,
            "dateFrom": 1689022800,
            "dateTo": 1689454799,
            "distance": 723.8
        },
        {
            "deviceID": 888,
            "dateFrom": 1690837200,
            "dateTo": 1692056800,
            "distance": 296.01
        }
    ]
}

Опис відповіді

Параметр

Опис

deviceID

id об'єкту

dateFrom

дата початку відліку timestamp UTC +0

dateTo

дата кінця відліку timestamp UTC +0

distance

дистанція, пройдемо об'єктом в часових межах

Типи можливих помилок

Помилка

Поясненя

[id] parameter is missing

не перданий параметр [id]

[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

неправильно складений JSON документ зі списком девайсів