Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- 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 родительского агента ... ... @@ -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" %)} ... ... @@ -227,6 +227,182 @@ 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" %)Ответ: 242 + 243 +((( 244 +((( 245 +{ 246 +))) 247 +))) 248 + 249 +((( 250 +((( 251 + "id": "", ~/~/ GUID пользователя 252 +))) 253 +))) 254 + 255 +((( 256 +((( 257 + "lastName": "", ~/~/ Фамилия 258 +))) 259 +))) 260 + 261 +((( 262 +((( 263 + "firstName": "", ~/~/ Имя 264 +))) 265 +))) 266 + 267 +((( 268 +((( 269 + "position": "", ~/~/ Должность 270 +))) 271 +))) 272 + 273 +((( 274 +((( 275 + "phone": "", ~/~/ Номер телефона 276 +))) 277 +))) 278 + 279 +((( 280 +((( 281 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 282 +))) 283 +))) 284 + 285 +((( 286 +((( 287 + "parentName": "", Наименование клиента, которому принадлежит пользователь 288 +))) 289 +))) 290 + 291 +((( 292 +((( 293 + "organization": "", ~/~/ Организация 294 +))) 295 +))) 296 + 297 +((( 298 +((( 299 + "login": "", ~/~/ Логин пользователя 300 +))) 301 +))) 302 + 303 +((( 304 +((( 305 + "email": "", ~/~/ Адрес электронной почты 306 +))) 307 +))) 308 + 309 +((( 310 +((( 311 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 312 +))) 313 +))) 314 + 315 +((( 316 +((( 317 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 318 +))) 319 +))) 320 + 321 +((( 322 +((( 323 + "description": "", ~/~/ Описание 324 +))) 325 +))) 326 + 327 +((( 328 +((( 329 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 330 +))) 331 +))) 332 + 333 +((( 334 +((( 335 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 336 +))) 337 +))) 338 + 339 +((( 340 +((( 341 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 342 +))) 343 +))) 344 + 345 +((( 346 +((( 347 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 348 +))) 349 +))) 350 + 351 +((( 352 +((( 353 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 354 +))) 355 +))) 356 + 357 +((( 358 +((( 359 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 360 +))) 361 +))) 362 + 363 +((( 364 +((( 365 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 366 +))) 367 +))) 368 + 369 +((( 370 +((( 371 + "groups": [], ~/~/ Список ролей пользователя 372 +))) 373 +))) 374 + 375 +((( 376 +((( 377 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 378 +))) 379 +))) 380 + 381 +((( 382 +((( 383 + "authDevices": [ ], ~/~/ Список авторизованных устройств 384 +))) 385 +))) 386 + 387 +((( 388 +((( 389 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 390 +))) 391 +))) 392 + 393 +((( 394 +((( 395 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 396 +))) 397 +))) 398 + 399 +((( 400 +((( 401 +} 402 +))) 403 +))) 404 + 405 + 230 230 (% class="box warningmessage" %) 231 231 ((( 232 232 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -253,10 +253,10 @@ 253 253 "position": "" , ~/~/ должность 254 254 "phone": "" , ~/~/ телефон 255 255 "organization": "" , ~/~/ организация 256 - "login": "" , ~/~/ логин 257 - "password": "" , ~/~/ пароль ( при добавлении - обязателен, при редактировании, если null - менятьпарольне надо)258 - "email": "" , ~/~/ email 259 - "description": "" , ~/~/ описание 432 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 433 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 434 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 435 +(% 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 548 +((( 372 372 В теле ответа: 373 373 { 374 374 "errorMessages": [ ... ... @@ -381,6 +381,7 @@ 381 381 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 382 382 "users" - массив id пользователей, которых не удалось включить или отключить. 383 383 561 +))) 384 384 385 385 (% class="box errormessage" %) 386 386 ((( ... ... @@ -429,77 +429,149 @@ 429 429 430 430 (% style="color:#000000" %)Ответ: 431 431 610 +((( 432 432 { 612 +))) 433 433 614 +((( 434 434 "vehicleId": "", ~/~/ ID объекта 616 +))) 435 435 618 +((( 436 436 "name": "", ~/~/ Имя объекта 620 +))) 437 437 622 +((( 438 438 "imei": "", ~/~/ IMEI объекта 624 +))) 439 439 626 +((( 440 440 "deviceTypeId": , ~/~/ ID типа устройства 628 +))) 441 441 630 +((( 442 442 "deviceTypeName": "", ~/~/ Название типа устройства 632 +))) 443 443 634 +((( 444 444 "sim1": "", ~/~/ Номер SIM1 636 +))) 445 445 638 +((( 446 446 "parentId": "", Номер SIM2 640 +))) 447 447 642 +((( 448 448 "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 644 +))) 449 449 646 +((( 450 450 "modelId": "", ID модели объекта 648 +))) 451 451 650 +((( 452 452 "modelName": "", Имя модели объекта 652 +))) 453 453 654 +((( 454 454 "createdAt": "", Дата создания объекта 656 +))) 455 455 658 +((( 456 456 "mileageCalcMethod": "", Выбранный метод расчета пробега 660 +))) 457 457 662 +((( 458 458 "counters": { ~/~/ Нормы 664 +))) 459 459 666 +((( 460 460 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 668 +))) 461 461 670 +((( 462 462 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 672 +))) 463 463 674 +((( 464 464 "mileage": "", ~/~/ Пробег по нормам в метрах 676 +))) 465 465 678 +((( 466 466 "motohours": "" ~/~/ Моточасы по нормам, в секундах 680 +))) 467 467 682 +((( 468 468 }, 684 +))) 469 469 686 +((( 470 470 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 688 +))) 471 471 690 +((( 472 472 { 692 +))) 473 473 694 +((( 474 474 "id": "", ~/~/ ID задания 696 +))) 475 475 698 +((( 476 476 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 700 +))) 477 477 702 +((( 478 478 "name": "", ~/~/ Наименование задания 704 +))) 479 479 706 +((( 480 480 "description": "", ~/~/ Описание задания 708 +))) 481 481 710 +((( 482 482 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 712 +))) 483 483 714 +((( 484 484 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 716 +))) 485 485 718 +((( 486 486 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 720 +))) 487 487 722 +((( 488 488 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 724 +))) 489 489 726 +((( 490 490 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 728 +))) 491 491 730 +((( 492 492 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 732 +))) 493 493 734 +((( 494 494 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 736 +))) 495 495 738 +((( 496 496 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 740 +))) 497 497 742 +((( 498 498 } 744 +))) 499 499 746 +((( 500 500 ] 748 +))) 501 501 750 +((( 502 502 } 752 +))) 503 503 504 504 (% style="text-align:left" %) 505 505 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: