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

Last modified by Андрей Калиновский on 2025/05/06 12:41

From version < 213.1 >

edited by Андрей Калиновский
on 2025/03/19 13:51

To version < 225.2 >

edited by Андрей Калиновский
on 2025/05/06 11:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -13,12 +13,10 @@
  (% class="box infomessage" %)
  (((
--**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках.
++**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
++\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
  )))
--При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
--
--
  **Содержание страницы:**
  )))
@@ -125,29 +125,41 @@
  Запрос должен содержать данные параметра "**agentId**"
  (% style="color:#000000" %)Ответ:
++
++(((
  {
--    "agentId": "",  (%%)
--    "parentId": "",
--    "parentName": "string",
--    "name": "string",
--    "fullName": "string",
--    "agentInfoType": 0,
--    "isForeign": true/false,
--    "district": "string",
--    "region": "string",
--    "city": "string",
--    "inn": "string",
--    "kpp": "string",
--    "address": "string",
--    "addressFact": "string",
--    "email": "string",
--    "director": "string",
--    "bankName": "string",
--    "bankBIK": "string",
--    "bankRS": "string",
--    "bankKS": "string"
--  }
++  "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
++  "parentName": "string", ~/~/ Наименование агента
++  "name": "string", ~/~/ Имя клиента
++  "fullName": "string", ~/~/ ФИО клиента
++  "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
++  "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
++  "district": "string", ~/~/ Район
++  "region": "string", ~/~/ Область
++  "city": "string", ~/~/ Город
++  "email": "string", ~/~/ Email
++  "director": "string", ~/~/ Руководитель
++  "RegionalData": [ ~/~/ Определяет региональные сведения.
++    {
++      "Country": 0, ~/~/ Страна
++      "groups": [ ~/~/ Список групп
++        {
++          "groupId": "string", ~/~/ Уникальный идентификатор группы
++          "fields": [ ~/~/ Список значений полей
++            {
++              "name": "string", ~/~/ Имя поля формы
++              "value": "string" ~/~/ Значение поля формы
++            }
++          ]
++        }
++      ]
++    }
++  ]
++}
++)))
++
  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента
  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
@@ -1625,6 +1625,8 @@
  **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
  )))
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
  Метод запроса: **POST**
  URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
@@ -1660,6 +1660,8 @@
  **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
  )))
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
  Метод запроса: **GET**
  URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
@@ -2519,6 +2519,8 @@
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++         "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
++
        }
      ]
    }
@@ -2564,7 +2564,8 @@
      "model": "string", ~/~/ Модель объекта
      "fuels": [ ~/~/ Массив данным по заправкам и сливам
        {
--        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
++        "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
++
          "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
          "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
          "valueFuel": 0, ~/~/ Количество
@@ -2793,6 +2793,35 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
++
++(% class="box successmessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
++)))
++
++(% style="color:#000000" %)Метод запроса: **PUT**
++
++Пример запроса:
++
++(((
++{
++  "id": 0,  ~/~/ Идентификатор объекта геозоны
++  "name": "string",  ~/~/ Наименование объекта геозоны
++  "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
++  "description": "string", ~/~/ Описание объекта геозоны
++  "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
++  "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
++  "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
++}
++)))
++
++
++Пример ответа:
++
++200 ~/~/ Success
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -4809,8 +4809,51 @@
      }
    ]
  }
++
++
++== **Превышение скорости** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Reports/overSpeedDuration**
  )))
++ Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
++
++Пример запроса:
++
++(((
++{
++  "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
++  "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
++  "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
++  "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
++  "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный )
++}
++)))
++
++(((
++
++)))
++
++(((
++Пример ответа:
++)))
++
++(((
++(((
++[
++  {
++    "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события
++    "duration": 0, ~/~/ Продолжительность события в секундах
++    "maxSpeed": 0, ~/~/ Максимальная скорость
++    "speedLimit": 0 ~/~/ Ограничение скорости
++  }
++]
++)))
++)))
++)))
++
  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -5936,7 +5936,216 @@
++= **Раздел: Яндекс Маршруты** =
++
++== **Возвращение списка маршрутов** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++Id  ~/~/ Идентификатор поля
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++    "name": "string", ~/~/ Наименование маршрута.
++    "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
++    "vehicles": [  ~/~/ Определяет список ТС для маршрута
++      0
++    ]
++  }
++]
++)))
++
++
++
++== **Добавить маршрут** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++{
++  "name": "string",  ~/~/  Опредлеляет наименование маршрута.
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [  ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++
++
++Пример ответа:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Определяет наименование маршрута
++  "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++== **Обновление маршрута** ==
++
++(% class="box successmessage" %)
++(((
++**PUT /api/v3/TransportRoutes**
++)))
++
++Пример запроса:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Опредлеляет наименование маршрута.
++  "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++Пример ответа:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
++  "name": "string", ~/~/ Определяет наименование маршрута
++  "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
++  "vehicles": [ ~/~/ Определяет список ТС для маршрута
++    0
++  ]
++}
++)))
++
++
++== **Получить связки маршрутов ТС** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/TransportRoutes/getroutesvehicles**
++)))
++
++Пример запроса:
++
++(((
++[
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
++]
++)))
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
++    "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
++  }
++]
++)))
++
++
++== **Удалить маршрут** ==
++
++(% class="box warningmessage" %)
++(((
++**DELETE /api/v3/TransportRoutes/{id}**
++)))
++
++Пример запроса:
++Id  ~/~/ Идентификатор поля
++
++
++====   ====
++
++= **Раздел: Управление доступа к машинам** =
++
++
++== Получение списка транспортных средств видимых пользователю ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/UserVisibleVehicles/{userId}**
++)))
++
++Пример ответа:
++
++(((
++{
++  "vehicleIds": [  ~/~/ Идентификаторы ТС
++    0
++  ]
++}
++)))
++
++
++
++== Задает видимость транспортных средств пользователю ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/UserVisibleVehicles**
++)))
++
++Пример запроса:
++
++(((
++(((
++{
++  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
++  "vehicleIds": [ ~/~/ Идентификаторы ТС
++    0
++  ]
++}
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++(((
++Пример ответа :
++)))
++
++(((
++
++)))
++
++(((
++200 ~/~/ Success
++)))
++)))
++
++
++
++
++
++
  (% 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

Меню