Изменения документа Методы API для работы с ГЛОНАССSoft

Редактировал(а) Андрей Калиновский 2025/04/21 14:13

От версии < 210.1 >

отредактировано Андрей Калиновский
на 2025/02/25 16:33

К версии < 220.1

отредактировано Андрей Калиновский
на 2025/04/21 14:13

Изменить комментарий: К данной версии нет комментариев

Необработанный
Обработанный

Комментарий

Свойства страницы (1 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Содержимое

@@ -11,6 +11,11 @@
  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
++(% class="box infomessage" %)
++(((
++**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
++\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
++)))
  **Содержание страницы:**
  )))
@@ -118,29 +118,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" %)Идентификатор клиента-родителя
@@ -2512,6 +2512,8 @@
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++         "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
++
        }
      ]
    }
@@ -2557,7 +2557,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, ~/~/ Количество
@@ -4802,8 +4802,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" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -4878,13 +4878,16 @@
  **POST /api/v3/agroLands**
  )))
++Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать
++X-agent  - ID клиента
++
  Пример запроса:
  (((
  {
    "extId": "string",
--  "shape": "string", ~/~/ Форма поля
--  "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
++  "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
++  "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
    "display": "string", ~/~/ Настройки отображения
    "year": 0, ~/~/ Год поля
    "name": "string", ~/~/ Наименование
@@ -5527,7 +5527,7 @@
  = **Раздел: Журнал заданий ** =
--== **Создать задание в Журнале заданий** ==
++== **Создание задания в Журнале заданий** ==
  (% class="box infomessage" %)
  (((
@@ -5606,7 +5606,7 @@
  }
--== **Редактировать задание в Журнале заданий** ==
++== **Редактирование задания в Журнале заданий** ==
  (% class="box successmessage" %)
  (((
@@ -5685,7 +5685,7 @@
  }
--== **Удалить задание в Журнале заданий** ==
++== **Удаление задания в Журнале заданий** ==
  (% class="box warningmessage" %)
  (((
@@ -5739,7 +5739,7 @@
  }
--== **Получить список Журнала заданий** ==
++== **Получение списка Журнала заданий** ==
  (% class="box infomessage" %)
  (((
@@ -5805,6 +5805,289 @@
  )))
++= **Раздел: Локатор ** =
++
++
++== **Получение списка локаторов, доступных пользователю ** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/locators**
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
++    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
++    "agentName": "string", ~/~/ Наименование агента.
++    "isEnabled": true, ~/~/ Активен
++    "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
++    "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
++    "name": "string", ~/~/ Наименование
++    "status": 0, ~/~/
++    "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++    "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации)
++    "validity": 0, ~/~/ Срок действия в днях (1-90).
++    "autoProlongation": true, ~/~/ Автопродление срока действия.
++    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
++    "url": "string", ~/~/ Ссылка
++    "language": 0, ~/~/ Язык.
++    "vehiclesCount": 0, ~/~/ Количество объектов.
++    "geozonesCount": 0, ~/~/ Количество геозон.
++    "fieldsCount": 0 ~/~/ Количество полей.
++  }
++]
++)))
++
++
++
++== **Создание локатора** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++  "isEnabled": true, ~/~/ Активность
++  "name": "string", ~/~/ Наименование локатора
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
++  "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
++  "validity": 0, ~/~/ Срок действия в днях (1-90)
++  "autoProlongation": true, ~/~/ Автопродление срока действия.
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
++}
++)))
++
++
++Пример ответа:
++
++(((
++3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
++)))
++
++
++
++== **Изменение локатора** ==
++
++(% class="box infomessage" %)
++(((
++**PUT /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
++  "isEnabled": true, ~/~/ Активность
++  "name": "string", ~/~/ Наименование
++  "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени )
++  "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
++  "validity": 0, ~/~/ Срок действия в днях (1-90)
++  "autoProlongation": true, ~/~/ Автопродление срока действия
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
++}
++)))
++
++
++Пример ответа:
++
++200 ~/~/ Success
++
++
++== **Удалить локатор** ==
++
++(% class="box warningmessage" %)
++(((
++**DELETE /api/v3/locators**
++)))
++
++Пример запроса:
++
++(((
++[
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
++]
++)))
++
++
++
++= **Раздел: Яндекс Маршруты** =
++
++
++== **Возвращение списка маршрутов** ==
++
++(% 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  ~/~/ Идентификатор поля
++
++
++====   ====
++
++==== **Раздел: Управление доступа к машинам** ====
++
++
++== Получение списка ID ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/UserVisibleVehicles/{userId}**
++)))
++
++
++
++
++
++
++
++
++
++
  (% 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]] **

Изменения документа Методы API для работы с ГЛОНАССSoft

Комментарий

Подробности

Меню