Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 28.9 >
edited by Артем Шемяков
on 2022/09/22 10:20
To version < 39.1 >
edited by Илья Крайнов
on 2022/11/17 14:50
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Content
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
151 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
177 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -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}**
... ... @@ -374,21 +374,76 @@
374 374  
375 375  (% style="color:#000000" %)Ответ:
376 376  
377 -(% style="color:#000000" %){
432 +{
378 378  
379 - "vehicleId": "" , ~/~/ идентификатор объекта
380 - "name": "" , ~/~/ имя объекта
381 - "imei": "" , ~/~/ IMEI объекта
382 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 - "parentId": "" , ~/~/ идентификатор клиента-родителя
385 - "parentName": "" , ~/~/ наименование клиента-родителя,
386 - "modelId": "" , ~/~/ идентификатор модели объекта
387 - "modelName": "" , ~/~/ наименование модели объекта,
388 - "unitId": "" , ~/~/ идентификатор подразделения
389 - "unitName": "" , ~/~/ наименование подразделения
390 - "status": "" , ~/~/ статус объекта
434 + "vehicleId": "", ~/~/ ID объекта
391 391  
436 + "name": "", ~/~/ Имя объекта
437 +
438 + "imei": "", ~/~/ IMEI объекта
439 +
440 + "deviceTypeId": , ~/~/ ID типа устройства
441 +
442 + "deviceTypeName": "", ~/~/ Название типа устройства
443 +
444 + "sim1": "", ~/~/ Номер SIM1
445 +
446 + "parentId": "", Номер SIM2
447 +
448 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 +
450 + "modelId": "", ID модели объекта
451 +
452 + "modelName": "", Имя модели объекта
453 +
454 + "createdAt": "", Дата создания объекта
455 +
456 + "mileageCalcMethod": "", Выбранный метод расчета пробега
457 +
458 + "counters": { ~/~/ Нормы
459 +
460 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 +
462 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 +
464 + "mileage": "", ~/~/ Пробег по нормам в метрах
465 +
466 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 +
468 + },
469 +
470 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 +
472 + {
473 +
474 + "id": "", ~/~/ ID  задания
475 +
476 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 +
478 + "name": "", ~/~/ Наименование задания
479 +
480 + "description": "", ~/~/ Описание задания
481 +
482 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 +
484 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 +
486 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 +
488 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 +
490 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 +
492 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 +
494 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 +
496 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 +
498 + }
499 +
500 + ]
501 +
392 392  }
393 393  
394 394  (% style="text-align:left" %)
... ... @@ -660,7 +660,7 @@
660 660   "modelId": "", ~/~/ , ID модели    
661 661   "unitId": "", ~/~/ подразделения
662 662   "sim1": "", ~/~/ SIM 1
663 - "sim2": "", ~/~/ SIM2 (%%)
773 + "sim2": "", ~/~/ SIM2     (%%)
664 664   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
665 665   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
666 666   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -677,8 +677,8 @@
677 677   {
678 678   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
679 679   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
680 - "mileage": «», пробег
681 - "motohours": «» моточасы
790 + "mileage": "", ~/~/ пробег, в метрах 
791 + "motohours": "" ~/~/ моточасы, в секундах
682 682   }
683 683   "cmsv6Parameters": ~/~/ параметры CMSv6
684 684   {       

Меню

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