Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.Gadmin - Content
-
... ... @@ -303,7 +303,7 @@ 303 303 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 304 304 ))) 305 305 306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя . Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 307 307 308 308 (% style="color:#000000" %)Метод запроса: **PUT** 309 309 ... ... @@ -327,6 +327,61 @@ 327 327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 328 328 329 329 330 +(% class="box warningmessage" %) 331 +((( 332 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 333 +))) 334 + 335 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 336 + 337 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 338 + 339 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 340 + 341 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 342 + 343 + [ 344 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 345 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 346 + ] 347 + 348 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 349 + 350 + 351 +(% class="box warningmessage" %) 352 +((( 353 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable** 354 +))) 355 + 356 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 357 + 358 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 359 + 360 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 361 + 362 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 363 + 364 + [ 365 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 366 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 367 + ] 368 + 369 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 370 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 371 + 372 +В теле ответа: 373 +{ 374 + "errorMessages": [ 375 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 376 + ], 377 + "users": [ 378 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 379 + ] 380 +} 381 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 382 +"users" - массив id пользователей, которых не удалось включить или отключить. 383 + 384 + 330 330 (% class="box errormessage" %) 331 331 ((( 332 332 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -426,16 +426,17 @@ 426 426 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 427 427 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 428 428 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 429 - "consumptionPer100KmSeasonal": 0, \ Расход топлива на 100 км (Сезонные нормы - если задано - возвращаем) 430 - "consumptionPerHourSeasonal": 0, \ Расход топлива за моточас (Сезонные нормы - если задано - возвращаем) 431 - "consumptionIdleSeasonal": 0, \ Расход топлива на холостом ходу (Сезонные нормы - если задано - возвращаем) 432 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм 433 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ параметры окончания применения значений сезонных норм 434 - "consumptionPerHourSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм 435 - "consumptionPerHourSeasonalEnd": "" , ~/~/параметры окончания применения значений сезонных норм 436 - "consumptionIdleSeasonalBegin": "" , ~/~/ параметры начала применения значений сезонных норм 437 - "consumptionIdleSeasonalEnd": "" , ~/~/ параметры окончания применения значений сезонных норм 438 - "counters": { 484 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 485 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 486 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 487 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 488 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 489 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 490 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 491 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 492 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 493 + "counters": ~/~/ счетчики 494 + { 439 439 "mileage": "" , ~/~/ пробег 440 440 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 441 441 "motohours": "" , ~/~/ моточасы ... ... @@ -515,6 +515,7 @@ 515 515 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 516 516 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 517 517 574 + 518 518 (% class="box successmessage" %) 519 519 ((( 520 520 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -649,6 +649,7 @@ 649 649 650 650 (% style="color:#000000" %){ 651 651 709 +((( 652 652 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 653 653 "parentId": "", ~/~/ ID клиента 654 654 "name": "", ~/~/ имя ТС ... ... @@ -657,10 +657,20 @@ 657 657 "modelId": "", ~/~/ , ID модели 658 658 "unitId": "", ~/~/ подразделения 659 659 "sim1": "", ~/~/ SIM 1 660 - "sim2": "", ~/~/ SIM2 661 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 662 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 663 - "counters": 718 + "sim2": "", ~/~/ SIM2 (%%) 719 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 720 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 721 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 722 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 723 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 724 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 725 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 726 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 727 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 728 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 729 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 730 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 731 +(% style="color:#000000" %) "counters": 664 664 { 665 665 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 666 666 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» ... ... @@ -689,6 +689,7 @@ 689 689 "kind": "", ~/~/ Вид периодичности по времени 690 690 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 691 691 } 760 +))) 692 692 693 693 (% style="color:#000000" %)} 694 694 ... ... @@ -742,7 +742,12 @@ 742 742 (% lang="en-US" style="text-align:left" %) 743 743 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 744 744 814 +**валидация:** 815 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 816 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 817 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 745 745 819 + 746 746 (% class="box errormessage" %) 747 747 ((( 748 748 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**