Last modified by Андрей Калиновский on 2025/04/24 15:46
<
From version < 27.1 >
edited by Артем Шемяков
on 2022/09/20 09:17
To version < 33.1 >
edited by Андрей Калиновский
on 2022/11/01 10:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.Gadmin
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,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}**
... ... @@ -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 ~/~/ флаг активности счётчика "моточасы"
483 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
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 + {
495 + "mileage": "" , ~/~/ пробег
496 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
497 + "motohours": "" , ~/~/ моточасы
498 + "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  
569 +**Валидация:**
570 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
571 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
572 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
504 504  
574 +
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  
709 +(((
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": 
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": 
651 651   {
652 652   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
653 653   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
... ... @@ -676,6 +676,7 @@
676 676   "kind": "", ~/~/ Вид периодичности по времени
677 677   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
678 678   } 
760 +)))
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  
814 +**валидация:**
815 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
816 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
817 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
732 732  
819 +
733 733  (% class="box errormessage" %)
734 734  (((
735 735  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

Меню

ГЛОНАССSoft wiki - 2024 г.