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

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

From version < 66.9 >

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

To version < 46.1 >

edited by Илья Крайнов
on 2022/11/21 10:27

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,30 +1,31 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
--= Описание ГЛОНАССSoft Public API 3.0 =
++== Описание ГЛОНАССSoft Public API 3.0 ==
++==   ==
--{{toc/}}
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
++)))
--
--= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
--
  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
++
--(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
++)))
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
--
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/auth/login**
++ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
  )))
--(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
++(% style="color:#000000" %)          Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -38,8 +38,8 @@
      "login": "testuser",
      "password": "testuser"
  }(%%)
++
--
  (% style="color:#000000" %)**Ответ:**
  (% lang="en-US" %)
@@ -54,14 +54,13 @@
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
--== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
  (% class="box infomessage" %)
  (((
--(% lang="en-US" %)**GET /api/v3/auth/check**
++(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -72,16 +72,18 @@
  (% lang="en-US" %)
  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
++)))
  (% class="box infomessage" %)
  (((
--(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
++(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
@@ -109,163 +109,17 @@
  }
--== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
--
--(% class="box successmessage" %)
++(% class="box" style="text-align: center;" %)
  (((
--**POST /api/v3/agents **
++(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
  )))
--Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
--
--Метод запроса: **POST**
--
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Параметры в теле запроса (JSON):
--
--{
--   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
--  "name": "string", ~/~/ имя
--  "fullName": "string", ~/~/ полное наименование
--  "isForeign": true, ~/~/ иностранный контрагент
--  "district": "string", ~/~/ округ
--  "region": "string", ~/~/ регион
--  "city": "string", ~/~/ город
--  "inn": "string", ~/~/ ИНН
--  "kpp": "string", ~/~/ КПП
--  "address": "string", ~/~/ юридический адрес
--  "addressFact": "string", ~/~/ фактический адрес
--  "email": "string", ~/~/ email
--  "director": "string", ~/~/ ФИО руководителя
--  "bankName": "string", ~/~/ банк
--  "bankBIK": "string", ~/~/ БИК
--  "bankRS": "string", ~/~/ номер счёта
--  "bankKS": "string" ~/~/ корр. счёт
--}
--
--
--Ответ:
--
--{
--  "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
--  "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
--  "name": "string", ~/~/ имя
--  "fullName": "string", ~/~/ полное наименование
--  "isForeign": true, ~/~/ иностранный контрагент
--  "district": "string", ~/~/ округ
--  "region": "string", ~/~/ регион
--  "city": "string", ~/~/ город
--  "inn": "string", ~/~/ ИНН
--  "kpp": "string", ~/~/ КПП
--  "address": "string", ~/~/ юридический адрес
--  "addressFact": "string", ~/~/ фактический адрес
--  "email": "string", ~/~/ email
--  "director": "string", ~/~/ ФИО руководителя
--  "bankName": "string", ~/~/ банк
--  "bankBIK": "string", ~/~/ БИК
--  "bankRS": "string", ~/~/ номер счёта
--  "bankKS": "string" ~/~/ корр. счёт
--}
--
--
--== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/agents**
--)))
--
--Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
--
--Метод запроса: **PUT**
--
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--
--Параметры в теле запроса (JSON):
--
--{
--  "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
--  "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
--  "name": "string", ~/~/ имя
--  "fullName": "string", ~/~/ полное наименование
--  "isForeign": true, ~/~/ иностранный контрагент
--  "district": "string", ~/~/ округ
--  "region": "string", ~/~/ регион
--  "city": "string", ~/~/ город
--  "inn": "string", ~/~/ ИНН
--  "kpp": "string", ~/~/ КПП
--  "address": "string", ~/~/ юридический адрес
--  "addressFact": "string", ~/~/ фактический адрес
--  "email": "string", ~/~/ email
--  "director": "string", ~/~/ ФИО руководителя
--  "bankName": "string", ~/~/ банк
--  "bankBIK": "string", ~/~/ БИК
--  "bankRS": "string", ~/~/ номер счёта
--  "bankKS": "string" ~/~/ корр. счёт
--}
--
--
--Ответ:
--
--{
--  "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
--  "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя
--  "name": "string", ~/~/ имя
--  "fullName": "string", ~/~/ полное наименование
--  "isForeign": true, ~/~/ иностранный контрагент
--  "district": "string", ~/~/ округ
--  "region": "string", ~/~/ регион
--  "city": "string", ~/~/ город
--  "inn": "string", ~/~/ ИНН
--  "kpp": "string", ~/~/ КПП
--  "address": "string", ~/~/ юридический адрес
--  "addressFact": "string", ~/~/ фактический адрес
--  "email": "string", ~/~/ email
--  "director": "string", ~/~/ ФИО руководителя
--  "bankName": "string", ~/~/ банк
--  "bankBIK": "string", ~/~/ БИК
--  "bankRS": "string", ~/~/ номер счёта
--  "bankKS": "string" ~/~/ корр. счёт
--}
--
--
--== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/agents/{clientId}**
--)))
--
--Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
--
--Метод запроса: **DELETE**
--
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
--
--Параметр запроса: **{clientId}** - Guid пользователя
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
--
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
--
--
--== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/users**
++(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -324,14 +324,12 @@
  (% style="color:#000000; font-weight:normal" %)}
--== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/users/find**
++(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
++(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
@@ -373,14 +373,12 @@
  (% style="color:#000000" %)}
--== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**GET /api/v3/users/{GUID}**
++(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
  )))
--(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
++(% style="color:#000000" %)           Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -393,44 +393,172 @@
  (((
  (((
  {
++)))
++)))
++
++(((
++(((
      "id": "", ~/~/ GUID пользователя
--    "lastName": "", ~/~/ Фамилия
++)))
++)))
++
++(((
++(((
++    "lastName": "", ~/~/ Фамилия
++)))
++)))
++
++(((
++(((
      "firstName": "", ~/~/ Имя
++)))
++)))
++
++(((
++(((
      "position": "", ~/~/ Должность
++)))
++)))
++
++(((
++(((
      "phone": "", ~/~/ Номер телефона
++)))
++)))
++
++(((
++(((
      "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
++)))
++)))
++
++(((
++(((
      "parentName": "", Наименование клиента, которому принадлежит пользователь
++)))
++)))
++
++(((
++(((
      "organization": "", ~/~/ Организация
++)))
++)))
++
++(((
++(((
      "login": "", ~/~/ Логин пользователя
++)))
++)))
++
++(((
++(((
      "email": "", ~/~/ Адрес электронной почты
++)))
++)))
++
++(((
++(((
      "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
++)))
++)))
++
++(((
++(((
      "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
++)))
++)))
++
++(((
++(((
      "description": "", ~/~/ Описание
++)))
++)))
++
++(((
++(((
      "isEnabled": , ~/~/ Включен, true - включен, false - отключен
++)))
++)))
++
++(((
++(((
      "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
++)))
++)))
++
++(((
++(((
      "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
++)))
++)))
++
++(((
++(((
      "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
++)))
++)))
++
++(((
++(((
      "sessionDuration": 30, ~/~/ Длительность сессии в минутах
++)))
++)))
++
++(((
++(((
      "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
++)))
++)))
++
++(((
++(((
      "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
++)))
++)))
++
++(((
++(((
      "groups": [], ~/~/ Список ролей пользователя
++)))
++)))
++
++(((
++(((
      "customGroups": [], ~/~/ Список клиентских ролей пользователя
++)))
++)))
++
++(((
++(((
      "authDevices": [ ], ~/~/ Список авторизованных устройств
++)))
++)))
++
++(((
++(((
      "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
++)))
++)))
++
++(((
++(((
      "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
++)))
++)))
++
++(((
++(((
  }
  )))
  )))
--== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
--
  (% class="box warningmessage" %)
  (((
--(% lang="en-US" %)**PUT /api/v3/users**
++(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -438,6 +438,8 @@
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
++
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
@@ -496,14 +496,12 @@
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
--
  (% class="box warningmessage" %)
  (((
--(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
++(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -527,11 +527,9 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
--
  (% class="box warningmessage" %)
  (((
--**POST /api/v3/users/disable**
++**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
  )))
  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
@@ -550,11 +550,9 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
--
  (% class="box warningmessage" %)
  (((
--**POST /api/v3/users/enable**
++**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
  )))
  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
@@ -586,16 +586,14 @@
  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
  "users" - массив id пользователей, которых не удалось включить или отключить.
--
--== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
  )))
  (% class="box errormessage" %)
  (((
--(% lang="en-US" %)**DELETE /api/v3/users/{id}**
++(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -609,19 +609,19 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
++)))
--
--== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
--
  (% class="box infomessage" %)
  (((
--(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
++(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
++(% style="color:#000000" %)          Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
@@ -639,40 +639,145 @@
  (((
  {
++)))
++
++(((
      "vehicleId": "", ~/~/ ID объекта
++)))
++
++(((
      "name": "", ~/~/ Имя объекта
++)))
++
++(((
      "imei": "", ~/~/ IMEI объекта
++)))
++
++(((
      "deviceTypeId": , ~/~/ ID типа устройства
++)))
++
++(((
      "deviceTypeName": "", ~/~/ Название типа устройства
++)))
++
++(((
      "sim1": "", ~/~/ Номер SIM1
++)))
++
++(((
      "parentId": "", Номер SIM2
--    "parentName": "", Наименование клиента-родителя
++)))
++
++(((
++    "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
++)))
++
++(((
      "modelId": "", ID модели объекта
++)))
++
++(((
      "modelName": "", Имя модели объекта
++)))
++
++(((
      "createdAt": "", Дата создания объекта
++)))
++
++(((
      "mileageCalcMethod": "", Выбранный метод расчета пробега
++)))
++
++(((
      "counters": { ~/~/ Нормы
++)))
++
++(((
          "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
++)))
++
++(((
          "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
++)))
++
++(((
          "mileage": "", ~/~/ Пробег по нормам в метрах
++)))
++
++(((
          "motohours": "" ~/~/ Моточасы по нормам, в секундах
++)))
++
++(((
      },
++)))
++
++(((
      "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
++)))
++
++(((
          {
--            "id": "", ~/~/ ID  задания
++)))
++
++(((
++            "id": "", ~/~/ ID  задания
++)))
++
++(((
              "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
++)))
++
++(((
              "name": "", ~/~/ Наименование задания
++)))
++
++(((
              "description": "", ~/~/ Описание задания
++)))
++
++(((
              "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
++)))
++
++(((
              "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
++)))
++
++(((
              "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
++)))
++
++(((
              "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
++)))
++
++(((
              "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
++)))
++
++(((
              "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
++)))
++
++(((
              "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
++)))
++
++(((
              "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
++)))
++
++(((
          }
++)))
++
++(((
      ]
++)))
++
++(((
  }
  )))
@@ -683,14 +683,12 @@
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/vehicles**
++(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
++(% style="color:#000000" %)          Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -804,16 +804,14 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/vehicles/find**
++(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -839,6 +839,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
++
  {
      "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
      "name": null, ~/~/ Имя ТС (string, опционально)
@@ -846,12 +846,13 @@
      "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
      "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
      "parentId": null, ~/~/ ID клиента (Guid, опционально)
--    "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
++    "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
      "customFields": null ~/~/ значение любого из произвольных полей ТС
  }
--(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
++(% style="color:#000000" %)          Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
++
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
@@ -872,29 +872,18 @@
      "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
                                                             ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
                                                            ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
--(% style="color:#000000" %)    "createdAt": "" ~/~/ дата создания объектов
--    "customFields": [
--            {
--                "id": "", ~/~/ идентификатор произвольного поля
--                "name": "", ~/~/ имя произвольного поля
--                "value": "", ~/~/ значение произвольного поля
--                "forClient": true, ~/~/ право на отображение у клиента
--                "forTooltip": false, ~/~/ право на отображение в подсказке
--                "forReport": false ~/~/ право на отображение в отчетах
--            }(%%)
++(% style="color:#000000" %)    "createdAt": "" ~/~/ дата создания объектов  (%%)
  (% style="color:#000000" %)}
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
--== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
--
  (% class="box successmessage" %)
  (((
--(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
++(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -934,14 +934,12 @@
  (% style="color:#000000" %)  }
--== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
--
  (% class="box warningmessage" %)
  (((
--(% lang="en-US" %)**PUT /api/v3/vehicles**
++(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -1064,14 +1064,12 @@
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
--
  (% class="box errormessage" %)
  (((
--(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
++(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
@@ -1085,17 +1085,17 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
++(% class="box" lang="en-US" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
++)))
--
--== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
--
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
++(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -1114,17 +1114,17 @@
  (% style="color:#000000" %)}
--= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
++)))
--
--== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
--
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
++(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
  (% style="color:#000000" %)Метод запроса: **GET**

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

Summary

Details

Меню