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

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

From version < 68.1 >

edited by Илья Крайнов
on 2022/11/30 14:00

To version < 66.4 >

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

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,12 +1,6 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
--(((
--**Содержание страницы:**
--)))
++= Описание ГЛОНАССSoft Public API 3.0 =
--(% class="western" %)
--(((
--
--)))
  {{toc/}}
@@ -21,8 +21,10 @@
  (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
++
  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
  (% class="box infomessage" %)
@@ -43,9 +43,9 @@
  (% style="color:#000000" %){
      "login": "testuser",
      "password": "testuser"
--}
++}(%%)
++
--
  (% style="color:#000000" %)**Ответ:**
  (% lang="en-US" %)
@@ -60,8 +60,9 @@
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
--== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Проверка авторизации**(%%) ==
++
  (% class="box infomessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/auth/check**
@@ -78,10 +78,12 @@
  (% lang="en-US" %)
  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Получение основных параметров клиента**(%%) ==
++
  (% class="box infomessage" %)
  (((
  (% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
@@ -114,8 +114,9 @@
      "status": "",  ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
  }
--== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
++
  (% class="box successmessage" %)
  (((
  **POST /api/v3/agents **
@@ -175,8 +175,9 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
--== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  **PUT /api/v3/agents**
@@ -238,8 +238,9 @@
    "bankKS": "string" ~/~/ корр. счёт
  }
--== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
++
  (% class="box errormessage" %)
  (((
  **DELETE /api/v3/agents/{clientId}**
@@ -257,10 +257,12 @@
  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
++== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users**
@@ -324,8 +324,9 @@
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)}
--== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/users/find**
@@ -372,8 +372,9 @@
  (% style="color:#000000" %)}
--== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
@@ -421,8 +421,9 @@
  )))
  )))
--== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  (% lang="en-US" %)**PUT /api/v3/users**
@@ -493,8 +493,9 @@
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
@@ -523,8 +523,9 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  **POST /api/v3/users/disable**
@@ -545,8 +545,9 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
++== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  **POST /api/v3/users/enable**
@@ -580,10 +580,11 @@
  }
  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
  "users" - массив id пользователей, которых не удалось включить или отключить.
++
++
++== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
  )))
--== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
--
  (% class="box errormessage" %)
  (((
  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
@@ -602,10 +602,12 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
++
  (% class="box infomessage" %)
  (((
  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
@@ -674,8 +674,9 @@
  (% style="text-align:left" %)
 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles**
@@ -794,8 +794,9 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/find**
@@ -876,8 +876,9 @@
  (% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
--== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
++
  (% class="box successmessage" %)
  (((
  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
@@ -922,8 +922,9 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)  }
--== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
++
  (% class="box warningmessage" %)
  (((
  (% lang="en-US" %)**PUT /api/v3/vehicles**
@@ -1051,8 +1051,9 @@
  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
++== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
++
  (% class="box errormessage" %)
  (((
  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
@@ -1071,10 +1071,12 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
++(% 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**
@@ -1098,10 +1098,12 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
--== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
++= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
++
++== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
++
  (% class="box infomessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**

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

Summary

Details

Меню