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

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

From version < 202.1 >

edited by Андрей Калиновский
on 2024/12/20 16:41

To version < 222.1 >

edited by Андрей Калиновский
on 2025/04/24 15:41

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -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" %)Идентификатор клиента-родителя
@@ -1021,6 +1021,17 @@
  (((
  {
++
++(((
++   "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
++   "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
++)))
++
++(((
++                                      ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
++   "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
++)))
++
      "vehicleId": "", ~/~/ ID объекта
      "name": "", ~/~/ Имя объекта
      "imei": "", ~/~/ IMEI объекта
@@ -1115,6 +1115,7 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
++      "color": "string", ~/~/ Код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -1172,11 +1172,21 @@
        "date": "2023-05-22T09:57:39.562Z",
        "description": "string",
        "additionalInfo": "string"
--    }
--  ]
++
++(((
  }
++  ],
++  "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
  )))
++(((
++                                               ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
++}
++
++)))
++)))
++
  (% style="text-align:left" %)
  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
@@ -1269,7 +1269,13 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){(%%)
++(% style="color:#000000" %){
++
++
++(((
++    "vehicleId": 0, ~/~/ ID ТС
++)))
++
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1362,6 +1362,7 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
++      "color": "string", ~/~/ код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -1411,10 +1411,19 @@
        "forClient": true, ~/~/ Отобразить произвольное поле у клиента
        "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
--    }
--  ]
++
++(((
++ }
++  ],
++  "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
++)))
++
++(((
++                                              ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
  }
++)))
++
  (% style="color:#000000" %)Ответ:
@@ -1523,6 +1523,7 @@
        ],
        "showInTooltip": true, ~/~/ Отображение в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
++      "color": "string", ~/~/ код цвета датчиков
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
        "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
@@ -1559,7 +1559,7 @@
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
    ],
--  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
  }
  )))
  )))
@@ -1865,9 +1865,19 @@
  "drivers": [ ~/~/ Водители
      {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "isDefault": true
--    }
++
++(((
++      "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
++      "inputNumber": 0, ~/~/ № входа.
++      "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
++      "comment": "string", ~/~/ Комментарий.
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
++      "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
++      "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
++      "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
++)))
++
++    }
    ],
    "commandTemplates": [ ~/~/ Шаблон команды
      {
@@ -1903,6 +1903,11 @@
        ],
        "showInTooltip": true, ~/~/ Отображать в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
++
++(((
++      "color": "string",** ~/~/ **Цвет датчика
++)))
++
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
        "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
@@ -1949,7 +1949,12 @@
        "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
        "forReport": true ~/~/ Отобразить произвольное поле в отчете
      }
--  ]
++
++(((
++  ],
++  "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
++)))
++
  }
@@ -2087,6 +2087,11 @@
        ],
        "showInTooltip": true, ~/~/ Отображение в подсказке
        "showLastValid": true, ~/~/ Отображать последнее валидное значение
++
++(((
++      "color": "string", ~/~/ цвет уведомлений
++)))
++
        "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
        "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
        "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
@@ -2403,6 +2403,8 @@
          "motohours": 0, ~/~/ Моточасы за период, секунды
          "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
          "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
++         "idlingTime": 0 ~/~/  Холостой ход за период, секунд
++
        }
      ]
    }
@@ -2446,6 +2446,8 @@
          "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
          "fuelConsumption": 0, ~/~/ Расход топлива
          "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++         "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
++
        }
      ]
    }
@@ -2491,7 +2491,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, ~/~/ Количество
@@ -2720,6 +2720,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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -4383,7 +4383,7 @@
  (% class="box infomessage" %)
  (((
--POST /api/v3/fuelcards/transactions
++**POST /api/v3/fuelcards/transactions**
  )))
  Метод запроса: POST
@@ -4421,7 +4421,32 @@
      "address": "string" ~/~/ Адрес АЗС
    }
++== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
++(% class="box infomessage" %)
++(((
++**GET /api/v3/fuelcards**
++)))
++
++Метод запроса: GET
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
++
++Ответ:
++
++[
++  {
++    "Name": "string", ~/~/ Определяет наименование карты.
++    "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
++    "Number": "string", ~/~/ Определяет № карты.
++    "Enabled": true, ~/~/ Определяет признак активности карты.
++    "Description": "string", ~/~/ Определяет описание карты.
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++    "deleted": true ~/~/ Признак удаления
++  }
++]
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
@@ -4672,6 +4672,90 @@
  ]
++== **Отчет трек-датчики** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/Reports/sensorsWorks**
++)))
++
++**Пример запроса:**
++
++{
++  "vehicleIds": [ ~/~/ Список ID объектов
++    0
++  ],
++  "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
++  "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
++  "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
++}
++
++**Пример ответа:**
++
++(((
++{
++  "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
++    {
++      "vehicleId": 0, ~/~/ Идентификатор ТС
++      "sensorWorks": [ ~/~/ Интервалы работы оборудования.
++        {
++          "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
++          "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
++          "duration": 0, ~/~/  Продолжительность интервала в секундах.
++          "name": "string", ~/~/ Наименование оборудования.
++          "mileage": 0, ~/~/ Пробег за время работы оборудования.
++          "totalMileage": 0, ~/~/ Общий пробег.
++          "avgSpeed": 0 ~/~/ Средняя скорость.
++        }
++      ]
++    }
++  ]
++}
++
++
++== **Превышение скорости** ==
++
++(% 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" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -4746,13 +4746,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", ~/~/ Наименование
@@ -5249,7 +5249,7 @@
  )))
--== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  )))
  )))
  )))
@@ -5294,7 +5294,7 @@
  ]
--(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
++== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
  (% class="box infomessage" %)
  (((
@@ -5392,7 +5392,618 @@
  ]
++= **Раздел: Журнал заданий ** =
++
++== **Создание задания в Журнале заданий** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicletasks**
++)))
++
++Пример запроса:
++
++(((
++{
++  "vehicleId": 0, ~/~/ Идентификатор ТС
++  "description": "string", ~/~/ Описание
++  "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
++  "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++  "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
++  "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
++  "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
++  "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
++  "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
++  "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
++  "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
++  "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
++  "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
++  "cost": {
++    "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
++    "Name": "string", ~/~/ Наименование
++    "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
++    "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры)
++    "Norm": 0 ~/~/ Норма внесения
++  },
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id
++  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++  "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
++  "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
++  "deleted": true, ~/~/ Признак удаления
++  "extId": "string",
++  "GeoIds": [ ~/~/ Cвязанные поля
++    0
++  ]
++}
++)))
++
++
++Пример ответа:
++
++{
++  "vehicleId": 0, ~/~/ Идентификатор ТС
++  "description": "string", ~/~/ Описание
++  "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
++  "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++  "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
++  "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
++  "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
++  "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
++  "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
++  "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
++  "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
++  "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
++  "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
++  "cost": {
++    "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
++    "Name": "string", ~/~/ Наименование
++    "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
++    "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры)
++    "Norm": 0 ~/~/ Норма внесения
++  },
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++  "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
++  "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
++  "deleted": true, ~/~/ Признак удаления
++  "extId": "string", ~/~/ ExtId
++  "GeoIds": [ ~/~/ Связанные поля
++    0
++  ]
++}
++
++
++== **Редактирование задания в Журнале заданий** ==
++
++(% class="box successmessage" %)
++(((
++**PUT /api/v3/vehicletasks**
++)))
++
++Пример запроса:
++
++(((
++{
++  "vehicleId": 0, ~/~/ Идентификатор ТС
++  "description": "string", ~/~/ Описание
++  "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
++  "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++  "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
++  "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
++  "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
++  "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
++  "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
++  "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
++  "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
++  "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
++  "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
++  "cost": {
++    "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
++    "Name": "string", ~/~/ Наименование
++    "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
++    "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры)
++    "Norm": 0 ~/~/ Норма внесения
++  },
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++  "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
++  "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
++  "deleted": true, ~/~/ Признак удаления
++  "extId": "string", ~/~/ ExtId
++  "GeoIds": [ ~/~/ Связанные поля
++    0
++  ]
++}
++)))
++
++
++Пример ответа:
++
++{
++  "vehicleId": 0, ~/~/ Идентификатор ТС
++  "description": "string", ~/~/ Описание
++  "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
++  "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++  "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
++  "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
++  "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
++  "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
++  "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
++  "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
++  "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
++  "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
++  "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
++  "cost": {
++    "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
++    "Name": "string", ~/~/ Наименование
++    "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
++    "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры)
++    "Norm": 0 ~/~/ Норма внесения
++  },
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++  "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
++  "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
++  "deleted": true, ~/~/ Признак удаления
++  "extId": "string", ~/~/ ExtId
++  "GeoIds": [ ~/~/ Связанные поля
++    0
++  ]
++}
++
++
++== **Удаление задания в Журнале заданий** ==
++
++(% class="box warningmessage" %)
++(((
++**DELETE /api/v3/vehicletasks**
++)))
++
++Пример запроса:
++
++(((
++[
++  "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор
++]
++)))
++
++(((
++
++)))
++
++Пример ответа:
++
++{
++  "vehicleId": 0, ~/~/ Идентификатор ТС
++  "description": "string", ~/~/ Описание
++  "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
++  "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
++  "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
++  "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
++  "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
++  "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
++  "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
++  "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
++  "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
++  "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
++  "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
++  "cost": {
++    "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
++    "Name": "string", ~/~/ Наименование
++    "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
++    "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры)
++    "Norm": 0 ~/~/ Норма внесения
++  },
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
++  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
++  "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
++  "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
++  "deleted": true, ~/~/ Признак удаления
++  "extId": "string", ~/~/ ExtId
++  "GeoIds": [ ~/~/ Связанные поля
++    0
++  ]
++}
++
++
++== **Получение списка Журнала заданий** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicletasks/getbyperiod**
++)))
++
++Пример запроса:
++
++(((
++{
++  "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
++  "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
++  "TimeZone": 0, ~/~/ Часовой пояс.
++  "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++  ],
++  "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
++    0
++  ],
++  "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
++    0
++  ],
++  "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
++  "Limit": 0 ~/~/ Размер страницы (количество записей на странице)
++}
++)))
++
++
++Пример ответа:
++
++(((
++{
++  "total": 0,  ~/~/ Общее количество записей
++  "pages": 0,  ~/~/ Общее количество страниц
++  "currentPage": 0, ~/~/ Текущая страница
++  "items": [  ~/~/ Записи
++    {
++      "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
++      "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
++      "name": "string", ~/~/ Название задания.
++      "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
++      "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
++      "workKind": "string", ~/~/ Вид работ
++      "techOp": "string", ~/~/ Тех. операция
++      "trailerModel": "string", ~/~/ Модель агрегата
++      "width": "string", ~/~/ Ширина, м
++      "speed": "string", ~/~/ Тех. скорость
++      "fields": "string", ~/~/ Поля
++      "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
++      "vehicles": "string", ~/~/ Объект-модель
++      "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
++      "drivers": "string", ~/~/ Водители
++      "tmc": "string", ~/~/ ТМЦ
++      "client": "string", ~/~/  Клиент
++      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
++      "dep": "string", ~/~/ Подразделение
++      "geoIds": [ ~/~/  Связанные поля
++        0
++      ]
++    }
++  ]
++}
++)))
++
++
++= **Раздел: Локатор ** =
++
++
++== **Получение списка локаторов, доступных пользователю ** ==
++
++(% 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  ~/~/ Идентификатор поля
++
++
++====   ====
++
++==== **Раздел: Управление доступа к машинам** ====
++
++
++== Получение списка транспортных средств видимых пользователю  ==
++
++(% 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

Меню