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

Last modified by Андрей Калиновский on 2025/02/25 16:35

From version < 66.15 >

edited by Илья Крайнов
on 2022/11/24 13:43

To version < 80.2 >

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

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,13 +1,14 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
--= Описание ГЛОНАССSoft Public API 3.0 =
++(((
++**Содержание страницы:**
++)))
--
  {{toc/}}
  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
--(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
++(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
@@ -37,7 +37,7 @@
  (% style="color:#000000" %){
      "login": "testuser",
      "password": "testuser"
--}(%%)
++}
  (% style="color:#000000" %)**Ответ:**
@@ -61,7 +61,7 @@
  (% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -74,15 +74,57 @@
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
  (% class="box infomessage" %)
  (((
--(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
++**GET api/v3/agents/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
++
++(% style="color:#000000" %)Метод запроса: **GET**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
++
++Запрос должен содержать данные параметра "**agentId**"
++
++(% style="color:#000000" %)Ответ:
++А
++{
++    "agentId": "", ~/~/ идентификатор клиента    (%%)
++    "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
++    "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
++    "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
++    "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
++    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
++    "isForeign": true/false, ~/~/ Иностранный контрагент
++    "district": "string", ~/~/ округ
++    "region": "string", ~/~/ регион
++    "city": "string", ~/~/ город
++    "inn": "string", ~/~/ ИНН клиента
++    "kpp": "string", ~/~/ КПП клиента
++    "address": "string", ~/~/ юридический адрес
++    "addressFact": "string", ~/~/ фактический адрес
++    "email": "string", ~/~/ почта
++    "director": "string", ~/~/ ФИО руководителя
++    "bankName": "string", ~/~/ Банк
++    "bankBIK": "string", ~/~/ БИК
++    "bankRS": "string", ~/~/ Номер счета
++    "bankKS": "string" ~/~/ Корр. счет
++  }
++
++== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
++)))
++
++(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
@@ -89,23 +89,26 @@
  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
--(% style="color:#000000" %)Метод запроса: **GET**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
--(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
++(% style="color:#000000" %)Параметр запроса:
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %){
++  "parentId": "string"
++}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--    "agentId": "",  ~/~/ идентификатор клиента
--    "parentId": "",  ~/~/ идентификатор клиента-родителя
--    "name": "",  ~/~/ наименование клиента
--    "fullName": "",  ~/~/ полное наименование клиента
--    "agentInfoType": "",  ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
--    "status": "",  ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
++{
++    "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
++    "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
++    "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
++    "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
++    "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
++    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
++    "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
  }
  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
@@ -115,7 +115,7 @@
  **POST /api/v3/agents **
  )))
--Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет добавить клиента, указанного в запросе.
  Метод запроса: **POST**
@@ -129,6 +129,7 @@
     "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
++  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -153,6 +153,7 @@
    "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
++  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -176,7 +176,7 @@
  **PUT /api/v3/agents**
  )))
--Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет отредактировать клиента, указанного в запросе.
  Метод запроса: **PUT**
@@ -192,6 +192,7 @@
    "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
++  "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
    "isForeign": true, ~/~/ иностранный контрагент
    "district": "string", ~/~/ округ
    "region": "string", ~/~/ регион
@@ -239,7 +239,7 @@
  **DELETE /api/v3/agents/{clientId}**
  )))
--Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
++Метод позволяет удалить клиента, указанного в строке запроса.
  Метод запроса: **DELETE**
@@ -260,7 +260,7 @@
  (% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -270,7 +270,8 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
++(% style="color:#000000" %)
++{
      "lastName": "",  ~/~/ фамилия
      "firstName": "",  ~/~/ имя
      "position": "",  ~/~/ должность
@@ -279,17 +279,41 @@
      "login": "",  ~/~/ логин (обязателен)
      "password": "",  ~/~/ пароль (обязателен)
      "email": "",  ~/~/ email (обязателен)
--    "description": "",  ~/~/ описание
--    "isEnabled": "",  ~/~/ признак включения
++    "description": "string", ~/~/ Описание
++    "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
++    "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
++    "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
      "parentId": "",  ~/~/ Guid родительского агента
--    "leaderId": "",  ~/~/ Guid руководителя (null - не задан)
--    "sessionDuration": "",  ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
--    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
--    "kind": "",  ~/~/ тип аутентификации (None - выключена, Email - по email)
--    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
--    "groups": ["", ""] ,  ~/~/ группы пользователя, перечисление названия групп (data-row)
++    "leaderId": "",  ~/~/ Guid руководителя (null - не задан)
++    "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
++    "doubleAuth":
++    {
++       "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
++       "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
++    },
++    "groups":
++    [
++       "string" ~/~/ группы пользователя, перечисление названия системных ролей
++    ],
++    "customGroups":
++    [
++       "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
++    ],
++    "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "lastName": "string",
++  "firstName": "string",
++  "position": "string",
++  "phone": "string",
++  "organization": "string",
++  "login": "string",
++  "password": "string",
++  "email": "string",
++
++
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
@@ -320,7 +320,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users/find**
  )))
@@ -368,7 +368,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
  )))
@@ -400,8 +400,11 @@
      "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
      "description": "", ~/~/ Описание
      "isEnabled": , ~/~/ Включен, true - включен, false - отключен
--    "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
--    "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
++    "doubleAuth":
++    {
++        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
++        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
++    },
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "sessionDuration": 30, ~/~/ Длительность сессии в минутах
      "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
@@ -422,7 +422,7 @@
  (% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -444,7 +444,9 @@
      "phone": "" ,  ~/~/ телефон
      "organization": "" ,  ~/~/ организация
      "login": "" ,  ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "password": "" ,  ~/~/ пароль (Если null - менять не надо)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "password": "" ,  ~/~/ пароль (Если null - менять не надо)
++    "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++    "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
      "email": "" ,  ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "description": "" ,  ~/~/ описание
      "isEnabled": "" ,  ~/~/ признак включения
@@ -451,9 +451,12 @@
      "parentId": "" ,  ~/~/ Guid родительского агента
      "leaderId": "" ,  ~/~/ Guid руководителя (null - не задан)
      "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
--    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
--    "kind": "" ,  ~/~/ тип аутентификации
--    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
++    "doubleAuth":
++    {
++        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
++        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
++    },
++    "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
  (% lang="en-US" style="text-align:left" %)
@@ -479,8 +479,12 @@
      "isEnabled": "" ,  ~/~/ признак включения
      "parentId": "" ,  ~/~/ Guid родительского агента
      "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах
--    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
--    "kind": "" ,  ~/~/ тип аутентификации
++    "doubleAuth":
++    {
++        "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
++        "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
++    },
++    "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
@@ -494,7 +494,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**
@@ -524,7 +524,7 @@
  **POST /api/v3/users/disable**
  )))
--Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -546,7 +546,7 @@
  **POST /api/v3/users/enable**
  )))
--Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -583,7 +583,7 @@
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -607,7 +607,7 @@
  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
@@ -642,6 +642,8 @@
          "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
          "mileage": "", ~/~/ Пробег по нормам в метрах
          "motohours": "" ~/~/ Моточасы по нормам, в секундах
++        "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
++        "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
      },
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
@@ -675,7 +675,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**
@@ -790,7 +790,7 @@
  == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
@@ -797,7 +797,7 @@
  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -877,7 +877,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -923,7 +923,7 @@
  (% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1040,7 +1040,7 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--**валидация:**
++**Валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
@@ -1052,7 +1052,7 @@
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1074,7 +1074,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**
@@ -1101,13 +1101,13 @@
  (% 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**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
--(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% style="color:#000000" %)Ответ:
@@ -1120,7 +1120,203 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/count**
++)))
++
++(% style="text-align: left;" %)
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align: left;" %)
++{
++  "vehicleIds": [
++    id ~/~/ здесь передается список идентификаторов объектов
++  ],
++  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
++  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
++}
++
++(% style="text-align: left;" %)
++Ответ:
++
++(% style="text-align: left;" %)
++[
++  {
++    "vehicleId": 0, ~/~/ идентификатор объекта
++    "count": 0 ~/~/ количество сообщений за период
++  }
++]
++
++== (% 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" %)**Запрос списка уведомлений клиента**(%%) ==
++
++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,
++    "name": "string",
++    "active": true,
++    "type": 0,
++    "userId": "",
++    "parentId": "",
++    "parentName": "string"
++  }
++]
++
++
++Запрос настроек уведомления
++
++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,
++  "type": 0,
++  "userId": "",
++  "parentId": "",
++  "parentName": "string",
++  "name": "string",
++  "active": true,
++  "vehicleIds": [
++    0
++  ],
++  "geoids": [
++    0
++  ],
++  "fieldids": [
++    0
++  ],
++  "settings": {
++    "additionalProp1": "string",
++    "additionalProp2": "string",
++    "additionalProp3": "string"
++  },
++  "toEmail": true,
++  "recipientIds": [
++    ""
++  ],
++  "enableSideEmails": true,
++  "sideEmails": [
++    "string"
++  ],
++  "toTelegram": true,
++  "telegrams": [
++    {
++      "id": 0,
++      "info": "string"
++    }
++  ],
++  "toMobile": true,
++  "toClient": true,
++  "stored": true,
++  "kind": 0,
++  "activationMode": 0,
++  "activationTime": "2023-03-29T09:57:48.932Z",
++  "timezone": 0,
++  "validity": 0,
++  "autoProlongation": true
++}
++
++
  (% 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

Меню