Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,12 +1,6 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -((( 3 -**Содержание страницы:** 4 -))) 2 += Описание ГЛОНАССSoft Public API 3.0 = 5 5 6 -(% class="western" %) 7 -((( 8 - 9 -))) 10 10 11 11 {{toc/}} 12 12 ... ... @@ -21,8 +21,10 @@ 21 21 22 22 (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 23 23 18 + 24 24 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 25 25 21 + 26 26 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 27 27 28 28 (% class="box infomessage" %) ... ... @@ -43,9 +43,9 @@ 43 43 (% style="color:#000000" %){ 44 44 "login": "testuser", 45 45 "password": "testuser" 46 -} 42 +}(%%) 43 + 47 47 48 - 49 49 (% style="color:#000000" %)**Ответ:** 50 50 51 51 (% lang="en-US" %) ... ... @@ -60,6 +60,7 @@ 60 60 61 61 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 62 62 59 + 63 63 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 64 64 65 65 (% class="box infomessage" %) ... ... @@ -78,8 +78,10 @@ 78 78 (% lang="en-US" %) 79 79 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 80 80 78 + 81 81 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 82 82 81 + 83 83 == (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) == 84 84 85 85 (% class="box infomessage" %) ... ... @@ -114,8 +114,9 @@ 114 114 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 115 115 } 116 116 117 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 118 118 117 +== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) == 118 + 119 119 (% class="box successmessage" %) 120 120 ((( 121 121 **POST /api/v3/agents ** ... ... @@ -175,8 +175,9 @@ 175 175 "bankKS": "string" ~/~/ корр. счёт 176 176 } 177 177 178 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 179 179 179 +== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) == 180 + 180 180 (% class="box warningmessage" %) 181 181 ((( 182 182 **PUT /api/v3/agents** ... ... @@ -238,8 +238,9 @@ 238 238 "bankKS": "string" ~/~/ корр. счёт 239 239 } 240 240 241 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 242 242 243 +== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) == 244 + 243 243 (% class="box errormessage" %) 244 244 ((( 245 245 **DELETE /api/v3/agents/{clientId}** ... ... @@ -257,10 +257,12 @@ 257 257 258 258 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 259 259 262 + 260 260 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 261 261 262 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 263 263 266 +== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) == 267 + 264 264 (% class="box successmessage" %) 265 265 ((( 266 266 (% lang="en-US" %)**POST /api/v3/users** ... ... @@ -324,8 +324,9 @@ 324 324 (% style="text-align:left" %) 325 325 (% style="color:#000000; font-weight:normal" %)} 326 326 327 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 328 328 332 +== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) == 333 + 329 329 (% class="box successmessage" %) 330 330 ((( 331 331 (% lang="en-US" %)**POST /api/v3/users/find** ... ... @@ -372,8 +372,9 @@ 372 372 373 373 (% style="color:#000000" %)} 374 374 375 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 376 376 381 +== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) == 382 + 377 377 (% class="box successmessage" %) 378 378 ((( 379 379 (% lang="en-US" %)**GET /api/v3/users/{GUID}** ... ... @@ -421,8 +421,9 @@ 421 421 ))) 422 422 ))) 423 423 424 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 425 425 431 +== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) == 432 + 426 426 (% class="box warningmessage" %) 427 427 ((( 428 428 (% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -493,8 +493,9 @@ 493 493 (% lang="en-US" style="text-align:left" %) 494 494 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 495 495 496 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 497 497 504 +== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) == 505 + 498 498 (% class="box warningmessage" %) 499 499 ((( 500 500 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -523,8 +523,9 @@ 523 523 (% style="text-align:left" %) 524 524 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 525 525 526 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 527 527 535 +== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) == 536 + 528 528 (% class="box warningmessage" %) 529 529 ((( 530 530 **POST /api/v3/users/disable** ... ... @@ -545,8 +545,9 @@ 545 545 546 546 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 547 547 548 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 549 549 558 +== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) == 559 + 550 550 (% class="box warningmessage" %) 551 551 ((( 552 552 **POST /api/v3/users/enable** ... ... @@ -580,10 +580,11 @@ 580 580 } 581 581 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 582 582 "users" - массив id пользователей, которых не удалось включить или отключить. 593 + 594 + 595 +== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) == 583 583 ))) 584 584 585 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 586 - 587 587 (% class="box errormessage" %) 588 588 ((( 589 589 (% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -602,10 +602,12 @@ 602 602 (% style="text-align:left" %) 603 603 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 604 604 616 + 605 605 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 606 606 607 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 608 608 620 +== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) == 621 + 609 609 (% class="box infomessage" %) 610 610 ((( 611 611 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** ... ... @@ -674,8 +674,9 @@ 674 674 (% style="text-align:left" %) 675 675 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 676 676 677 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 678 678 691 +== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) == 692 + 679 679 (% class="box successmessage" %) 680 680 ((( 681 681 (% lang="en-US" %)**POST /api/v3/vehicles** ... ... @@ -794,8 +794,9 @@ 794 794 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 795 795 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 796 796 797 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 798 798 812 +== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) == 813 + 799 799 (% class="box successmessage" %) 800 800 ((( 801 801 (% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -876,8 +876,9 @@ 876 876 877 877 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 878 878 879 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 880 880 895 +== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) == 896 + 881 881 (% class="box successmessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** ... ... @@ -922,8 +922,9 @@ 922 922 (% style="text-align:left" %) 923 923 (% style="color:#000000" %) } 924 924 925 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 926 926 942 +== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) == 943 + 927 927 (% class="box warningmessage" %) 928 928 ((( 929 929 (% lang="en-US" %)**PUT /api/v3/vehicles** ... ... @@ -1051,8 +1051,9 @@ 1051 1051 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1052 1052 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1053 1053 1054 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1055 1055 1072 +== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) == 1073 + 1056 1056 (% class="box errormessage" %) 1057 1057 ((( 1058 1058 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -1071,10 +1071,12 @@ 1071 1071 (% style="text-align:left" %) 1072 1072 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1073 1073 1074 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1075 1075 1076 - ==(% style="color:#000000; font-size:16px" %)**Получениеспискатипов устройств**(%%) ==1093 +(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства** 1077 1077 1095 + 1096 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) == 1097 + 1078 1078 (% class="box infomessage" %) 1079 1079 ((( 1080 1080 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** ... ... @@ -1098,10 +1098,12 @@ 1098 1098 (% style="text-align:left" %) 1099 1099 (% style="color:#000000" %)} 1100 1100 1101 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1102 1102 1103 -= =(% style="color:#000000; font-size:16px" %)**Получениеспискаипов датчиков**(%%) ==1122 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) = 1104 1104 1124 + 1125 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) == 1126 + 1105 1105 (% class="box infomessage" %) 1106 1106 ((( 1107 1107 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**