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

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

From version < 120.2 >

edited by Илья Крайнов
on 2023/11/28 12:35

To version < 80.1 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 1 removed)
- image-20231020124453-1.png

Details

Page properties

Content

@@ -14,13 +14,13 @@
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/auth/login**
  )))
@@ -31,7 +31,7 @@
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
--(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
++(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
@@ -40,6 +40,7 @@
      "password": "testuser"
  }
++
  (% style="color:#000000" %)**Ответ:**
  (% lang="en-US" %)
@@ -54,12 +54,6 @@
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
--|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
--|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
--|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
--
  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
@@ -67,7 +67,7 @@
  (% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
++(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -87,7 +87,7 @@
  **GET api/v3/agents/{id}**
  )))
--Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
@@ -98,51 +98,30 @@
  Запрос должен содержать данные параметра "**agentId**"
  (% style="color:#000000" %)Ответ:
++А
  {
--    "agentId": "",  (%%)
--    "parentId": "",
--    "parentName": "string",
--    "name": "string",
--    "fullName": "string",
--    "agentInfoType": 0,
--    "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"
++    "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="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 infomessage" %)
@@ -150,13 +150,13 @@
  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
  )))
--(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
--(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
++(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -171,25 +171,15 @@
  (% style="color:#000000" %)Ответ:
  {
--    "agentId": "",(% style="color:#000000" %)   (%%)
--    "parentId": "",
--    "parentName": "string",
--    "name": "string",
--    "fullName": "string",
--    "agentInfoType": 0,
--(% style="color:#000000" %)    "status": "",
++    "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="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" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
--
  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
  (% class="box successmessage" %)
@@ -197,7 +197,7 @@
  **POST /api/v3/agents **
  )))
--Метод позволяет добавить клиента, указанного в запросе.
++Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **POST**
@@ -208,7 +208,7 @@
  Параметры в теле запроса (JSON):
  {
--  "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
++   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
    "name": "string", ~/~/ имя
    "fullName": "string", ~/~/ полное наименование
    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
@@ -253,28 +253,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" %)
@@ -282,7 +282,7 @@
  **PUT /api/v3/agents**
  )))
--Метод позволяет отредактировать клиента, указанного в запросе.
++Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **PUT**
@@ -290,6 +290,7 @@
  В заголовках запроса: X-Auth: Токен авторизации
++
  Параметры в теле запроса (JSON):
  {
@@ -314,6 +314,7 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
++
  Ответ:
  {
@@ -344,7 +344,7 @@
  **DELETE /api/v3/agents/{clientId}**
  )))
--Метод позволяет удалить клиента, указанного в строке запроса.
++Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
  Метод запроса: **DELETE**
@@ -365,7 +365,7 @@
  (% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -419,6 +419,7 @@
    "password": "string",
    "email": "string",
++
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
@@ -447,7 +447,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)}
--
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
  (% class="box infomessage" %)
@@ -492,7 +492,7 @@
      "email": "" ,  ~/~/ E-mail
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
--    "lastLogged": "", ~/~/ дата/время последней авторизации
++    "astLogged": "", ~/~/ дата/время последней авторизации
  (% style="color:#000000" %)}
@@ -555,7 +555,7 @@
  (% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -636,7 +636,7 @@
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -666,7 +666,7 @@
  **POST /api/v3/users/disable**
  )))
--Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
++Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -688,7 +688,7 @@
  **POST /api/v3/users/enable**
  )))
--Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
++Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
@@ -725,7 +725,7 @@
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -738,249 +738,6 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% lang="en-US" %)**GET /api/v3/models/{Id}**
--)))
--
--Метод возвращает полную информацию о модели объекта.
--
--(% style="color:#000000" %)Метод запроса: **GET**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
--
--(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Ответ:
--
--(% style="color:#000000" %){
--  "parentName": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
--|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
--|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
--|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
--|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
--
--== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST /api/v3/models/find**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):{
--
--(% style="color:#000000" %)  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--(% style="color:#000000" %)Ответ:
--
--(% style="color:#000000" %)[
--  {
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentName": "string",
--    "name": "string",
--    "modelType": 0
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--
--== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
--
--(% class="box successmessage" %)
--(((
--(% lang="en-US" %)**POST /api/v3/models**
--)))
--
--(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--Ответ:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
--|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
--|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
--|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
--|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--
--== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
--)))
--
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
--
--(% style="color:#000000" %)Метод запроса: **PUT**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--Ответ:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true,
--  "extId": "string",
--  "name": "string",
--  "picture": "string",
--  "minspeed": 0,
--  "maxspeed": 0,
--  "width": 0,
--  "imbeddedtrailer": true,
--  "fueloutlay": 0,
--  "hoppercapacity": 0,
--  "hopperdischargespeed": 0,
--  "modelType": 0
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
--|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
--|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
--|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
--|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
--|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
--|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
--|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
--|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
--
--== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
--
--(% class="box errormessage" %)
--(((
--(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
--)))
--
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
--
--(% style="color:#000000" %)Метод запроса: **DELETE**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
--
--(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ: В случае успеха **Success 200**
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -992,7 +992,7 @@
  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
@@ -1000,9 +1000,9 @@
  (% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
--(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
++(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -1016,148 +1016,20 @@
      "deviceTypeId": , ~/~/ ID типа устройства
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
--    "sim2": "", ~/~/ Номер SIM2
--
--    "parentId": "", ~/~/ ID клиента-родителя
--    "parentName": "", ~/~/ Наименование клиента-родителя
--    "modelId": "", ~/~/ ID модели объекта
--    "modelName": "", ~/~/ Имя модели объекта
--
--    "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
--    "unitName": "string", ~/~/ Наименование подразделения
--    "status": 0, ~/~/ Статус объекта
--
--    "createdAt": "", ~/~/ Дата создания объекта
++    "parentId": "", Номер SIM2
++    "parentName": "", Наименование клиента-родителя
++    "modelId": "", ID модели объекта
++    "modelName": "", Имя модели объекта
++    "createdAt": "", Дата создания объекта
++    "mileageCalcMethod": "", Выбранный метод расчета пробега
++    "counters": { ~/~/ Нормы
++        "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
++        "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
++        "mileage": "", ~/~/ Пробег по нормам в метрах
++        "motohours": "" ~/~/ Моточасы по нормам, в секундах
++        "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
++        "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
      },
--
--"customFields": [ ~/~/ Произвольные поля
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
--      "name": "string", ~/~/ Имя поля
--      "value": "string", ~/~/ Значение поля
--      "forClient": true, ~/~/ Не используемая функция
--      "forTooltip": true, ~/~/ Отображать в подсказке
--      "forReport": true ~/~/ Отображать в отчете
--    }
--
--], ~/~/ Данные с вкладки нормы
--    "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
--    "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
--    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
--    "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
--    "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
--     "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
--     "consumptionPer100KmSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
--     "consumptionPer100KmSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
--     "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
--     "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
--     "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
--  "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
--  "mileageCoeff": 0, ~/~/ коэффициент пробега
--  "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
--  "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
--  "counters": { ~/~/ Счетчики
--    "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
--    "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
--    "mileage": 0, ~/~/ Текущий пробег
--    "motohours": 0, ~/~/ Текущие моточасы
--    "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
--    "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
--  },
--
--"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
--    "id": "string", ~/~/ ID объекта
--    "enabled": true, ~/~/ Включить, true - активна, false - не активна
--    "host": "string", ~/~/ CMSV6 Web Host
--    "login": "string", ~/~/ CMSV6 Account
--    "password": "string" ~/~/ CMSV6 Password
--  },
--
--"commandTemplates": [ ~/~/ Шаблоны команд
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
--      "name": "string", ~/~/ Наименование команды
--      "command": "string", ~/~/ Текст команды
--      "retries": 0 ~/~/ Количество попыток
--    }
--  ],
--
--   "sensors": [ ~/~/ Датчики
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
--      "gradesTables": [ ~/~/ Массив таблиц тарировки
--        {
--          "grades": [ ~/~/ Таблица тарировки 1
--            {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
--            }
--          ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
--        }
--      ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
--      "expr": "string", ~/~/ Формула
--      "children": [ ~/~/ массив дочерних датчиков
--        "string"
--      ],
--      "customParams": { ~/~/ прочие произвольные параметры
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      },
--
--~/~/ Характерные для произвольного:
--
--~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
--
--~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
--
--~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
--
--~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
--
--~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
--
--~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
--
--~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
--
--~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
--
--~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
--
--~/~/ "ValueOn": "Вкл.",
--
--~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Макс. значение
--    }
--
--    "drivers": [ ~/~/ Водители
--          {
--         "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--         "name": "string", ~/~/ Наименование
--         "description": "string",
--         "isDefault": true ~/~/ По умолчанию
--          }
--    ],
--
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1173,17 +1173,7 @@
              "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
--    ],
--
-- "statusHistory": [ ~/~/ История статусов
--    {
--      "status": 0,
--      "date": "2023-05-22T09:57:39.562Z",
--      "description": "string",
--      "additionalInfo": "string"
--    }
--  ]
--
++    ]
  }
  )))
@@ -1200,7 +1200,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -1232,11 +1232,6 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
--     "mileageCalcMethod": 0,
--     "mileageCoeff": 0,
--     "locationByCellId": true,
--     "dottedLineTrackWhenNoCoords": true,
       "counters":  ~/~/ счетчики
        {
       "mileage": "" ,  ~/~/ пробег
@@ -1266,98 +1266,8 @@
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
--"drivers": [ ~/~/ Водители
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "isDefault": true
--    }
--  ],
--  "commandTemplates": [ ~/~/ Шаблон команды
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "command": "string",
--      "retries": 0
--    }
--  ],
++(% style="color:#000000" %) }
-- "sensors": [ ~/~/ Датчики
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
--      "gradesTables": [ ~/~/ Массив таблиц тарировки
--        {
--          "grades": [ ~/~/ Таблица тарировки 1
--            {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
--            }
--          ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
--        }
--      ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
--      "expr": "string", ~/~/ Формула
--      "children": [ ~/~/ массив дочерних датчиков
--        "string"
--      ],
--      "customParams": { ~/~/ прочие произвольные параметры
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      },
--
--~/~/ Характерные для произвольного:
--
--~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
--
--~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
--
--~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
--
--~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
--
--~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
--
--~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
--
--~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
--
--~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
--
--~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
--
--~/~/ "ValueOn": "Вкл.",
--
--~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Макс. значение
--    }
--  ],
--  "customFields": [ ~/~/ Произвольные поля
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "value": "string",
--      "forClient": true,
--      "forTooltip": true,
--      "forReport": true
--    }
--  ]
--}
--
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
@@ -1417,7 +1417,7 @@
  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
++(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -1497,7 +1497,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -1543,7 +1543,7 @@
  (% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
++(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1553,16 +1553,18 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
--    "vehicleId": , ~/~/ ID объекта
--    "parentId": "" ,  ~/~/ ID клиента
--    "name": "" ,  ~/~/ имя ТС
--    "imei": "" ,  ~/~/ IMEI
--    "deviceTypeId": "" ,  ~/~/ ID типа устройства
--    "modelId": "" , ~/~/ ID модели
--    "unitId": "" ,  ~/~/ ID подразделения
--    "sim1": "" ,  ~/~/ Номер SIM 1
--    "sim2": "" ,  ~/~/ Номер SIM2
++(% style="color:#000000" %){
++
++(((
++(% style="color:#000000" %)    "vehicleId": "", ~/~/ ID ТС
++    "parentId": "", ~/~/ ID клиента
++    "name": "", ~/~/ имя ТС
++    "imei": "", ~/~/ IMEI
++    "deviceTypeId": "", ~/~/ ID типа устройства
++    "modelId": "", ~/~/ , ID модели
++    "unitId": "", ~/~/ подразделения
++    "sim1": "", ~/~/ SIM 1
++    "sim2": "", ~/~/ SIM2     (%%)
      "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
      "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
      "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
@@ -1575,132 +1575,39 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
++(% style="color:#000000" %)         "counters":
++        {
++         "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
++         "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
++         "mileage": "", ~/~/ пробег, в метрах
++         "motohours": "" ~/~/ моточасы, в секундах
++        }
++        "cmsv6Parameters": ~/~/  параметры CMSv6
++        {
++        "id": "", ~/~/ идентификатор
++        "enabled": true, ~/~/ флаг включения
++        "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
++        "login": "", ~/~/ имя учетной записи
++        "password": "", ~/~/ пароль учетной записи
++        }
++            "inspectionTasks": ~/~/ задания на ТО
++        {
++            "id": "", ~/~/ ID задания
++            "enabled": false, ~/~/ Признак включения
++            "name": "", ~/~/ Имя задания
++            "description": "", ~/~/ Описание задания
++            "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
++            "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
++            "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
++            "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
++            "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
++            "kind": "", ~/~/ Вид периодичности по времени
++            "maxQuantity": "", ~/~/ Сколько раз выполнить задание
++            }
++)))
--     "mileageCalcMethod": 0,
--     "mileageCoeff": 0,
--     "locationByCellId": true,
--     "dottedLineTrackWhenNoCoords": true,
--     "counters":  ~/~/ счетчики
--      {
--     "mileage": "" ,  ~/~/ пробег
--     "mileageEnabled": true,  ~/~/ флаг активности счётчика "пробег"
--     "motohours": "" ,  ~/~/ моточасы
--     "motohoursEnabled": true  ~/~/ флаг активности счётчика "моточасы"
--      },
--    "cmsv6Parameters": { ~/~/ параметры CMSv6
--      "enabled": true,  ~/~/ флаг включения
--      "id": "" ,  ~/~/ идентификатор
--      "host": "" ,  ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
--      "login": "" ,  ~/~/ имя учетной записи
--      "password": ""   ~/~/ пароль учетной записи
--      },
--    "inspectionTasks":  ~/~/ задания на ТО
--      {
--      "enabled": "" ,  ~/~/ Признак включения
--      "name": "" ,  ~/~/ Имя задания
--      "description": "" ,  ~/~/ Описание задания
--      "mileageCondition": "" ,  ~/~/ Условие по пробегу (в метрах, null - условие не работает)
--      "lastMileage": "" ,  ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
--      "motohoursCondition": "" ,  ~/~/ Условие по моточасам (в секундах, null - условие не работает)
--      "lastMotohours": "" ,  ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
--      "periodicCondition": "" ,  ~/~/  Условие периодичности по времени (null - условие не работает)
--      "kind": "" ,  ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
--      "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
--      "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
--      }
++(% style="color:#000000" %)}
--"drivers": [ ~/~/ Водители
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "isDefault": true
--    }
--  ],
--  "commandTemplates": [ ~/~/ Шаблон команды
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "command": "string",
--      "retries": 0
--    }
--  ],
--
-- "sensors": [ ~/~/ Датчики
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
--      "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
--      "type": 0, ~/~/ Тип датчика
--      "name": "string", ~/~/ Имя датчика
--      "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
--      "inputNumber": 0, ~/~/ Номер входа
--      "pseudonym": "string", ~/~/ Псевдоним
--      "medianDegree": 0, ~/~/ Медианная фильтрация
--      "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
--      "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
--      "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
--      "gradesTables": [ ~/~/ Массив таблиц тарировки
--        {
--          "grades": [ ~/~/ Таблица тарировки 1
--            {
--              "input": 0, ~/~/ Входящее значение
--              "output": 0 ~/~/ Выходящее значение
--            }
--          ],
--          "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
--        }
--      ],
--      "showInTooltip": true, ~/~/ Отображать в подсказке
--      "showLastValid": true, ~/~/ Отображать последнее валидное значение
--      "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
--      "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
--      "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
--      "expr": "string", ~/~/ Формула
--      "children": [ ~/~/ массив дочерних датчиков
--        "string"
--      ],
--      "customParams": { ~/~/ прочие произвольные параметры
--        "additionalProp1": "string",
--        "additionalProp2": "string",
--        "additionalProp3": "string"
--      },
--
--~/~/ Характерные для произвольного:
--
--~/~/                "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
--
--~/~/                "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
--
--~/~/                "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
--
--~/~/                "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
--
--~/~/               "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
--
--~/~/                "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
--
--~/~/               "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
--
--~/~/                "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
--
--~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
--
--~/~/ "ValueOn": "Вкл.",
--
--~/~/ "ValueOff": "Выкл."
--      "summaryMaxValue": 0 ~/~/ Макс. значение
--    }
--  ],
--  "customFields": [ ~/~/ Произвольные поля
--    {
--      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "name": "string",
--      "value": "string",
--      "forClient": true,
--      "forTooltip": true,
--      "forReport": true
--    }
--  ]
--}
--
  (% style="color:#000000" %)Ответ:
  (% lang="en-US" style="text-align:left" %)
@@ -1751,7 +1751,7 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--**Валидация:**
++**валидация:**
  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
@@ -1763,7 +1763,7 @@
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
++(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1785,7 +1785,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1812,7 +1812,7 @@
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
++(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1841,7 +1841,7 @@
  )))
  (% style="text-align: left;" %)
--Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="text-align: left;" %)
  Метод запроса **POST**
@@ -1879,7 +1879,7 @@
  **POST /api/v3/terminalMessages**
  )))
--Метод возвращает список сообщений терминала объекта за выбранный период.
++Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="text-align: left;" %)
  Метод запроса **POST**
@@ -1921,1921 +1921,7 @@
    }
  ]
--= (% 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/vehicles/mileageAndMotohours**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
--  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя ТС
--    "periods": [ ~/~/ Периоды
--      {
--        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
--        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "mileageBegin": 0, ~/~/ Пробег на начало периода
--        "mileageEnd": 0, ~/~/ Пробег на окончание периода
--        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
--        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
--      }
--    ]
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
--  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя ТС
--    "periods": [ ~/~/ Периоды
--      {
--        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
--        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
--        "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
--        "fuelConsumption": 0, ~/~/ Расход топлива
--        "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
--      }
--    ]
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
--)))
--
--(% style="color:#000000" %)Метод запроса: **POST**
--
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--Тело запроса:
--
--{
--  "vehicleIds": [0], ~/~/ Список ID объектов
--  "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
--  "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
--  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
--}
--
--Ответ:
--
--[
--  {
--    "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
--    "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
--    "vehicleId": 0, ~/~/ ID объекта
--    "name": "string", ~/~/ Имя объекта
--    "model": "string", ~/~/ Модель объекта
--    "fuels": [ ~/~/ Массив данным по заправкам и сливам
--      {
--        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
--        "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
--        "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
--        "valueFuel": 0, ~/~/ Количество
--        "fuelStart": 0, ~/~/ Уровень топлива на начало события
--        "fuelEnd": 0 ~/~/ Уровень топливо на конец события
--      }
--    ]
--  }
--]
--
--= (% 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: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/{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" %)}
--
--== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/notifications/**
--)))
--
--Метод позволяет отредактировать уведомление.
--
--Метод запроса **PUT**
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Тело запроса:
--{
-- "id": 0, ~/~/ id уведомления
--  "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
--  "userId": "", ~/~/ Пользователь, создавший уведомление
--  "parentId": "", ~/~/ Идентификатор клиента
--  "parentName": "string", ~/~/ Имя клиента
--  "name": "string", ~/~/ Название уведомления
--  "active": true, ~/~/ Состояние true - активен, false - деактивирован
--  "vehicleIds": [ ~/~/ Список id объектов для анализа
--    0
--  ],
--   "geoids": [ ~/~/ Список id геообъектов для анализа
--    0
--  ],
--  "fieldids": [ ~/~/ Список id полей для анализа
--    0
--  ],
--  "settings": { ~/~/ Список параметров уведомления
--    "additionalProp1": "string",
--    "additionalProp2": "string",
--    "additionalProp3": "string"
--  },
--  "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
--  "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
--    ""
--  ],
--  "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
--  "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
--    "string"
--  ],
--  "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
--  "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
--    {
--      "id": 0, ~/~/ Идентификатор участника чата
--      "info": "string" ~/~/ Дополнительные сведения
--    }
--  ],
--  "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
--  "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
--  "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
--  "kind": 0, ~/~/ Определяет вид уведомления
--  "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
--  "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
--  "timezone": 0, ~/~/ Сдвиг часового пояса
--  "validity": 0, ~/~/ Срок действия в днях (1-90)
--  "autoProlongation": true ~/~/ Автопродление срока действия
--}
--
--Ответ:
--
--Success
--
--== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/notifications/{id}**
--)))
--
--Метод позволяет удалить выбранное уведомление.
--
--Метод запроса **DELETE**
--
--URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
--
--Передаваемый параметр: {id} - id уведомления
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Drivers/find**
--)))
--
--Передается параметр: parentId - ID клиента-родителя
--
--Ответ:
--
--[
--  {
--    "name": "string", ~/~/ Определяет наименование
--    "description": "string", ~/~/ Определяет описание
--    "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
--    "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
--    "exclusive": true, ~/~/ Определяет признак "Исключительный"
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
--    "deleted": true ~/~/ Признак удаления
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Drivers/{driverGuid}**
--)))
--
--Передается параметр: ID водителя
--
--Ответ:
--
--{
--  "name": "string", ~/~/ Определяет наименование
--  "description": "string", ~/~/ Определяет описание
--  "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
--  "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
--  "exclusive": true, ~/~/ Определяет признак "Исключительный"
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
--  "deleted": true ~/~/ Признак удаления
--}
--
--== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Drivers**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:54.020Z",
--  "chopdate": "2023-06-30T12:50:54.020Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:54.051Z",
--  "chopdate": "2023-06-30T12:50:54.051Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Drivers**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:27.910Z",
--  "chopdate": "2023-06-30T12:50:27.910Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "description": "string",
--  "hiredate": "2023-06-30T12:50:27.929Z",
--  "chopdate": "2023-06-30T12:50:27.929Z",
--  "exclusive": true,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
--}
--
--
--== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/Drivers/{driverGuid}**
--)))
--
--Передается параметр: ID водителя
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:49:04.365Z",
--  "EndTime": "2023-06-30T12:49:04.365Z"
--}
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T09:52:31.240Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T09:52:31.240Z",
--    "EndTime": "2023-06-30T09:52:31.240Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    0
--  ],
--  "BeginTime": "2023-06-30T12:48:39.419Z",
--  "EndTime": "2023-06-30T12:48:39.419Z"
--}
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T09:54:01.631Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T09:54:01.631Z",
--    "EndTime": "2023-06-30T09:54:01.631Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversVehiclesAssignments**
--)))
--
--Передается массив назначений
--
--Запрос:
--
--[
--  {
--    "VehicleId": 0, ~/~/ Идентификатор объекта
--    "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
--    "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
--  }
--]
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:04:46.903Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:04:46.903Z",
--    "EndTime": "2023-06-30T11:04:46.903Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversVehiclesAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:14:08.117Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:14:08.117Z",
--    "EndTime": "2023-06-30T11:14:08.117Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "VehicleId": 0,
--    "CreateTime": "2023-06-30T11:14:53.349Z",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:14:53.349Z",
--    "EndTime": "2023-06-30T11:14:53.349Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversVehiclesAssignments**
--)))
--
--Запрос:
--
--[
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--]
--
--Ответ:
--
--Success
--
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:47:12.162Z",
--  "EndTime": "2023-06-30T12:47:12.162Z"
--}
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:19:40.703Z",
--    "EndTime": "2023-06-30T11:19:40.703Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments/GetByRfids**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:47:12.162Z",
--  "EndTime": "2023-06-30T12:47:12.162Z"
--}
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
--    "BeginTime": "2023-06-30T11:19:40.703Z",
--    "EndTime": "2023-06-30T11:19:40.703Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:27:08.635Z",
--    "EndTime": "2023-06-30T11:27:08.635Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:27:08.677Z",
--    "EndTime": "2023-06-30T11:27:08.677Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:28:43.330Z",
--    "EndTime": "2023-06-30T11:28:43.330Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:28:43.331Z",
--    "EndTime": "2023-06-30T11:28:43.331Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversRfidsAssignments**
--)))
--
--Запрос:
--
--[
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--]
--
--Ответ:
--
--Success
--
--
--== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:45:10.852Z",
--  "EndTime": "2023-06-30T12:45:10.852Z"
--}
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:58:04.695Z",
--    "EndTime": "2023-06-30T11:58:04.695Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
--)))
--
--Запрос:
--
--{
--  "Ids": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--  ],
--  "BeginTime": "2023-06-30T12:45:10.852Z",
--  "EndTime": "2023-06-30T12:45:10.852Z"
--}
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T11:58:04.695Z",
--    "EndTime": "2023-06-30T11:58:04.695Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.175Z",
--    "EndTime": "2023-06-30T12:09:53.175Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--Ответ:
--
--[
--  {
--    "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "BeginTime": "2023-06-30T12:09:53.201Z",
--    "EndTime": "2023-06-30T12:09:53.201Z"
--  }
--]
--
--
--=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/DriversFuelCardsAssignments**
--)))
--
--Запрос:
--
--[
--  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--]
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Trailers**
--)))
--
--Пример запроса:
--
--{
--  "startDate": "2023-11-14T10:48:03.671Z",
--  "endDate": "2023-11-14T10:48:03.671Z",
--  "ids": [ 0 ],
--  "timezone": 0
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
--|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
--|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
--|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
--
--Пример ответа:
--
--[
--  {
--    "SD": "2023-11-14T10:48:03.717Z",
--    "ED": "2023-11-14T10:48:03.717Z",
--     "id": 0,
--    "SLat": 0,
--    "SLon": 0,
--    "ELat": 0,
--    "ELon": 0,
--    "mileage": 0
--    "Duration": 0
--    "Address": "string",
--    "Address2": "string",
--    "name": "string",
--    "rid": "string",
--    "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "trailer": {
--      "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "Number": "string",
--      "Description": "string",
--      "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "ExternalID": "string",
--      "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "CreateTime": "2023-11-14T10:48:03.717Z",
--      "UpdateTime": "2023-11-14T10:48:03.717Z",
--      "IsDeleted": true
--    },
--    "filesCount": 0,
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|SD|Дата и время начала события
--|ED|Дата и время окончания события
--|id|ID объекта
--|SLat|Широта начальной координаты
--|SLon|Долгота начальной координаты
--|ELat|Широта конечной координаты
--|ELon|Долгота конечной координаты
--|mileage|Пробег
--|Duration|Продолжительность
--|Address|Адрес начального местоположения
--|Address2|Адрес конечного местоположения
--|name|Имя радиометки
--|rid|Номер радиометки
--|rguid|ID радиометки
--|trailer|Информация об агрегате
--|ModelGuid|ID агрегата
--|Number|Название/номер агрегата
--|Description|Текст примечания агрегата
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/Rfids/find**
--)))
--
--Запрос:
--
--{
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--}
--
--Ответ:
--
--[
--  {
--    "name": "string",
--    "number": 0,
--    "period": 0,
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|parentId|ID клиента
--|name|Название карты-метки
--|number|Номер
--|period|Период запросов в секундах (работает только для агрегатов)
--|id|ID карты-метки
--
--== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Rfids/{rfidGuid}**
--)))
--
--Передаем параметр rfidGuid - идентификатор карты-метки
--
--Ответ:
--
--[
--  {
--    "name": "string",
--    "number": 0,
--    "period": 0,
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|name|Название карты-метки
--|number|Номер
--|period|Период запросов в секундах (работает только для агрегатов)
--|id|ID карты-метки
--|parentId|ID клиента
--
--== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/Rfids**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|name|Название карты-метки
--|number|Номер
--|period|Период запросов в секундах (работает только для агрегатов)
--|id|ID карты-метки
--|parentId|ID клиента
--
--== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Rfids**
--)))
--
--Запрос:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--}
--
--Ответ:
--
--{
--  "name": "string",
--  "number": 0,
--  "period": 0,
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|name|Название карты-метки
--|number|Номер
--|period|Период запросов в секундах (работает только для агрегатов)
--|id|ID карты-метки
--|parentId|ID клиента
--
--== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/Rfids/{rfidGuid}**
--)))
--
--Передаем параметр **rfidGuid** - идентификатор карты-метки
--
--Ответ:
--
--Success
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Billing/client/balance/{clientId}**
--)))
--
--Параметр запроса: **clientId **- идентификатор клиента.
--
--Ответ:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
--== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Billing/client/constraint/{clientId}**
--)))
--
--Параметр запроса: **clientId **- идентификатор клиента.
--
--Ответ:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "CalculationType": 0,
--  "PermissibleBalance": 0,
--  "DefermentDays": 0,
--  "SendUiNotifications": true,
--  "SendEmailNotifications": true,
--  "IsPrivate": true,
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
--|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
--|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
--|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
--|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
--
--== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Billing/client/plan/{clientId}**
--)))
--
--Параметры запроса:
--
--**clientId **- идентификатор клиента.
--
--**planId **- идентификатор тарифного плана.
--
--Ответ:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Plan": { **~/~/ Описание тарифного плана**
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Name": "string",
--    "IsArchived": true,
--    "Constraint": {
--      "CalculationType": 0,
--      "PermissibleBalance": 0,
--      "DefermentDays": 0
--    },
--    "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
--      {
--        "Feature": "string",
--        "IsFactual": true,
--        "Limit": 0,
--        "Price": 0,
--        "PeriodValue": 0,
--        "PeriodType": 0
--      }
--    ]
--  },
--  "DebitDate": "2023-10-18T12:46:24.213Z",
--  "Features": [ **~/~/ Описание услуг тарифного плана как есть**
--    {
--      "Feature": "string",
--      "IsEnabled": true,
--      "IsPrivate": true,
--      "IsFactual": true,
--      "Limit": 0,
--      "Price": 0,
--      "DebitDate": "2023-10-18T12:46:24.213Z",
--      "PeriodValue": 0,
--      "PeriodType": 0
--    }
--  ]
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|Id|Идентификатор тарифного плана
--|OwnerId|Идентификатор клиента-владельца
--|Name|Наименование тарифного плана
--|IsArchived|Признак, определяющий архивный тарифный план
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|Отсрочка, количество дней
--|Feature|Код услуги
--|IsEnabled|Признак, определяющий активирована ли услуга
--|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|DebitDate|Следующий момент времени списания с баланса за услугу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
--
--== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
--)))
--
--Параметр запроса: **clientId **- идентификатор клиента.
--
--Ответ:
--
--[
--  {
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Name": "string",
--    "IsArchived": true,
--    "Constraint": {
--      "CalculationType": 0,
--      "PermissibleBalance": 0,
--      "DefermentDays": 0
--    },
--    "Features": [
--      {
--        "Feature": "string",
--        "IsFactual": true,
--        "Limit": 0,
--        "Price": 0,
--        "PeriodValue": 0,
--        "PeriodType": 0
--      }
--    ]
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|Id|Идентификатор тарифного плана
--|OwnerId|Идентификатор клиента-владельца
--|Name|Наименование тарифного плана
--|IsArchived|Признак, определяющий архивный тарифный план
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|Отсрочка, количество дней
--|Feature|Код услуги
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
--
--== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
--)))
--
--Параметр запроса: **clientId **- идентификатор клиента.
--
--Ответ:
--
--[
--  {
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--    "Name": "string",
--    "IsArchived": true,
--    "Constraint": {
--      "CalculationType": 0,
--      "PermissibleBalance": 0,
--      "DefermentDays": 0
--    },
--    "Features": [
--      {
--        "Feature": "string",
--        "IsFactual": true,
--        "Limit": 0,
--        "Price": 0,
--        "PeriodValue": 0,
--        "PeriodType": 0
--      }
--    ]
--  }
--]
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|Id|Идентификатор тарифного плана
--|OwnerId|Идентификатор клиента-владельца
--|Name|Наименование тарифного плана
--|IsArchived|Признак, определяющий архивный тарифный план
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|Отсрочка, количество дней
--|Feature|Код услуги
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
--
--== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Billing/client/balance**
--)))
--
--Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
--
--Тело запроса:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
--}
--
--Ответ: Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
--== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/billing/client/balance/deposit**
--)))
--
--Создает операцию **Пополнение **с указанной суммой
--
--Тело запроса:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
--}
--
--Ответ: Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
--== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
--
--Создает операцию **Списание **с указанной суммой
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/billing/client/balance/withdraw**
--)))
--
--Тело запроса:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Balance": 0
--}
--
--Ответ: Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
--|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
--
--== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Billing/client/constraint**
--)))
--
--Тело запроса:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "CalculationType": 0,
--  "PermissibleBalance": 0,
--  "DefermentDays": 0,
--  "SendUiNotifications": true,
--  "SendEmailNotifications": true,
--  "IsPrivate": true,
--}
--
--Ответ: Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
--|PermissibleBalance|Допустимый баланс
--|DefermentDays|(((
--Отсрочка, количество дней
--)))
--|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
--|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
--|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
--
--== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/Billing/client/plan**
--)))
--
--Тело запроса:
--
--{
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "Features": [
--    {
--      "Feature": "string",
--      "IsEnabled": true,
--      "IsFactual": true,
--      "Limit": 0,
--      "Price": 0,
--      "DebitDate": "2023-10-18T13:26:58.987Z",
--      "PeriodValue": 0,
--      "PeriodType": 0
--    }
--  ]
--}
--
--Ответ: Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|ClientId|Идентификатор клиента
--|PlanId|Идентификатор тарифного плана
--|Feature|Код услуги
--|IsEnabled|Признак, определяющий активирована ли услуга
--|IsFactual|Признак, определяющий расчёт по факту
--|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--|Price|Цена за единицу.
--|DebitDate|Следующий момент времени списания с баланса за услугу.
--|PeriodValue|Значение периода.
--|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
--
--(% class="box warningmessage" %)
--(((
--Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
--)))
--
--== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/import/{agentId}**
--)))
--
--Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
--
--В пути указывается **agentId** - id клиента.
--
--**Заголовок**
--
--**X-Auth: [токен авторизации]**
--
--**Параметры**
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
--|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
--
--В теле использовать тип **form-data,** тип значения** file**
--
--**Ключи**
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|data|В значении передаем файл объекта, формат **xml** или **wlp **
--|csv|В значении передаем файл датчиков, формат **csv**
--
--Ответ:
--
--{
--  "vehicleId": 0,
--  "name": "string",
--  "errors": ["string"]
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|vehicleId|ID созданного объекта
--|name|Имя созданного объекта
--|errors|Ошибки и их описание
--
--(% style="color:#000000; font-size:16px" %)**Импорт сообщений**
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/import/history/{vehicleId}**
--)))
--
--(% class="wikigeneratedid" %)
--Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
--
--(% class="wikigeneratedid" %)
--В пути указывается **vehicleId **- id объекта.
--
--**Заголовок**
--
--**X-Auth: [токен авторизации]**
--
--В теле использовать тип **form-data.**
--
--Ключи:
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|**history**|В значении передавать файл с историей
--
--В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
--
--Ответ:
--
--{
--  "results": [
--    {
--      "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--      "vehicleId": 0,
--      "errors": [
--        "string"
--      ],
--      "firstMessageDate": "2023-11-28T09:27:58.949Z",
--      "lastMessageDate": "2023-11-28T09:27:58.949Z",
--      "producedCount": 0,
--      "msgCount": 0
--    }
--  ]
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|results|Результаты импорта в разрезе ТС
--|vehicleGuid|Guid ТС
--|vehicleId|ID ТС
--|errors|Список ошибок импорта истории (если пустой - нет ошибок)
--|firstMessageDate|Дата первого импортированного сообщения (UTC)
--|lastMessageDate|Дата последнего импортированного сообщения (UTC)
--|producedCount|Кол-во успешно отправленных в шину данных сообщений
--|msgCount|Кол-во обработанных сообщений всего
--
--== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/import/history/status**
--)))
--
--Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
--
--Ответ:
--
--{
--  "activity": true,
--  "progress": 0,
--  "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="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export**
--)))
--
--Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
--
--Тело запроса:
--
--[
--  id
--]
--
--Ответ: Success 200, получаете файлы с настройками.
--
--== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export/history**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--Тело запроса:
--
--{
--  "vehicleId": 0,
--  "asArchive": true,
--  "from": "2023-09-27T12:17:45.973Z",
--  "to": "2023-09-27T12:17:45.973Z"
--}
--
--Ответ:
--
--Получаете файл. Сообщение: Code 200/Success
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|vehicleId|ID объекта
--|asArchive|true - Архивировать файл, False - не архивировать
--|from|Дата и время начала запроса
--|to|Дата и время окончания запроса
--
--== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/export/history/status**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--Ответ:
--
--{
--  "activity": true,
--  "progress": 0,
--  "message": "string"
--}
--
--|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
--|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
--|progress|Прогресс экспорта, от 0 до 100%
--|message|Текст описывающий статус
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/EcoDriving/rating**
--)))
--
--Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
--
--Тело запроса:
--
--{
--  "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": [
--    {
--      "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": [
--        {
--          "penalty": 0,
--          "score": 0,
--          "violationsCount": 0,
--          "violationsByType": {
--            "overspeedingViolations": 0,
--            "accelerationViolations": 0,
--            "brakingViolations": 0,
--            "turningViolations": 0,
--            "dangerousDrivingViolations": 0,
--            "sensorViolations": 0
--          },
--          "moveTime": 0,
--          "mileage": 0,
--          "motohours": 0,
--          "maxSpeed": 0,
--          "startAddress": "string",
--          "endAddress": "string",
--          "drivers": [
--            {
--              "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--              "driverName": "string",
--              "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
--            }
--          ]
--        }
--      ]
--    }
--  ]
--}
--
--|=(% 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|Номер Карты-метки
--
  (% 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]] **

image-20231020124453-1.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.krainovim

Size

...	...	@@ -1,1 +1,0 @@
1		-268.0 KB

Content

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

Summary

Details

Меню