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

Редактировал(а) Андрей Калиновский 2025/09/11 10:51

От версии < 247.2 >

отредактировано Андрей Калиновский
на 2025/07/03 16:21

К версии < 260.1 >

отредактировано Андрей Калиновский
на 2025/09/09 14:38

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

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

Комментарий

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

Подробности

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

Содержимое

@@ -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" %)
@@ -766,7 +766,10 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--=   =
++(% class="wikigeneratedid" id="H" %)
++(((
++
++)))
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
@@ -2391,7 +2391,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2438,7 +2438,7 @@
  Тело запроса:
  {
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой)
    "vehicleIds": [0], ~/~/ Список ID объектов
    "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
    "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
@@ -2634,163 +2634,8 @@
    }
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
++=   =
--== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--(% style="text-align:left" %)
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--(% style="text-align:left" %)
--Ответ:
--
--[
--  {
--    "id": 0, ~/~/ Идентификатор объекта геозоны
--    "name": "string", ~/~/ Название объекта геозоны
--    "type": 0, ~/~/ Тип объекта геозоны
--    "fname": "string", ~/~/ Имя файла
--    "parentId": "string", ~/~/ Идентификатор клиента
--    "radius": 0, ~/~/ Радиус геообъекта
--    "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
--    "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
--    "description": "string", ~/~/ Описание
--    "area": 0, ~/~/ Площадь, м^^2^^
--    "perimetr": 0, ~/~/ Периметр, м
--    "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
--  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
--  "ids": [ ], ~/~/ Массив id объектов
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
--}
--
--Ответ:
--[
--  {
--    "geozoneId": 0, ~/~/ ID геообъекта
--    "geozoneName": "string", ~/~/ Название геообъекта
--    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
--    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
--    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
--    "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string" ~/~/ Имя объекта
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
--  "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
--  "ids": [ ], ~/~/ Массив id геообъектов
--  "byTime": 0, ~/~/ Объединение событий по времени
--  "byDist": 0, ~/~/ Объединение событий по расстоянию
--  "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
--  "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
--}
--
--Ответ:
--
--[
--  {
--    "geozoneId": 0, ~/~/ ID геообъекта
--    "geozoneName": "string", ~/~/ Название геообъекта
--    "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
--    "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
--    "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
--    "vehicleId": 0, ~/~/ ID объекта
--    "vehicleName": "string" ~/~/ Имя объекта
--  }
--]
--
--
--== (% 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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -5450,33 +5450,9 @@
  )))
--== **Удаление существующего поля** ==
--
--(% class="box errormessage" %)
  (((
--**DELETE /api/v3/agroLands/{id}**
--)))
--
--Пример запроса:
--id  ~/~/ Идентификатор поля
--
--Пример ответа:
--
  (((
--200 ~/~/ Успех
--)))
--
  (((
--
--)))
--
--(((
--(((
--(((
--
--)))
--
--(((
  == **Изменение поля** ==
  (% class="box infomessage" %)
@@ -5722,9 +5722,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 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +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 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +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" %)Раздел: **Корзина**(%%) =
  )))
  )))
@@ -6208,14 +6208,14 @@
  = **Раздел: Локатор ** =
--== **Получение списка локаторов, доступных пользователю ** ==
++== **Получение данных по локатору** ==
  (% class="box infomessage" %)
  (((
--**GET /api/v3/locators **
++**GET /api/v3/locators/{locatorId}**
  )))
--В заголовках запроса: X-Auth: Токен авторизации
++В запросе указывается locatorid - идентификатор локатора
  Пример ответа:
@@ -6249,13 +6249,16 @@
    "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
    "url": "string", ~/~/ Ссылка
    "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
--  "showVehicleName": true, ~/~/ Наименование объекта
--  "showVehicleDirection": true, ~/~/ Направление движения на треке
--  "allowTrackReport": true, ~/~/ Трек
--  "showTrackTracing": true, ~/~/ Трассировка трека
--  "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": [ ~/~/  Слои на карте
--    0
++
++ "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
++
    ]
  }
  )))
@@ -6297,12 +6297,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
++
        ]
  }
  )))
@@ -6378,7 +6378,6 @@
  )))
--
  == **Изменение локатора** ==
  (% class="box infomessage" %)
@@ -6408,11 +6408,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
++
    ]
  }
@@ -6440,7 +6440,6 @@
  )))
--
  = **Раздел: Яндекс Маршруты** =
@@ -6454,7 +6454,6 @@
  Пример запроса:
  Id  ~/~/ Идентификатор поля
--
  Пример ответа:
  (((
@@ -6472,7 +6472,6 @@
  )))
--
  == **Добавить маршрут** ==
  (% class="box infomessage" %)
@@ -6527,7 +6527,6 @@
  }
  )))
--
  Пример ответа:
  (((
@@ -6558,7 +6558,6 @@
  ]
  )))
--
  Пример ответа:
  (((
@@ -6582,7 +6582,6 @@
  Id  ~/~/ Идентификатор поля
--
  = **Раздел: Управление доступа к машинам** =
@@ -6604,7 +6604,6 @@
  )))
--
  == Задает видимость транспортных средств пользователю ==
  (% class="box infomessage" %)
@@ -6629,10 +6629,6 @@
  )))
  (((
--
--)))
--
--(((
  Пример ответа :
  )))
@@ -6646,11 +6646,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]] **

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

Комментарий

Подробности

Меню