Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 158.1 >

edited by Андрей Калиновский
on 2024/07/19 15:49

To version < 153.1 >

edited by Михаил Жучков
on 2024/04/11 08:08

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.Gadmin
++XWiki.SupportZhuchkov

Content

@@ -1209,58 +1209,6 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--
--== **Получить ответ на отправленную на ТС команду** ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
--)))
--
--Идентификатор команды: cmdid
--
--Запрос от терминала на ответ команды
--
--Пример ответ от терминала:
--
--ID= "" ~/~/ идентификатор произвольного поля
--Soft="" ~/~/ версия софта
--GPS=4 ~/~/ тип трекера
--Time=11:05:43 28.06.24 ~/~/ время запроса
--Lat=45.056221 ~/~/ широта
--Lon=39.035938 ~/~/ долгота
--Speed=0.0 ~/~/ скорость
--Course=181.4 ~/~/направление
--
--(((
--== **Список отправленных объекту команд с ответами** ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
--)))
--
--Идентификатор ТС: vehicleId
--
--В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
--
--Пример ответа терминала
--
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
--"commandText": "",   ~/~/Текст команды.
--"templateId": "",    ~/~/Идентификатор шаблона
--"updated": "",  ~/~/ Время отправки
--"tryCount": 0,  ~/~/ Количество попыток отправки команды
--"answer": "",    ~/~/ Ответ терминала.
--"status": "" ~/~/ Статус отправки
--}
--]
--
--
--)))
--
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
  (% class="box successmessage" %)
@@ -1604,24 +1604,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)  }
--(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
--**Отправить команду на терминал**
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
--)))
--
--Команда для отправки на тс.
--
--{
--"id": "",  ~/~/идентификатор произвольного поля
--"command": "", ~/~/  Текст команды
--"retries": "",  ~/~/ Количество попыток
--"idTemplate": "" ~/~/ ID шаблона команды
--}
--
--
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -2231,42 +2231,74 @@
  Тело запроса:
  {
++
    "vehicleIds": [ ], ~/~/ Список ID объектов
++
    "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
++
    "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
++
    "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++
  }
  Ответ:
--[
++[
++
    {
++
      "vehicleId": 0, ~/~/ ID объекта
++
      "vehicleName": "string", ~/~/ Имя объекта
++
      "moves": [      ~/~/ Событие движения
++
        {
++
          "mileage": 0, ~/~/ Пробег, км
++
          "eventId": 0, ~/~/ Идентификатор события
++
          "eventName": "string", ~/~/ Название события
++
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
          "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
          "duration": 0 ~/~/ Продолжительность события, секунд
++
        }
++
      ],
++
      "stops": [       ~/~/ События стоянок
++
        {
++
          "address": "string", ~/~/ Адрес события
++
          "eventId": 0, ~/~/ Идентификатор события
++
          "eventName": "string", ~/~/ Название события
++
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++
          "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++
          "duration": 0 ~/~/ Продолжительность события, секунд
++
++
        }
++
      ]
++
    }
++
  ]
++
  == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
  (% class="box infomessage" %)
@@ -4090,299 +4090,67 @@
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
--Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
  (% class="box infomessage" %)
  (((
--POST /api/v3/fuelcards/transactions
++**POST**/api/v3/fuelcards/transactions
  )))
--Метод запроса: POST
++Запрос должен содержать параметры:
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
--\\В заголовках запроса: X-Auth: Токен авторизации
--
--Параметры в теле запроса (JSON):
--
  {
--  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
--  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
--  "ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
--  ],
--  "timezone": 0 ~/~/Таймзона
--}
++  "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
--Ответ:
--  {
--    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
--    "driver": "string", ~/~/Водители, привязанные к ТК
--    "object": "string", ~/~/Наименование ТС
--    "amount": 0, ~/~/Количество топлива
--    "amountDut": 0, ~/~/Количество по ДУТ
--    "amountDiff": 0, ~/~/Разница, л
--    "amountDiffPerc": 0, ~/~/Разница, %
--    "summa": 0, ~/~/Стоимость, руб
--    "serviceName": "string", ~/~/Тип топлива
--    "price": 0, ~/~/Цена за литр, руб
--    "cardName": "string", ~/~/Наименование ТК
--    "cardNum": "string", ~/~/Номер ТК
--    "operator": "string", ~/~/Оператор ТК
--    "address": "string" ~/~/Адрес АЗС
--  }
++  "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
++  "ids": [
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
++  ],
--== **Получение полных данных о ретрансляторе** ==
++  "timezone": 0, ~/~/ Часовой пояс
--(% class="box infomessage" %)
--(((
--**GET ** **/api/v3/retranslations/{id}**
--)))
++  "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
--Идентификатор запроса: ID
--
--
--Пример ответа:
--
--{
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ Идентификатор объекта ретрансляции
--"name": "",   ~/~/ Наименование объекта ретрансляции
--"imei": "",     ~/~/ IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
  }
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/Guid родителя
--"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
--}
--
--== **Удаление данных ретранслятора** ==
--
--(% class="box infomessage" %)
--(((
--**DELETE** **/api/v3/retranslations/{id}**
--)))
--
--Параметр запроса: ID
--
--
--== **Создание ретранслятора** ==
--
--(% class="box infomessage" %)
--(((
--**POST ** **/api/v3/retranslations/{id}**
--)))
--
--Запрос:
--
--{
--"description": "",  ~/~/ Описание
--"subscriberId": "",  ~/~/ Подписчик
--"protocolType": 0,  ~/~/ Тип протокола
--"address": "",  ~/~/ Адрес ретрансляции
--"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",     ~/~/IMEI объекта
--"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ]
--}
--
--
  Ответ:
--{
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,   ~/~/ Тип протокола
--"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "",  ~/~/ Адрес события
--"objects": [    ~/~/Объекты для ретрансляции
--{
--"id": "",     ~/~/ идентификатор пользователя
--"name": "string",     ~/~/ Название уведомления
--"imei": "string",    ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
--}
++  {
++    "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
--== **Редактирование ретранслятора** ==
++    " driver ": "string", ~/~/ Имя водителя
--(% class="box infomessage" %)
--(((
--**PUT** **/api/v3/retranslations**
--)))
++    "amount": 0, ~/~/ Количество топлива
--Пример запроса:
++    "amountDut": 0, ~/~/ Количество топлива по ДУТ
--{
--"id": "",  ~/~/ идентификатор пользователя
--"description": "string",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",   ~/~/ Адрес события
--"objects":  ~/~/Объекты для ретрансляции
--[
--{
--"id": "",  ~/~/ идентификатор пользователя
--"imei": "",       ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ]
--}
++    "amountDiff": 0, ~/~/ Разница в литрах
++    "amountDiffPerc": 0, ~/~/ Разница в %
--Пример ответа:
++    "summa": 0, ~/~/  Стоимость в руб.
--{
--"description": "",  ~/~/ Определяет описание
--"subscriberId": "",  ~/~/ идентификатор запроса
--"protocolType": 0,  ~/~/ Тип протокола
--"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",  ~/~/ Адрес события
--"objects": [     ~/~/Объекты для ретрансляции
--{
--"id": "",    ~/~/ идентификатор пользователя
--"name": "string",  ~/~/ Название уведомления
--"imei": "",      ~/~/IMEI объекта
--"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
--}
--  ],
--"id": "",  ~/~/ идентификатор пользователя
--"parentId": "",  ~/~/ Guid идентификатор родителя
--"deleted": true ~/~/ Признак удаления
--}
++    "serviceName": "string", ~/~/ Тип топлива
++    "price": 0, ~/~/ Цена за литр в руб.
--== **Получение списка ретранслятора клиента** ==
++    "cardName": "string", ~/~/ Наименование ТК
--(% class="box infomessage" %)
--(((
--**POST /api/v3/retranslations/find**
--)))
++    "cardNum": "string", ~/~/ Номер ТК
--Пример запроса:
++    "operator": "string", ~/~/ Оператор ТК
--{
--"id": "",  ~/~/ идентификатор пользователя
--"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
--"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
--}
++    "address": "string", ~/~/ Адрес АЗС
--Ответ
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
--[
--{
--"description": "",    ~/~/ Определяет описание
--"subscriberId": "",    ~/~/ идентификатор запроса
--"protocolType": 0,     ~/~/ Тип протокола
--"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
--"address": "string",    ~/~/ Адрес события
--"id": "",    ~/~/ идентификатор пользователя
--"parentId": "",    ~/~/ Guid идентификатор родителя
--"deleted": true   ~/~/ Признак удаления
--}
--]
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
--
--== **API для отчета по выгрузке комбайнов** ==
--
--(% class="box infomessage" %)
--(((
--POST **/api/v3/Reports/harvesterUnloading**
--)))
--
--Пример запроса:
--
--{
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0,  ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
--  "showNearestObjects": true,  ~/~/Показывать объекты рядом?
--  "vehicleIds": [   ~/~/ Список id объектов для анализа
--    0
--  ],
--  "from": "", ~/~/ Дата и время начало запроса
--  "to": "",  ~/~/ Дата и время окончания запроса
--  "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Пример ответа:
--
--[
--  {
--    "harvesterName": "",  ~/~/Комбайн, номер
--    "harvesterId": 0, ~/~/Комбайн, id
--"harvesterModel": "", ~/~/ Модель комбайна
--"hopperCapacity": 0, ~/~/ Объем бункера м3
--    "hopperDischargeSpeed": 0,  ~/~/ Скорость выгрузки из бункера, л/сек
--    "events": [  ~/~/Список событий в разрезе комбайна
--      {
--        "driverId": "",  ~/~/Идентификатор водителя
--        "driverName": "", ~/~/Водитель комбайна, ФИО
--        "RFID": "", ~/~/ идентификатор карты-метки
--        "rfidName": "", ~/~/Водитель комбайна, имя метки
--        "vehicleId": 0, ~/~/идентификатор объекта
--        "vehicleName": "string", ~/~/ Имя объекта
--        "modelName": "string", ~/~/  Имя модели объекта
--        "nearestVehicles": [  ~/~/Объекты рядом
--          {
--            "vehicleId": 0, ~/~/идентификатор объекта
--            "vehicleName": "string" ~/~/ Имя объекта
--          }
--        ],
--        "fields": [  ~/~/Поля, где происходила выгрузка
--          {
--            "id": 0, ~/~/ идентификатор пользователя
--            "name": "string" ~/~/ имя пользователя
--          }
--        ],
--        "event": "string", ~/~/Событие
--        "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
--        "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
--        "durationSeconds": 0,  ~/~/Продолжительность события, в секундах
--        "cultureName": "string",  ~/~/ название культуры
--        "bunkerLowLevelStart": 0,  ~/~/Бункер, нижний уровень (на начало события)
--        "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
--        "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
--        "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
--        "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
--        "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
--        "issued": 0, ~/~/Выдано, бункеров
--        "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
--        "latitude": 0,  ~/~/Широта
--        "longitude": 0, ~/~/ Долгота
--        "litresAway": 0, ~/~/Отдано, л
--        "m3Away": 0 ~/~/Отдано, м3
--      }
--    ]
    }
--]
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
@@ -4401,29 +4401,32 @@
  Ответ:
--[
--  {
--    "recordTime": "",  ~/~/Время записи
--    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзину
--    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/
--nullable: true  ~/~/Детали
--        {
--          "name": "string", ~/~/наименование столбца
--          "value": "string" ~/~/содержание столбца
--        }
--      ]
--    },
--   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--      "string"
--    ]
--  }
--]
++"recordTime": "2024-03-12T12:40:42.502257Z", - Время удаления объекта в UTC
++"userId": "11111111-c384-43f8-8562-1c3d79a32303", - Пользователь удаливший объект
++"parentId": "f649b532-e519-42da-941e-5fdb3b581482", - GUID агента
++"objectId": "8c79a744-0ba6-4943-8d9e-a9d9509168f2", - GUID объекта
++"objectType": "Vehicle", - Тип объекта
++"details": {
++"items": [ {
++"name": "ObjectName", - наименование столбца
++"value": "01" - содержание столбца
++},
++{
++"parentName": "string",
++"name": "string",
++"picture": "string",
++"minspeed": 0,
++"maxspeed": 0,
++"width": 0,
++"imbeddedtrailer": true,
++"hoppercapacity": 0,
++"hopperdischargespeed": 0,
++"modelType": 0,
++"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++"deleted": true
++}
  (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
@@ -4434,37 +4434,12 @@
  В заголовках запроса: X-Auth: Токен авторизации
--Пример запроса:
--
++Параметры в теле запроса (JSON):
  [
--0
++"eb737fdf-c422-4df7-8727-bd61439b8460",
++"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
  ]
--
--Пример ответа:
--
--[
--{
--    "recordTime": "", ~/~/Время записи
--    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзин
--    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/Детали
--        {
--          "name": "", ~/~/Имя свойства
--          "value": "" ~/~/Значение свойства
--        }
--      ]
--    },
--    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
--      ""
--    ]
--  }
--]
--
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
  == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
@@ -4477,53 +4477,15 @@
  В заголовках запроса: X-Auth: Токен авторизации
  Параметры в теле запроса (JSON):
--
--Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--
--Пример запроса:
--
--(((
  [
--)))
--
--(((
--  0
--)))
--
--(((
++"eb737fdf-c422-4df7-8727-bd61439b8460",
++"3ec2f507-dfdc-41d4-b2bb-6f66e3d27df3"
  ]
--)))
++Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
--Пример ответа:
--[
--{
--    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
--    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
--    "objectId": 0, ~/~/ID объекта, помещённого в корзину
--    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
--    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
--    "details": { ~/~/Список деталей объекта, помещённого в корзину
--      "items": [ ~/~/Детали
--        {
--          "name": "string",  ~/~/Имя свойства
--          "value": "string" ~/~/Значение свойства
--        }
--      ]
--    },
--    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
--      "string"
--    ]
--  }
--]
--
--
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню