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

Last modified by Андрей Калиновский on 2025/02/20 09:52

From version < 78.1 >

edited by Илья Крайнов
on 2023/03/14 14:59

To version < 82.1 >

edited by Илья Крайнов
on 2023/03/29 14:58

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -62,7 +62,7 @@
  (% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -82,7 +82,7 @@
  **GET api/v3/agents/{id}**
  )))
--Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
@@ -124,7 +124,7 @@
  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
  )))
--(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
@@ -161,7 +161,7 @@
  **POST /api/v3/agents **
  )))
--Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет добавить клиента, указанного в запросе.
  Метод запроса: **POST**
@@ -224,7 +224,7 @@
  **PUT /api/v3/agents**
  )))
--Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет отредактировать клиента, указанного в запросе.
  Метод запроса: **PUT**
@@ -288,7 +288,7 @@
  **DELETE /api/v3/agents/{clientId}**
  )))
--Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет удалить клиента, указанного в строке запроса.
  Метод запроса: **DELETE**
@@ -309,7 +309,7 @@
  (% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -336,16 +336,16 @@
      "parentId": "",  ~/~/ Guid родительского агента
      "leaderId": "",  ~/~/ Guid руководителя (null - не задан)
      "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
--    "doubleAuth":
++    "doubleAuth":
      {
         "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
         "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
      },
--    "groups":
++    "groups":
      [
         "string" ~/~/ группы пользователя, перечисление названия системных ролей
      ],
--    "customGroups":
++    "customGroups":
      [
         "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
      ],
@@ -499,7 +499,7 @@
  (% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -580,7 +580,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -610,7 +610,7 @@
  **POST /api/v3/users/disable**
  )))
--Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -632,7 +632,7 @@
  **POST /api/v3/users/enable**
  )))
--Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -669,7 +669,7 @@
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -693,7 +693,7 @@
  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
@@ -763,7 +763,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
++(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -885,7 +885,7 @@
  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -965,7 +965,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -1011,7 +1011,7 @@
  (% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1128,7 +1128,7 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--**валидация:**
++**Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
@@ -1140,7 +1140,7 @@
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1162,7 +1162,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1189,7 +1189,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1208,7 +1208,7 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
@@ -1218,7 +1218,7 @@
  )))
  (% style="text-align: left;" %)
--Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
  (% style="text-align: left;" %)
  Метод запроса **POST**
@@ -1249,7 +1249,167 @@
    }
  ]
++== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
++(% class="box infomessage" %)
++(((
++**POST /api/v3/terminalMessages**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "vehicleId": 0, ~/~/ id объекта
++  "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
++  "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
++}
++
++Ответ:
++
++[
++  {
++    "messages": [
++      {
++        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
++        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
++        "speed": 0, ~/~/ Скорость, км/ч
++        "altitude": 0, ~/~/ Высота, м
++        "latitude": 0, ~/~/ Широта [-90°;90°]
++        "longitude": 0, ~/~/ Долгота [-180°;180°]
++        "satellites": 0, ~/~/ Кол-во спутников
++        "voltage": 0, ~/~/ Напряжение
++        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
++          "additionalProp1": "string",
++          "additionalProp2": "string",
++          "additionalProp3": "string"
++        },
++        "photoCount": 0 ~/~/ Кол-во фото
++      }
++    ]
++  }
++]
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/notifications/find**
++)))
++
++Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "parentId": "" ~/~/ id клиента
++}
++
++Ответ:
++
++[
++  {
++    "id": 0, ~/~/ ID уведомления
++    "name": "string", ~/~/ Название уведомления
++    "active": true, ~/~/ Состояние true - активен, false - деактивирован
++    "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
++    "userId": "", ~/~/ Пользователь, создавший уведомление
++    "parentId": "", ~/~/ Идентификатор клиента
++    "parentName": "string" ~/~/ Имя клиента
++  }
++]
++
++== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/notifications/{id}**
++)))
++
++Метод возвращает данные правил формирования выбранного уведомления.
++
++(% style="text-align: left;" %)
++Метод запроса **GET**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)Ответ:
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %){
++  "id": 0, ~/~/ (%%)id уведомления
++(% style="color:#000000" %)  "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
++(% style="color:#000000" %)  "userId": "", /(%%)/ Пользователь, создавший уведомление
++(% style="color:#000000" %)  "parentId": "", (%%)~/~/ Идентификатор клиента
++(% style="color:#000000" %)  "parentName": "string", (%%)~/~/ Имя клиента
++(% style="color:#000000" %)  "name": "string", (%%)~/~/ Название уведомления
++(% style="color:#000000" %)  "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
++(% style="color:#000000" %)  "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
++(% style="color:#000000" %)    0
++  ],
++  "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
++(% style="color:#000000" %)    0
++  ],
++  "fieldids": [ ~/~/ (%%)Список id полей для анализа
++(% style="color:#000000" %)    0
++  ],
++  "settings": { ~/~/ Список параметров уведомления
++    "additionalProp1": "string",
++    "additionalProp2": "string",
++    "additionalProp3": "string"
++  },
++  "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
++(% style="color:#000000" %)  "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
++(% style="color:#000000" %)    ""
++  ],
++  "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
++(% style="color:#000000" %)  "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
++(% style="color:#000000" %)    "string"
++  ],
++  "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
++(% style="color:#000000" %)  "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
++(% style="color:#000000" %)    {
++      "id": 0, ~/~/ (%%)Идентификатор участника чата
++(% style="color:#000000" %)      "info": "string" ~/~/ (%%)Дополнительные сведения
++(% style="color:#000000" %)    }
++  ],
++  "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
++(% style="color:#000000" %)  "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
++(% style="color:#000000" %)  "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
++(% style="color:#000000" %)  "kind": 0, ~/~/ (%%)Определяет вид уведомления
++(% style="color:#000000" %)  "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
++(% style="color:#000000" %)  "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
++(% style="color:#000000" %)  "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
++(% style="color:#000000" %)  "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
++(% style="color:#000000" %)  "autoProlongation": true ~/~/ (%%)Автопродление срока действия
++(% style="color:#000000" %)}
++
++
  (% 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

Меню