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

Last modified by Андрей Калиновский on 2025/01/14 11:58

From version < 184.1 >

edited by Андрей Калиновский
on 2024/11/22 13:26

To version < 178.1 >

edited by Андрей Калиновский
on 2024/10/30 14:07

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,9 +1,11 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
  (((
--**Содержание страницы:**\
++**Содержание страницы:**
  )))
++{{toc/}}
++
  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
  (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
@@ -1170,77 +1170,6 @@
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--== **Импортировать историю ТС (Асинхронный запрос)** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
--
--(% style="color:#000000" %)Параметр запроса: {__**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}**
--)))
--
--(% style="color:#000000" %)Метод запроса: **GET**
--
--(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
--
--(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса
--
--
--Ответ:
--
--{
--
--  "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 successmessage" %)
@@ -1441,19 +1441,9 @@
  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
  ~/~/ "ValueOn": "Вкл.",
  ~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
--
--(((
--      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
--        {
--          "from": 0, ~/~/ С какого значения
--          "color": "string", ~/~/ Каким цветом
--          "text": "string" ~/~/ Текст подписи к этому интервалу
--        }
--      ]
++      "summaryMaxValue": 0 ~/~/ Макс. значение
      }
    ],
--)))
    "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
@@ -1460,12 +1460,12 @@
    "customFields": [ ~/~/ Произвольные поля
      {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
--      "name": "string", ~/~/ Наименование произвольного поля
--      "value": "string", ~/~/ Значение произвольного поля
--      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
--      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
--      "forReport": true ~/~/ Отобразить произвольное поле в отчете
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "name": "string",
++      "value": "string",
++      "forClient": true,
++      "forTooltip": true,
++      "forReport": true
      }
    ]
  }
@@ -1475,7 +1475,6 @@
  (((
  (((
--(((
  {
    "vehicleId": 0,  ~/~/ ID ТС
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
@@ -1595,10 +1595,9 @@
          {
            "from": 0, ~/~/ С какого значения
            "color": "string", ~/~/ Каким цветом
++  (% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"text": "string"
  )))
--(((
--          "text": "string" ~/~/ Текст подписи к этому интервалу
           }
        ]
      }
@@ -1617,8 +1617,6 @@
    "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
  }
  )))
--)))
--)))
  **Валидация:**
@@ -1667,12 +1667,9 @@
      "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
      "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
      "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
--     "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
--      "unitName": "string",  ~/~/ Название подразделения (опционально)
--    "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
--    "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
--    "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
--     "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
++    "parentId": null, ~/~/ ID клиента (Guid, опционально)
++    "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
++    "customFields": null ~/~/ значение любого из произвольных полей ТС
  }
  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
@@ -1679,15 +1679,8 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %)[
--{
--
--(((
--    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
--)))
--
--(((
--(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
++(% style="color:#000000" %){
++    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1712,21 +1712,9 @@
                  "forClient": true, ~/~/ право на отображение у клиента
                  "forTooltip": false, ~/~/ право на отображение в подсказке
                  "forReport": false ~/~/ право на отображение в отчетах
--)))
++            }(%%)
++(% style="color:#000000" %)}
--(((
--      }
--    ],
--    "vehicleGroups": [  ~/~/ Группы ТС
--      {
--        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
--        "name": "string" ~/~/ Наименование группы ТС
--      }
--    ]
--  }
--]
--)))
--
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
@@ -1911,31 +1911,25 @@
  ~/~/ "ValueOn": "Вкл.",
  ~/~/ "ValueOff": "Выкл."
        "summaryMaxValue": 0 ~/~/ Макс. значение
--
--      "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
--        {
--          "from": 0, ~/~/ С какого значения
--          "color": "string", ~/~/ Каким цветом
--          "text": "string" ~/~/ Текст подписи к этому интервалу
--        }
--      ]
      }
    ],
++
++(((
   "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
++)))
    "customFields": [ ~/~/ Произвольные поля
--    {
--     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
--      "name": "string", ~/~/ Наименование произвольного поля
--      "value": "string", ~/~/ Значение произвольного поля
--      "forClient": true, ~/~/ Отобразить произвольное поле у клиента
--      "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
--      "forReport": true ~/~/ Отобразить произвольное поле в отчете
++    {
++      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++      "name": "string",
++      "value": "string",
++      "forClient": true,
++      "forTooltip": true,
++      "forReport": true
      }
    ]
  }
--
  (% style="color:#000000" %)Ответ:
  (((
@@ -1975,7 +1975,7 @@
    "cmsv6Parameters": { ~/~/ Dto для CMSv6
      "id": "string", ~/~/ CMSV6 Идентификатор
      "enabled": true, ~/~/ Признак включения
--    "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.
++    "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6.
  )))
@@ -2527,7 +2527,7 @@
      ],
      "stops": [       ~/~/ События стоянок
        {
--        "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
++        "address": "string", ~/~/ Адрес события
          "eventId": 0, ~/~/ Идентификатор события
          "eventName": "string", ~/~/ Название события
          "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
@@ -4289,67 +4289,64 @@
  Тело запроса:
  {
--  "vehicleIds": [vehicleId], ~/~/Массив ID объектов
--  "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
--  "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
++  "vehicleIds": [vehicleId],
++  "from": "2023-11-22T09:29:48.051Z",
++  "to": "2023-11-22T09:29:48.051Z"
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleIds|Массив ID объектов
++|from|Дата начала запроса
++|to|Дата окончания запроса
++
  Ответ:
  {
--  "items": [  ~/~/ Список в разрезе ТС
++  "items": [
      {
--      "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
--      "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
--      "vehicleId": 0, ~/~/ ID ТС
--      "vehicleName": "string", ~/~/ Название ТС
--      "vehicleModel": "string", ~/~/ Модель ТС
--      "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
--      "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
--      "totalViolations": 0, ~/~/ Нарушений всего
--      "violationsByType": { ~/~/ Информация о нарушениях по типу
--        "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
--        "accelerationViolations": 0, ~/~/ Нарушений ускорения
--        "brakingViolations": 0, ~/~/ Нарушений торможения
--        "turningViolations": 0, ~/~/ Нарушений опасного поворота
--        "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
--        "sensorViolations": 0 ~/~/ Нарушений по датчику
++      "from": "2023-11-22T09:29:48.052Z",
++      "to": "2023-11-22T09:29:48.052Z",
++      "vehicleId": 0,
++      "vehicleName": "string",
++      "vehicleModel": "string",
++      "penalty": 0,
++      "score": 0,
++      "totalViolations": 0,
++      "violationsByType": {
++        "overspeedingViolations": 0,
++        "accelerationViolations": 0,
++        "brakingViolations": 0,
++        "turningViolations": 0,
++        "dangerousDrivingViolations": 0,
++        "sensorViolations": 0
        },
--
--(((
--
--)))
--
--      "moveTime": 0, ~/~/ Продолжительность движения, сек
--      "mileage": 0, ~/~/ Пробег, м
--      "tripsCount": 0, ~/~/ Кол-во рейсов
--      "trips": [  ~/~/ Информация по рейсу
++      "moveTime": 0,
++      "mileage": 0,
++      "tripsCount": 0,
++      "trips": [
          {
--          "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
--          "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
--          "violationsCount": 0, ~/~/ Всего нарушений
--          "violationsByType": { ~/~/ Информация о нарушениях по типу
--            "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
--            "accelerationViolations": 0, ~/~/ Нарушений ускорения
--            "brakingViolations": 0, ~/~/ Нарушений торможения
--            "turningViolations": 0, ~/~/ Нарушений опасного поворота
--            "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
--            "sensorViolations": 0 ~/~/ Нарушений по датчику
++          "penalty": 0,
++          "score": 0,
++          "violationsCount": 0,
++          "violationsByType": {
++            "overspeedingViolations": 0,
++            "accelerationViolations": 0,
++            "brakingViolations": 0,
++            "turningViolations": 0,
++            "dangerousDrivingViolations": 0,
++            "sensorViolations": 0
            },
--
--         "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
--          "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
--          "moveTime": 0, ~/~/ Продолжительность движения, сек
--          "mileage": 0, ~/~/ Пробег, м
--          "motohours": 0, ~/~/ Моточасы, секунды
--          "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
--          "startAddress": "string", ~/~/ Адрес начала рейса
--          "endAddress": "string", ~/~/ Адрес конца рейса
--          "drivers": [  ~/~/ Список водителей
++          "moveTime": 0,
++          "mileage": 0,
++          "motohours": 0,
++          "maxSpeed": 0,
++          "startAddress": "string",
++          "endAddress": "string",
++          "drivers": [
              {
--              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
--              "driverName": "string", ~/~/ФИО водителя
--              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
++              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++              "driverName": "string",
++              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
              }
            ]
          }
@@ -4358,6 +4358,34 @@
    ]
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|from|Дата начала запроса
++|to|Дата  окончания
++|vehicleId|ID объекта
++|vehicleName|Имя объекта
++|vehicleModel|Модель объекта
++|penalty|Сумма штрафных баллов
++|score|Оценка
++|totalViolations|Суммарное количество нарушений
++|violationsByType|Список типов нарушений и количество нарушений для каждого типа
++|overspeedingViolations|Превышение скорости
++|accelerationViolations|Ускорение
++|brakingViolations|Торможение
++|turningViolations|Резкий поворот
++|dangerousDrivingViolations|Резкое вождение
++|sensorViolations|Нарушение по датчику
++|moveTime|Время в движении
++|mileage|Пробег (км)
++|tripsCount|Количество рейсов
++|motohours|Моточасы
++|maxSpeed|Максимальная скорость
++|startAddress|Адрес начала рейса
++|endAddress|Адрес окончания рейса
++|drivers|Список водителей, которые были на объекте в течениии рейса
++|driverGuid|Guid водителя
++|driverName|Имя водителя
++|driverRfid|Номер Карты-метки
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

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

Summary

Details

Меню