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

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 109.1 >

edited by Илья Крайнов
on 2023/10/17 11:01

To version < 177.1 >

edited by Михаил Жучков
on 2024/10/29 08:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

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

Content

@@ -14,13 +14,22 @@
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++
++(% style="color:#000000; font-size:16px" %)**Рекомендации**
++
++- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
++(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
++(((
++(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
++(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
++)))
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
  (% 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,21 +40,25 @@
      "password": "testuser"
  }
--
  (% style="color:#000000" %)**Ответ:**
  (% lang="en-US" %)
  (% style="color:#000000" %){
--
--(% lang="en-US" %)
--(% style="color:#000000" %)    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
--    "User": "testuser" ,  ~/~/ имя пользователя
--
--(% lang="en-US" %)
++    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
++    "User": "testuser" ,  ~/~/ имя пользователя(%%)
  }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
++|=(% 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" %)Логин пользователя
++
++(% class="wikigeneratedid" %)
++Также  имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] /  [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации -  {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
++
  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
@@ -93,30 +93,51 @@
  Запрос должен содержать данные параметра "**agentId**"
  (% style="color:#000000" %)Ответ:
--А
  {
--    "agentId": "", ~/~/ идентификатор клиента    (%%)
--    "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
--    "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
--    "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
--    "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
--    "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
--    "isForeign": true/false, ~/~/ Иностранный контрагент
--    "district": "string", ~/~/ округ
--    "region": "string", ~/~/ регион
--    "city": "string", ~/~/ город
--    "inn": "string", ~/~/ ИНН клиента
--    "kpp": "string", ~/~/ КПП клиента
--    "address": "string", ~/~/ юридический адрес
--    "addressFact": "string", ~/~/ фактический адрес
--    "email": "string", ~/~/ почта
--    "director": "string", ~/~/ ФИО руководителя
--    "bankName": "string", ~/~/ Банк
--    "bankBIK": "string", ~/~/ БИК
--    "bankRS": "string", ~/~/ Номер счета
--    "bankKS": "string" ~/~/ Корр. счет
++    "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"
    }
++|=(% 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" %)
@@ -130,7 +130,7 @@
  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
--(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
++(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -145,15 +145,23 @@
  (% style="color:#000000" %)Ответ:
  {
--    "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 - Отказ)
++    "agentId": "",(% style="color:#000000" %)   (%%)
++    "parentId": "",
++    "name": "string",
++    "fullName": "string",
++    "agentInfoType": 0,
++(% style="color:#000000" %)    "status": "",
  }
++
++|=(% 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" %)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" %)
@@ -172,7 +172,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 - Договор)(%%)
@@ -192,7 +192,6 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
--
  Ответ:
  {
@@ -217,6 +217,28 @@
    "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" %)
@@ -232,7 +232,6 @@
  В заголовках запроса: X-Auth: Токен авторизации
--
  Параметры в теле запроса (JSON):
  {
@@ -257,7 +257,6 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
--
  Ответ:
  {
@@ -300,6 +300,21 @@
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/agents/{id}/changeStatus/{status}**
++)))
++
++Метод позволяет изменить статус клиента, указанного в запросе.
++
++В пути указывается GUID клиента и статус клиента.
++
++**status **- значение 0 - заблокирован, 1 - активен.
++
++Ответ: Code 204
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
@@ -351,7 +351,6 @@
      ],
      "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
  }
--
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastName": "string",
@@ -363,15 +363,10 @@
    "password": "string",
    "email": "string",
--
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
--
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %){
--
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
++{
++    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ Фамилия ,
      "firstName": "" ,  ~/~/ Имя
      "position": "" ,  ~/~/ Должность
@@ -388,9 +388,8 @@
      "kind": "" ,  ~/~/ тип аутентификации
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %),  ~/~/ роли пользователя, перечислены названия групп пользователя
++}
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
@@ -411,19 +411,16 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
    "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303",  ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
    "userId": "11111111-c384-43f8-8562-1c3d79a32303",  ~/~/ ID пользователя, по которому фильтруется, null - неважно
    "login": "qqqqqq",  ~/~/ Логин пользователя, по которому фильтруется, null - неважно
    "email": "eee",  ~/~/ Email пользователя, по которому фильтруется, null - неважно
--
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){         (%%)
--
      "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
@@ -437,7 +437,6 @@
      "sessionDuration":"", ~/~/ длительность сессии в минутах
      "status": "1",  ~/~/ статус пользователя
      "lastLogged": "", ~/~/ дата/время последней авторизации
--
  (% style="color:#000000" %)}
  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
@@ -511,10 +511,8 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++    "id": "" ,  ~/~/ ID пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -536,9 +536,7 @@
          "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
      },
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
--    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
--
--(% lang="en-US" style="text-align:left" %)
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя(%%)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
  (% lang="en-US" style="text-align:left" %)
@@ -545,10 +545,8 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++    "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -569,10 +569,8 @@
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
++}
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--
  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
  (% class="box warningmessage" %)
@@ -592,12 +592,10 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "status": "" ,  ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
      "description": "" ,  ~/~/ описание
      "data": "" ,  ~/~/ данные, связанные со сменой статуса
--
  (% style="color:#000000" %)}
  (% style="text-align:left" %)
@@ -619,7 +619,7 @@
  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
   [
--    "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
++   "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
      "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
    ]
@@ -711,7 +711,6 @@
    "maxspeed": 0,
    "width": 0,
    "imbeddedtrailer": true,
--  "fueloutlay": 0,
    "hoppercapacity": 0,
    "hopperdischargespeed": 0,
    "modelType": 0,
@@ -720,7 +720,7 @@
    "deleted": true
  }
--|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание
++|=(% 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" %)Название иконки транспорта
@@ -728,9 +728,8 @@
  |(% 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" %)fueloutlay|(% 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" %)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 клиента, которому принадлежит модель объекта
@@ -751,10 +751,9 @@
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
++(% style="color:#000000" %)Параметры в теле запроса (JSON):{
--(% style="color:#000000" %){
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++(% style="color:#000000" %)  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
  (% style="color:#000000" %)Ответ:
@@ -769,6 +769,13 @@
    }
  ]
++|=(% 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" %)
@@ -816,12 +816,25 @@
    "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 warningmessage" %)
@@ -875,6 +875,20 @@
    "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" %)
@@ -894,7 +894,7 @@
  Ответ: В случае успеха **Success 200**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -930,19 +930,15 @@
      "deviceTypeName": "", ~/~/ Название типа устройства
      "sim1": "", ~/~/ Номер SIM1
      "sim2": "", ~/~/ Номер SIM2
--
      "parentId": "", ~/~/ ID клиента-родителя
      "parentName": "", ~/~/ Наименование клиента-родителя
      "modelId": "", ~/~/ ID модели объекта
      "modelName": "", ~/~/ Имя модели объекта
--
      "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
      "unitName": "string", ~/~/ Наименование подразделения
      "status": 0, ~/~/ Статус объекта
--
      "createdAt": "", ~/~/ Дата создания объекта
      },
--
  "customFields": [ ~/~/ Произвольные поля
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
@@ -965,8 +965,7 @@
       "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
++     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
    "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
    "mileageCoeff": 0, ~/~/ коэффициент пробега
    "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
@@ -996,7 +996,6 @@
        "retries": 0 ~/~/ Количество попыток
      }
    ],
--
     "sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
@@ -1037,31 +1037,19 @@
        },
  ~/~/ Характерные для произвольного:
--
  ~/~/                "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",
@@ -1070,7 +1070,6 @@
           "isDefault": true ~/~/ По умолчанию
            }
      ],
--
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
          {
              "id": "", ~/~/ ID  задания
@@ -1087,8 +1087,7 @@
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
          }
      ],
--
-- "statusHistory": [ ~/~/ История статусов
++"statusHistory": [ ~/~/ История статусов
      {
        "status": 0,
        "date": "2023-05-22T09:57:39.562Z",
@@ -1096,7 +1096,6 @@
        "additionalInfo": "string"
      }
    ]
--
  }
  )))
@@ -1106,6 +1106,73 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++
++== **Отправить команду на терминал** ==
++
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
++)))
++
++Команда для отправки на тс.
++
++{
++"id": "",  ~/~/идентификатор произвольного поля
++"command": "", ~/~/  Текст команды
++"retries": "",  ~/~/ Количество попыток
++"idTemplate": "" ~/~/ ID шаблона команды
++}
++
++
++== **Получить ответ на отправленную на ТС команду** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
++)))
++
++Идентификатор команды: cmdid
++
++Запрос от терминала на ответ команды
++
++Пример ответ от терминала:
++
++ID= "" ~/~/ идентификатор произвольного поля
++Soft="" ~/~/ версия софта
++GPS=4 ~/~/ тип трекера
++Time=11:05:43 28.06.24 ~/~/ время запроса
++Lat=45.056221 ~/~/ широта
++Lon=39.035938 ~/~/ долгота
++Speed=0.0 ~/~/ скорость
++Course=181.4 ~/~/направление
++
++(((
++== **Список отправленных объекту команд с ответами** ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
++)))
++
++Идентификатор ТС: vehicleId
++
++В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
++
++Пример ответа терминала
++
++[
++{
++"id": "",  ~/~/ идентификатор пользователя
++"commandText": "",   ~/~/Текст команды.
++"templateId": "",    ~/~/Идентификатор шаблона
++"updated": "",  ~/~/ Время отправки
++"tryCount": 0,  ~/~/ Количество попыток отправки команды
++"answer": "",    ~/~/ Ответ терминала.
++"status": "" ~/~/ Статус отправки
++}
++]
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
  (% class="box successmessage" %)
@@ -1123,8 +1123,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "parentId": "" ,  ~/~/ ID клиента
      "name": "" ,  ~/~/ имя ТС
      "imei": "" ,  ~/~/ IMEI
@@ -1145,7 +1145,6 @@
       "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
       "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
       "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--
       "mileageCalcMethod": 0,
       "mileageCoeff": 0,
       "locationByCellId": true,
@@ -1178,7 +1178,6 @@
        "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
        "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
        }
--
  "drivers": [ ~/~/ Водители
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -1193,8 +1193,7 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++"sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1232,29 +1232,17 @@
          "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 ~/~/ Макс. значение
      }
@@ -1273,8 +1273,7 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "vehicleId": "", ~/~/ID ТС
      "parentId": "", ~/~/Guid владельца ТС
      "name": "", ~/~/Имя объекта
@@ -1312,8 +1312,6 @@
      "kind": "", ~/~/ Вид периодичности по времени
      "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
      }
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)}
  **Валидация:**
@@ -1321,7 +1321,7 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
++== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
  (% class="box infomessage" %)
  (((
@@ -1328,7 +1328,7 @@
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
@@ -1372,8 +1372,7 @@
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
--
--(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
++    "vehicleId": "" ~/~/ идентификатор объекта
      "name": "" ~/~/ наименование объекта
      "imei": "" ~/~/ IMEI объекта
      "deviceTypeId": "" ~/~/ идентификатор типа устройства
@@ -1432,13 +1432,11 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
--
  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
    "status": "", ~/~/ значение статуса
    "date": "", ~/~/ Дата смены статуса
    "description": "", ~/~/ Описание
@@ -1445,10 +1445,10 @@
    "data": "", ~/~/ Данные
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)  }
++==   ==
++
  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
  (% class="box warningmessage" %)
@@ -1536,8 +1536,7 @@
        "retries": 0
      }
    ],
--
-- "sensors": [ ~/~/ Датчики
++"sensors": [ ~/~/ Датчики
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
        "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
@@ -1575,29 +1575,17 @@
          "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 ~/~/ Макс. значение
      }
@@ -1617,9 +1617,7 @@
  (% style="color:#000000" %)Ответ:
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--
--(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     (%%)
      "vehicleId": "", ~/~/ ID ТС
      "parentId": "", ~/~/ ID клиента
      "name": "", ~/~/ имя ТС
@@ -1660,8 +1660,6 @@
          "kind": "", ~/~/ Вид периодичности по времени
          "maxQuantity": "", ~/~/ Сколько раз выполнить задание
          }
--
--(% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
  **Валидация:**
@@ -1702,18 +1702,15 @@
  (% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "deviceTypeId" : "", ~/~/ ID типа устройства
      "deviceTypeName" : "" ~/~/ Название типа устройства
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
@@ -1735,13 +1735,10 @@
  (% style="color:#000000" %)Ответ:
--(% style="color:#000000" %){
--
++(% style="color:#000000" %){(%%)
      "id": "", ~/~/ ID типа датчика
      "name": "", ~/~/ Название
      "description": "", ~/~/ Описание
--
--(% style="text-align:left" %)
  (% style="color:#000000" %)}
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
@@ -1785,6 +1785,56 @@
    }
  ]
++== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/mapping**
++)))
++
++Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "protocolType": 0,
++  "params": ["string"]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|ID типа протокола
++|params|(((
++Массив наименований параметров в сообщении
++)))
++
++Ответ:
++
++{
++  "protocolType": 0,
++  "mapping": {
++    "additionalProp1": {
++      "inputType": 0,
++      "inputNumber": 0
++    },
++    "additionalProp2": {
++      "inputType": 0,
++      "inputNumber": 0
++    }
++  }
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|protocolType|Тип протокола
++|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
++|inputNumber|(((
++Номер входа
++)))
++
++(% class="wikigeneratedid" %)
++Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
++
  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
  (% class="box infomessage" %)
@@ -1809,6 +1809,11 @@
    "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
  }
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|vehicleId|ID объекта
++|from|Дата и время начала периода запроса
++|to|Дата и время окончания периода запроса
++
  Ответ:
  [
@@ -1815,80 +1815,43 @@
    {
      "messages": [
        {
--        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
--        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
--        "speed": 0, ~/~/ Скорость, км/ч
--        "altitude": 0, ~/~/ Высота, м
--        "latitude": 0, ~/~/ Широта [-90°;90°]
--        "longitude": 0, ~/~/ Долгота [-180°;180°]
--        "satellites": 0, ~/~/ Кол-во спутников
--        "voltage": 0, ~/~/ Напряжение
--        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
++        "deviceTime": "2023-11-29T07:40:44.052Z",
++        "serverTime": "2023-11-29T07:40:44.052Z",
++        "speed": 0,
++        "altitude": 0,
++        "latitude": 0,
++        "longitude": 0,
++        "satellites": 0,
++        "course": 0,
++        "voltage": 0,
++        "parameters": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
--        "photoCount": 0 ~/~/ Кол-во фото
++        "photoCount": 0,
++        "lbsCorrectedCoords": true,
++        "protocolType": 0
        }
      ]
    }
  ]
--== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|deviceTime|Время сообщения терминала
++|serverTime|Время когда сообщение поступило на сервер
++|speed|Скорость
++|altitude|Высота над уровнем моря
++|latitude|Широта
++|longitude|Долгота
++|satellites|Кол-во спутников
++|course|Курс
++|voltage|Бортовое напряжение
++|parameters|Список параметров и их значений
++|photoCount|Количество фото
++|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
++|protocolType|ID типа протокола
--(% class="box infomessage" %)
--(((
--**POST /api/v3/vehicles/export/history**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "vehicleId": 0, ~/~/ ID объекта
--  "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
--  "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
--  "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
--}
--
--Ответ:
--
--Получаете файл. Сообщение: Code 200/Success
--
--== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/vehicles/export/history/status**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **GET**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ:
--
--{
--  "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
--  "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
--  "message": "string" ~/~/ текст описывающий статус.
--}
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
@@ -1925,10 +1925,12 @@
        {
          "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
          "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
--        "mileageBegin": 0, ~/~/ Пробег на начало периода
--        "mileageEnd": 0, ~/~/ Пробег на окончание периода
--        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
--        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
++        "mileage": 0, ~/~/ Пробег за период, километры
++        "mileageBegin": 0, ~/~/ Пробег на начало периода, километры
++        "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
++        "motohours": 0, ~/~/ Моточасы за период, секунды
++        "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
++        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
        }
      ]
    }
@@ -1977,6 +1977,12 @@
    }
  ]
++(% class="box warningmessage" %)
++(((
++Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
++\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
++)))
++
  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
  (% class="box infomessage" %)
@@ -2022,6 +2022,96 @@
    }
  ]
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/moveStop**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Тело запроса:
++
++{
++  "vehicleIds": [ ], ~/~/ Список ID объектов
++  "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
++  "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "vehicleId": 0, ~/~/ ID объекта
++    "vehicleName": "string", ~/~/ Имя объекта
++    "moves": [      ~/~/ Событие движения
++      {
++        "mileage": 0, ~/~/ Пробег, км
++        "eventId": 0, ~/~/ Идентификатор события
++        "eventName": "string", ~/~/ Название события
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++        "duration": 0 ~/~/ Продолжительность события, секунд
++      }
++    ],
++    "stops": [       ~/~/ События стоянок
++      {
++        "address": "string", ~/~/ Адрес события
++        "eventId": 0, ~/~/ Идентификатор события
++        "eventName": "string", ~/~/ Название события
++        "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
++        "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
++        "duration": 0 ~/~/ Продолжительность события, секунд
++      }
++    ]
++  }
++]
++
++
++== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/getlastdata**
++)))
++
++Метод запроса: **POST**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
++
++Ответ:
++  {
++    "vehicleId": 0, ~/~/Идентификатор объекта.
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
++    "vehicleNumber": "string",~/~/Номер объекта.
++    "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
++    "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
++    "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
++    "speed": 0,~/~/Скорость объекта.
++    "course": 0,~/~/Курс движения [0;360]
++    "latitude": 0,~/~/Широта [-90°;90°].
++    "longitude": 0,~/~/Долгота [-180°;180°].
++    "address": "string",~/~/Адрес.
++    "geozones": [ ~/~/Сведения по геозонам.
++      {
++        "id": 0,
++        "name": "string"
++      }
++
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -2329,6 +2329,32 @@
  Success
++
++== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT** /api/v3/notifications/prolongation
++)))
++
++Метод позволяет продлить уведомления.
++
++Метод запроса **PUT**
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
++
++В заголовках запроса: X-Auth: Токен авторизации.
++
++Тело запроса:
++
++[
++
++0
++
++]
++
++где 0 идентификатор ids.
++
  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
  (% class="box errormessage" %)
@@ -2920,6 +2920,83 @@
  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" %)**Получить список карт-меток определенного клиента**(%%) ==
@@ -2941,13 +2941,18 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 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);" %)**Описание**
++|parentId|ID клиента
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
@@ -2964,13 +2964,18 @@
    {
      "name": "string",
      "number": 0,
--    "period": 0, ~/~/ Частота трансляции радиометки
++    "period": 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);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
@@ -2986,7 +2986,6 @@
    "number": 0,
    "period": 0,
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -2997,9 +2997,14 @@
    "period": 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);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
@@ -3016,7 +3016,6 @@
    "period": 0,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
--  "deleted": true
  }
  Ответ:
@@ -3027,9 +3027,14 @@
    "period": 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);" %)**Описание**
++|name|Название карты-метки
++|number|Номер
++|period|Период запросов в секундах (работает только для агрегатов)
++|id|ID карты-метки
++|parentId|ID клиента
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
@@ -3038,7 +3038,7 @@
  **DELETE /api/v3/Rfids/{rfidGuid}**
  )))
--Передаем параметр rfidGuid - идентификатор карты-метки
++Передаем параметр **rfidGuid** - идентификатор карты-метки
  Ответ:
@@ -3045,6 +3045,1108 @@
  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 (расширение *.xls)** или **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|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
++
++В теле использовать тип **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|Номер Карты-метки
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
++
++Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
++
++(% class="box infomessage" %)
++(((
++POST /api/v3/fuelcards/transactions
++)))
++
++Метод запроса: POST
++
++URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
++\\В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++{
++  "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
++  "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
++  "ids": [
++    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
++  ],
++  "timezone": 0 ~/~/Таймзона
++}
++
++
++Ответ:
++  {
++    "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
++    "driver": "string", ~/~/Водители, привязанные к ТК
++    "object": "string", ~/~/Наименование ТС
++    "amount": 0, ~/~/Количество топлива
++    "amountDut": 0, ~/~/Количество по ДУТ
++    "amountDiff": 0, ~/~/Разница, л
++    "amountDiffPerc": 0, ~/~/Разница, %
++    "summa": 0, ~/~/Стоимость, руб
++    "serviceName": "string", ~/~/Тип топлива
++    "price": 0, ~/~/Цена за литр, руб
++    "cardName": "string", ~/~/Наименование ТК
++    "cardNum": "string", ~/~/Номер ТК
++    "operator": "string", ~/~/Оператор ТК
++    "address": "string" ~/~/Адрес АЗС
++  }
++
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
++
++
++== **Получение полных данных о ретрансляторе** ==
++
++(% class="box infomessage" %)
++(((
++**GET ** **/api/v3/retranslations/{id}**
++)))
++
++Идентификатор запроса: ID
++
++
++Пример ответа:
++
++{
++"description": "",  ~/~/ Определяет описание
++"subscriberId": "",  ~/~/ Подписчик
++"protocolType": 0,  ~/~/ Тип протокола
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++"address": "string",  ~/~/ Адрес события
++"objects": [    ~/~/Объекты для ретрансляции
++{
++"id": "",  ~/~/ Идентификатор объекта ретрансляции
++"name": "",   ~/~/ Наименование объекта ретрансляции
++"imei": "",     ~/~/ IMEI объекта
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ идентификатор пользователя
++"parentId": "",  ~/~/Guid родителя
++"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
++}
++
++
++== **Удаление данных ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**DELETE** **/api/v3/retranslations/{id}**
++)))
++
++Параметр запроса: ID
++
++
++== **Создание ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**POST ** **/api/v3/retranslations/{id}**
++)))
++
++Запрос:
++
++{
++"description": "",  ~/~/ Описание
++"subscriberId": "",  ~/~/ Подписчик
++"protocolType": 0,  ~/~/ Тип протокола
++"address": "",  ~/~/ Адрес ретрансляции
++"isEnabled": "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++"objects": [    ~/~/Объекты для ретрансляции
++{
++"id": "",  ~/~/ идентификатор пользователя
++"imei": "",     ~/~/IMEI объекта
++"isEnabled":  ""  ~/~/ признак включения, Включен, true - включен, false - отключен
++}
++  ]
++}
++
++
++Ответ:
++
++{
++"description": "string",  ~/~/ Определяет описание
++"subscriberId": "",  ~/~/ идентификатор запроса
++"protocolType": 0,   ~/~/ Тип протокола
++"isEnabled":  "",  ~/~/ признак включения, Включен, true - включен, false - отключен
++"address": "",  ~/~/ Адрес события
++"objects": [    ~/~/Объекты для ретрансляции
++{
++"id": "",     ~/~/ идентификатор пользователя
++"name": "string",     ~/~/ Название уведомления
++"imei": "string",    ~/~/IMEI объекта
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ идентификатор пользователя
++"parentId": "",  ~/~/ Guid идентификатор родителя
++"deleted": true ~/~/ Признак удаления
++}
++
++
++== **Редактирование ретранслятора** ==
++
++(% class="box infomessage" %)
++(((
++**PUT** **/api/v3/retranslations**
++)))
++
++Пример запроса:
++
++{
++"id": "",  ~/~/ идентификатор пользователя
++"description": "string",  ~/~/ Определяет описание
++"subscriberId": "",  ~/~/ идентификатор запроса
++"protocolType": 0,  ~/~/ Тип протокола
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++"address": "string",   ~/~/ Адрес события
++"objects":  ~/~/Объекты для ретрансляции
++[
++{
++"id": "",  ~/~/ идентификатор пользователя
++"imei": "",       ~/~/IMEI объекта
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++}
++  ]
++}
++
++
++Пример ответа:
++
++{
++"description": "",  ~/~/ Определяет описание
++"subscriberId": "",  ~/~/ идентификатор запроса
++"protocolType": 0,  ~/~/ Тип протокола
++"isEnabled": true,  ~/~/ признак включения, Включен, true - включен, false - отключен
++"address": "string",  ~/~/ Адрес события
++"objects": [     ~/~/Объекты для ретрансляции
++{
++"id": "",    ~/~/ идентификатор пользователя
++"name": "string",  ~/~/ Название уведомления
++"imei": "",      ~/~/IMEI объекта
++"isEnabled": true    ~/~/ признак включения, Включен, true - включен, false - отключен
++}
++  ],
++"id": "",  ~/~/ идентификатор пользователя
++"parentId": "",  ~/~/ Guid идентификатор родителя
++"deleted": true ~/~/ Признак удаления
++}
++
++
++== **Получение списка ретранслятора клиента** ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/retranslations/find**
++)))
++
++Пример запроса:
++
++{
++"id": "",  ~/~/ идентификатор пользователя
++"search": "string",  ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
++"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
++}
++
++Ответ:
++
++[
++{
++"description": "",    ~/~/ Определяет описание
++"subscriberId": "",    ~/~/ идентификатор запроса
++"protocolType": 0,     ~/~/ Тип протокола
++"isEnabled": true,    ~/~/ признак включения, Включен, true - включен, false - отключен
++"address": "string",    ~/~/ Адрес события
++"id": "",    ~/~/ идентификатор пользователя
++"parentId": "",    ~/~/ Guid идентификатор родителя
++"deleted": true   ~/~/ Признак удаления
++}
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
++
++== **API для отчета по выгрузке комбайнов** ==
++
++(% class="box infomessage" %)
++(((
++POST **/api/v3/Reports/harvesterUnloading**
++)))
++
++Пример запроса:
++
++{
++  "byTime": 0, ~/~/ Объединение событий по времени
++  "byDist": 0,  ~/~/ Объединение событий по расстоянию
++  "filterByTime": 0,   ~/~/ Фильтрация событий по времени нахождения
++  "filterByHalfPerimeter": true,  ~/~/ Фильтрация событий по пробегу половины периметра
++  "showNearestObjects": true,  ~/~/Показывать объекты рядом?
++  "vehicleIds": [   ~/~/ Список id объектов для анализа
++    0
++  ],
++  "from": "", ~/~/ Дата и время начало запроса
++  "to": "",  ~/~/ Дата и время окончания запроса
++  "timezone": 0  ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Пример ответа:
++
++[
++  {
++    "harvesterName": "",  ~/~/Комбайн, номер
++    "harvesterId": 0, ~/~/Комбайн, id
++"harvesterModel": "", ~/~/ Модель комбайна
++"hopperCapacity": 0, ~/~/ Объем бункера м3
++    "hopperDischargeSpeed": 0,  ~/~/ Скорость выгрузки из бункера, л/сек
++    "events": [  ~/~/Список событий в разрезе комбайна
++      {
++        "driverId": "",  ~/~/Идентификатор водителя
++        "driverName": "", ~/~/Водитель комбайна, ФИО
++        "RFID": "", ~/~/ идентификатор карты-метки
++        "rfidName": "", ~/~/Водитель комбайна, имя метки
++        "vehicleId": 0, ~/~/идентификатор объекта
++        "vehicleName": "string", ~/~/ Имя объекта
++        "modelName": "string", ~/~/  Имя модели объекта
++        "nearestVehicles": [  ~/~/Объекты рядом
++          {
++            "vehicleId": 0, ~/~/идентификатор объекта
++            "vehicleName": "string" ~/~/ Имя объекта
++          }
++        ],
++        "fields": [  ~/~/Поля, где происходила выгрузка
++          {
++            "id": 0, ~/~/ идентификатор пользователя
++            "name": "string" ~/~/ имя пользователя
++          }
++        ],
++        "event": "string", ~/~/Событие
++        "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
++        "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
++        "durationSeconds": 0,  ~/~/Продолжительность события, в секундах
++        "cultureName": "string",  ~/~/ название культуры
++        "bunkerLowLevelStart": 0,  ~/~/Бункер, нижний уровень (на начало события)
++        "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
++        "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
++        "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
++        "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
++        "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
++        "issued": 0, ~/~/Выдано, бункеров
++        "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
++        "latitude": 0,  ~/~/Широта
++        "longitude": 0, ~/~/ Долгота
++        "litresAway": 0, ~/~/Отдано, л
++        "m3Away": 0 ~/~/Отдано, м3
++      }
++    ]
++  }
++]
++
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
++
++
++(% class="box infomessage" %)
++(((
++GET api/v3/Vehicles/recyclebin/all
++)))
++
++Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
++
++Параметр запроса: {parentId} - идентификатор агента
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Ответ:
++
++[
++  {
++    "recordTime": "",  ~/~/Время записи
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++    "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/
++nullable: true  ~/~/Детали
++        {
++          "name": "string", ~/~/наименование столбца
++          "value": "string" ~/~/содержание столбца
++        }
++      ]
++    },
++   "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++      "string"
++    ]
++  }
++]
++
++
++(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/erase
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Пример запроса:
++
++[
++0
++]
++
++
++Пример ответа:
++
++[
++{
++    "recordTime": "", ~/~/Время записи
++    "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзин
++    "objectGuid": "",  ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/Детали
++        {
++          "name": "", ~/~/Имя свойства
++          "value": "" ~/~/Значение свойства
++        }
++      ]
++    },
++    "errors": [  ~/~/Список ошибок удаления/восстановления объекта
++      ""
++    ]
++  }
++]
++
++Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++
++== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
++
++(% class="box infomessage" %)
++(((
++POST/api/v3/Vehicles/recyclebin/restore
++)))
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++Параметры в теле запроса (JSON):
++
++Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
++
++В заголовках запроса: X-Auth: Токен авторизации
++
++
++Пример запроса:
++
++(((
++[
++)))
++
++(((
++  0
++)))
++
++(((
++]
++)))
++
++
++Пример ответа:
++
++[
++{
++    "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
++    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/Guid пользователя, добавившего объект в корзину
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
++    "objectId": 0, ~/~/ID объекта, помещённого в корзину
++    "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
++    "objectType": 1, ~/~/Тип объекта, помещённого в корзину
++    "details": { ~/~/Список деталей объекта, помещённого в корзину
++      "items": [ ~/~/Детали
++        {
++          "name": "string",  ~/~/Имя свойства
++          "value": "string" ~/~/Значение свойства
++        }
++      ]
++    },
++    "errors": [ ~/~/Список ошибок удаления/восстановления объекта
++      "string"
++    ]
++  }
++]
++
++
++
  (% 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,0 +1,1 @@
	1	+XWiki.krainovim

Size

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

Content

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

Summary

Details

Меню