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.krainovim - Content
-
... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « (% style="color: rgb(0, 0, 0);" %)__**AuthId**__(% style="color:#000000" %)» содержит токен авторизации «(% style="color: rgb(0, 0, 0);" %)__**X-Auth**__(% style="color:#000000" %)».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -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,48 @@ 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 + 371 + 330 330 (% class="box errormessage" %) 331 331 ((( 332 332 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** ... ... @@ -425,12 +425,22 @@ 425 425 "sim2": "" , ~/~/ Номер SIM2 426 426 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 427 427 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 428 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 429 - "counters": { 430 - "mileage": "" , ~/~/ пробег 431 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 432 - "motohours": "" , ~/~/ моточасы 433 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 470 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 471 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 472 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 473 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 474 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 475 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 476 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 477 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 478 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 479 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 480 + "counters": ~/~/ счетчики 481 + { 482 + "mileage": "" , ~/~/ пробег 483 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 484 + "motohours": "" , ~/~/ моточасы 485 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 434 434 }, 435 435 "cmsv6Parameters": { ~/~/ параметры CMSv6 436 436 "enabled": true, ~/~/ флаг включения ... ... @@ -501,7 +501,12 @@ 501 501 (% style="text-align:left" %) 502 502 (% style="color:#000000" %)} 503 503 556 +**Валидация:** 557 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 558 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 559 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 504 504 561 + 505 505 (% class="box successmessage" %) 506 506 ((( 507 507 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -636,6 +636,7 @@ 636 636 637 637 (% style="color:#000000" %){ 638 638 696 +((( 639 639 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 640 640 "parentId": "", ~/~/ ID клиента 641 641 "name": "", ~/~/ имя ТС ... ... @@ -644,10 +644,20 @@ 644 644 "modelId": "", ~/~/ , ID модели 645 645 "unitId": "", ~/~/ подразделения 646 646 "sim1": "", ~/~/ SIM 1 647 - "sim2": "", ~/~/ SIM2 648 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 649 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 650 - "counters": 705 + "sim2": "", ~/~/ SIM2 (%%) 706 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 707 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 708 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 709 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 710 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 711 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 712 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 713 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 714 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 715 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 716 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 717 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 718 +(% style="color:#000000" %) "counters": 651 651 { 652 652 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 653 653 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» ... ... @@ -676,6 +676,7 @@ 676 676 "kind": "", ~/~/ Вид периодичности по времени 677 677 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 678 678 } 747 +))) 679 679 680 680 (% style="color:#000000" %)} 681 681 ... ... @@ -729,7 +729,12 @@ 729 729 (% lang="en-US" style="text-align:left" %) 730 730 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 731 731 801 +**валидация:** 802 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 803 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 804 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 732 732 806 + 733 733 (% class="box errormessage" %) 734 734 ((( 735 735 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**