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

Last modified by Андрей Калиновский on 2025/07/29 15:51

From version < 245.1 >

edited by Андрей Калиновский
on 2025/07/03 09:46

To version < 252.1 >

edited by Андрей Калиновский
on 2025/07/29 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

@@ -287,28 +287,6 @@
    "bankKS": "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" %)Идентификатор клиента-родителя
--|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
--|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
--|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
--|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
--|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
--|(% style="width:215px" %)district|(% style="width:861px" %)Округ
--|(% style="width:215px" %)region|(% style="width:861px" %)Регион
--|(% style="width:215px" %)city|(% style="width:861px" %)Город
--|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
--|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
--|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
--|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
--|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
--|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
--|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
--|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
--|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
--|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
--
  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
  (% class="box warningmessage" %)
@@ -454,7 +454,7 @@
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
--    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -766,6 +766,8 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
++=   =
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
@@ -2389,7 +2389,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2436,7 +2436,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -5448,23 +5448,8 @@
  )))
--== **Удаление существующего поля** ==
--(% class="box errormessage" %)
  (((
--**DELETE /api/v3/agroLands/{id}**
--)))
--
--Пример запроса:
--id  ~/~/ Идентификатор поля
--
--Пример ответа:
--
--(((
--200 ~/~/ Успех
--)))
--
--(((
  )))
@@ -5471,10 +5471,6 @@
  (((
  (((
  (((
--
--)))
--
--(((
  == **Изменение поля** ==
  (% class="box infomessage" %)
@@ -5720,9 +5720,102 @@
    "perimetr": 0, ~/~/ ериметр, м
    "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
  }
++
++
++== **Какие поля посещал объект** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/agroLands/visitingByVehicle**
  )))
++Пример запроса:
++{
++  "vehicleId": 0, ~/~/ id объекта
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
++  "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
++  "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
++}
++
++Пример ответа:
++
++[
++  {
++    "fieldId": 0, ~/~/ id объекта
++    "vehicleName": "string", ~/~/ Наименование объекта
++    "fieldName": "string", ~/~/ Наименование поля
++    "fuelUsage": 0, ~/~/ Расход топлива, л/га
++    "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
++    "vehicleId": 0, ~/~/ Идентификатор ТС
++    "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
++    "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
++    "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля
++    "mileage": 0 ~/~/ Пробег
++  }
++]
++)))
++
++
++== **Посещение поля объектами ** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/agroLands/visitingByField**
++)))
++
++Пример запроса:
++{
++  "fieldId": 0, ~/~/ ID поля
++  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
++  "byDist": 0, ~/~/ Объединение событий по расстоянию
++  "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
++  "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
++  "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
++}
++
++Пример ответа:
++
++[
++  {
++    "fieldId": 0, ~/~/ ID поля
++    "vehicleName": "string", ~/~/ Наименование объекта
++    "fieldName": "string", ~/~/ Имя поля
++    "fuelUsage": 0, ~/~/ Расход топлива, л/га
++    "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
++    "vehicleId": 0, ~/~/ Идентификатор ТС
++    "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
++    "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
++    "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля
++    "mileage": 0 ~/~/ Пробег
++  }
++]
++
++
++== **Удаление существующего поля** ==
++
++(% class="box errormessage" %)
++(((
++**DELETE /api/v3/agroLands/{id}**
++)))
++
++Пример запроса:
++id  ~/~/ Идентификатор поля
++
++Пример ответа:
++
++(((
++200 ~/~/ Успех
++
++
++)))
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
  )))
  )))
@@ -6206,14 +6206,14 @@
  = **Раздел: Локатор ** =
--== **Получение списка локаторов, доступных пользователю ** ==
++== **Получение данных по локатору** ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators **
++**GET /api/v3/locators/{locatorId}**
  )))
--В заголовках запроса: X-Auth: Токен авторизации
++В запросе указывается locatorid - идентификатор локатора
  Пример ответа:
@@ -6246,14 +6246,17 @@
    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
    "url": "string", ~/~/ Ссылка
--  "language": 0, ~/~/ Язык
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/  Слои на карте
--    0
++  "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++
++ "showVehicleName": true, ~/~/ Наименование объекта
++    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
++    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
++    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
++    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
++    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++
++  1
++
    ]
  }
  )))
@@ -6260,38 +6260,9 @@
  )))
--== **Получение перечня моделей ** ==
--
--(% class="box successmessage" %)
  (((
--**POST /api/v3/models/find**
--)))
--
--Пример запроса:
--
  (((
--(((
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
--  "name": "string", ~/~/ Наименование локатора
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
--)))
--
--
--
-- Пример ответа:
--
--(((
--[
--  {
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
--    "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
--    "name": "string", ~/~/ Наименование локатора
--    "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины)
--  }
--]
  )))
  )))
@@ -6324,12 +6324,16 @@
    "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую
    ],
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++
++ "showVehicleName": true, ~/~/ Наименование объекта
++    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
++    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
++    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
++    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
++    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++
++    1
++
        ]
  }
  )))
@@ -6342,7 +6342,69 @@
  )))
++== **Выводит список локаторов ** ==
++(% class="box successmessage" %)
++(((
++**POST /api/v3/locators/find**
++)))
++
++Пример запроса:
++
++(((
++{
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
++}
++)))
++
++(((
++
++)))
++
++(((
++
++)))
++
++
++Пример ответа:
++
++(((
++[
++  {
++    "vehiclesCount": 0, ~/~/ Количество объектов.
++    "geozonesCount": 0, ~/~/ Количество геозон.
++    "fieldsCount": 0, ~/~/ Количество полей.
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
++    "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
++    "agentName": "string", ~/~/ Наименование агента.
++    "isEnabled": true, ~/~/ Активность локатора
++    "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
++    "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления
++    "name": "string", ~/~/ Наименование локатора
++    "status": 0,   ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный)
++    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени )
++    "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
++    "validity": 0, ~/~/ Срок действия в днях (1-90)
++    "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2)
++    "autoProlongation": true, ~/~/ Автоматическая пролонгация
++    "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
++    "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора
++    "url": "string", ~/~/ ссылка на локатор
++    "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++    "showVehicleName": true, ~/~/ Наименование объекта
++    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
++    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
++    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
++    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
++    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++
++    0
++    ]
++  }
++]
++)))
++
++
  == **Изменение локатора** ==
  (% class="box infomessage" %)
@@ -6372,11 +6372,14 @@
    ],
    "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++    "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
++    "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
++    "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
++    "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
++    "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++
++    0
++
    ]
  }
@@ -6404,7 +6404,6 @@
  )))
--
  = **Раздел: Яндекс Маршруты** =
@@ -6418,7 +6418,6 @@
  Пример запроса:
  Id  ~/~/ Идентификатор поля
--
  Пример ответа:
  (((
@@ -6436,7 +6436,6 @@
  )))
--
  == **Добавить маршрут** ==
  (% class="box infomessage" %)
@@ -6491,7 +6491,6 @@
  }
  )))
--
  Пример ответа:
  (((
@@ -6522,7 +6522,6 @@
  ]
  )))
--
  Пример ответа:
  (((
@@ -6546,7 +6546,6 @@
  Id  ~/~/ Идентификатор поля
--
  = **Раздел: Управление доступа к машинам** =
@@ -6568,7 +6568,6 @@
  )))
--
  == Задает видимость транспортных средств пользователю ==
  (% class="box infomessage" %)
@@ -6593,10 +6593,6 @@
  )))
  (((
--
--)))
--
--(((
  Пример ответа :
  )))
@@ -6610,10 +6610,6 @@
  )))
--
--
--
--
  (% 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

Меню