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

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

From version < 218.1 >

edited by Андрей Калиновский
on 2025/04/21 13:43

To version < 227.2 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1628,81 +1628,10 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== **Импортировать историю ТС (Асинхронный запрос)** ==
++(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
--)))
--
--Метод запроса: **POST**
--
--URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
--
--Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
--
--~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
--== **Возвращает статус асинхронного запроса импорта истории ТС** ==
--
  (% class="box infomessage" %)
  (((
--**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
--)))
--
--Метод запроса: **GET**
--
--URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
--
--Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
--
--
--Ответ:
--
--{
--
--  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
--
--  "Status": 0, ~/~/ Перечисление состояний выполения запроса
--~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
--
--  "Message": "string", ~/~/ Информация о выполнении запроса
--
--  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
--
--~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
--
--  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
--
--  "Data": "string" ~/~/ Данные
--
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
--
--(% class="box infomessage" %)
--(((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
@@ -2806,6 +2806,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" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -4290,6 +4290,45 @@
  |producedCount|Кол-во успешно отправленных в шину данных сообщений
  |msgCount|Кол-во обработанных сообщений всего
++==   ==
++
++== **Импортировать историю ТС (Асинхронный запрос)** ==
++
++(% class="box successmessage" %)
++(((
++**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **POST**
++
++URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
++
++Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполнения запроса
++
++~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
++
  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -4307,10 +4307,60 @@
    "message": "string"
  }
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
--|progress|Guid ТС
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
++**Параметр**
++)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
++**Описание**
++)))
++|(((
++activity
++)))|(((
++Активен ли экспорт/импорт истории сейчас, true - да, false - нет
++)))
++|(((
++progress
++)))|(((
++Guid ТС
++)))
++
++== **Возвращает статус асинхронного запроса импорта истории ТС** ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
++)))
++
++При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
++
++Метод запроса: **GET**
++
++URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
++
++Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
++
++
++Ответ:
++
++{
++
++  "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
++
++  "Status": 0, ~/~/ Перечисление состояний выполения запроса
++~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
++
++  "Message": "string", ~/~/ Информация о выполнении запроса
++
++  "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
++
++~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
++
++  "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
++
++  "Data": "string" ~/~/ Данные
++
++}
++
  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
  (% class="box infomessage" %)
@@ -4822,8 +4822,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" %)**Раздел: Сельскохозяйственные поля **(%%) =
@@ -6092,10 +6092,10 @@
  ====   ====
--==== **Раздел: Управление доступа к машинам** ====
++= **Раздел: Управление доступа к машинам** =
--== Получение списка ID  ==
++== Получение списка транспортных средств видимых пользователю ==
  (% class="box infomessage" %)
  (((
@@ -6102,15 +6102,63 @@
  **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

Меню