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

Summary

Details

Icon Page properties
Content
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
140 + "login": "", ~/~/ логин (обязателен)
141 + "password": "", ~/~/ пароль (обязателен)
142 + "email": "", ~/~/ email (обязателен)
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -227,6 +227,184 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
230 +(% class="box successmessage" %)
231 +(((
232 +(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 +)))
234 +
235 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 +
237 +(% style="color:#000000" %)Метод запроса: **GET**
238 +
239 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 +
241 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 +
243 +(% style="color:#000000" %)Ответ:
244 +
245 +(((
246 +(((
247 +{
248 +)))
249 +)))
250 +
251 +(((
252 +(((
253 + "id": "", ~/~/ GUID пользователя
254 +)))
255 +)))
256 +
257 +(((
258 +(((
259 + "lastName": "", ~/~/ Фамилия
260 +)))
261 +)))
262 +
263 +(((
264 +(((
265 + "firstName": "", ~/~/ Имя
266 +)))
267 +)))
268 +
269 +(((
270 +(((
271 + "position": "", ~/~/ Должность
272 +)))
273 +)))
274 +
275 +(((
276 +(((
277 + "phone": "", ~/~/ Номер телефона
278 +)))
279 +)))
280 +
281 +(((
282 +(((
283 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 +)))
285 +)))
286 +
287 +(((
288 +(((
289 + "parentName": "", Наименование клиента, которому принадлежит пользователь
290 +)))
291 +)))
292 +
293 +(((
294 +(((
295 + "organization": "", ~/~/ Организация
296 +)))
297 +)))
298 +
299 +(((
300 +(((
301 + "login": "", ~/~/ Логин пользователя
302 +)))
303 +)))
304 +
305 +(((
306 +(((
307 + "email": "", ~/~/ Адрес электронной почты
308 +)))
309 +)))
310 +
311 +(((
312 +(((
313 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 +)))
315 +)))
316 +
317 +(((
318 +(((
319 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 +)))
321 +)))
322 +
323 +(((
324 +(((
325 + "description": "", ~/~/ Описание
326 +)))
327 +)))
328 +
329 +(((
330 +(((
331 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 +)))
333 +)))
334 +
335 +(((
336 +(((
337 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 +)))
339 +)))
340 +
341 +(((
342 +(((
343 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 +)))
345 +)))
346 +
347 +(((
348 +(((
349 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 +)))
351 +)))
352 +
353 +(((
354 +(((
355 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 +)))
357 +)))
358 +
359 +(((
360 +(((
361 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 +)))
363 +)))
364 +
365 +(((
366 +(((
367 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 +)))
369 +)))
370 +
371 +(((
372 +(((
373 + "groups": [], ~/~/ Список ролей пользователя
374 +)))
375 +)))
376 +
377 +(((
378 +(((
379 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 +)))
381 +)))
382 +
383 +(((
384 +(((
385 + "authDevices": [ ], ~/~/ Список авторизованных устройств
386 +)))
387 +)))
388 +
389 +(((
390 +(((
391 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 +)))
393 +)))
394 +
395 +(((
396 +(((
397 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 +)))
399 +)))
400 +
401 +(((
402 +(((
403 +}
404 +)))
405 +)))
406 +
407 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -240,6 +240,8 @@
240 240  
241 241  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 242  
421 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
422 +
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245 245  
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
436 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
552 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -381,6 +381,7 @@
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 383  
565 +)))
384 384  
385 385  (% class="box errormessage" %)
386 386  (((
... ... @@ -429,77 +429,149 @@
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
614 +(((
432 432  {
616 +)))
433 433  
618 +(((
434 434   "vehicleId": "", ~/~/ ID объекта
620 +)))
435 435  
622 +(((
436 436   "name": "", ~/~/ Имя объекта
624 +)))
437 437  
626 +(((
438 438   "imei": "", ~/~/ IMEI объекта
628 +)))
439 439  
630 +(((
440 440   "deviceTypeId": , ~/~/ ID типа устройства
632 +)))
441 441  
634 +(((
442 442   "deviceTypeName": "", ~/~/ Название типа устройства
636 +)))
443 443  
638 +(((
444 444   "sim1": "", ~/~/ Номер SIM1
640 +)))
445 445  
642 +(((
446 446   "parentId": "", Номер SIM2
644 +)))
447 447  
646 +(((
448 448   "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 +)))
449 449  
650 +(((
450 450   "modelId": "", ID модели объекта
652 +)))
451 451  
654 +(((
452 452   "modelName": "", Имя модели объекта
656 +)))
453 453  
658 +(((
454 454   "createdAt": "", Дата создания объекта
660 +)))
455 455  
662 +(((
456 456   "mileageCalcMethod": "", Выбранный метод расчета пробега
664 +)))
457 457  
666 +(((
458 458   "counters": { ~/~/ Нормы
668 +)))
459 459  
670 +(((
460 460   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 +)))
461 461  
674 +(((
462 462   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 +)))
463 463  
678 +(((
464 464   "mileage": "", ~/~/ Пробег по нормам в метрах
680 +)))
465 465  
682 +(((
466 466   "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 +)))
467 467  
686 +(((
468 468   },
688 +)))
469 469  
690 +(((
470 470   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 +)))
471 471  
694 +(((
472 472   {
696 +)))
473 473  
698 +(((
474 474   "id": "", ~/~/ ID  задания
700 +)))
475 475  
702 +(((
476 476   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 +)))
477 477  
706 +(((
478 478   "name": "", ~/~/ Наименование задания
708 +)))
479 479  
710 +(((
480 480   "description": "", ~/~/ Описание задания
712 +)))
481 481  
714 +(((
482 482   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 +)))
483 483  
718 +(((
484 484   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 +)))
485 485  
722 +(((
486 486   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 +)))
487 487  
726 +(((
488 488   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 +)))
489 489  
730 +(((
490 490   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 +)))
491 491  
734 +(((
492 492   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 +)))
493 493  
738 +(((
494 494   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 +)))
495 495  
742 +(((
496 496   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 +)))
497 497  
746 +(((
498 498   }
748 +)))
499 499  
750 +(((
500 500   ]
752 +)))
501 501  
754 +(((
502 502  }
756 +)))
503 503  
504 504  (% style="text-align:left" %)
505 505  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -660,17 +660,19 @@
660 660  
661 661  (% style="color:#000000" %)Параметры в теле запроса (JSON):
662 662  
663 -(% class="western" style="color:#000000" %)##{##
664 664  
665 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 - "name": null, ~/~/ Имя ТС (string, опционально) 
667 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 -(% style="color:#000000" %)}
918 +{
919 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
920 + "name": null, ~/~/ Имя ТС (string, опционально)
921 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
922 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
923 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
924 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
925 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
926 + "customFields": null ~/~/ значение любого из произвольных полей ТС
927 +}
673 673  
929 +
674 674  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
675 675  
676 676  (% style="color:#000000" %)Ответ:

Меню

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