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
-
... ... @@ -3,11 +3,6 @@ 3 3 4 4 == == 5 5 6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]] 7 - 8 - 9 - 10 - 11 11 (% class="box" style="text-align: center;" %) 12 12 ((( 13 13 (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** ... ... @@ -250,31 +250,161 @@ 250 250 ((( 251 251 ((( 252 252 { 248 +))) 249 +))) 250 + 251 +((( 252 +((( 253 253 "id": "", ~/~/ GUID пользователя 254 - "lastName": "", ~/~/ Фамилия 254 +))) 255 +))) 256 + 257 +((( 258 +((( 259 + "lastName": "", ~/~/ Фамилия 260 +))) 261 +))) 262 + 263 +((( 264 +((( 255 255 "firstName": "", ~/~/ Имя 266 +))) 267 +))) 268 + 269 +((( 270 +((( 256 256 "position": "", ~/~/ Должность 272 +))) 273 +))) 274 + 275 +((( 276 +((( 257 257 "phone": "", ~/~/ Номер телефона 278 +))) 279 +))) 280 + 281 +((( 282 +((( 258 258 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 284 +))) 285 +))) 286 + 287 +((( 288 +((( 259 259 "parentName": "", Наименование клиента, которому принадлежит пользователь 290 +))) 291 +))) 292 + 293 +((( 294 +((( 260 260 "organization": "", ~/~/ Организация 296 +))) 297 +))) 298 + 299 +((( 300 +((( 261 261 "login": "", ~/~/ Логин пользователя 302 +))) 303 +))) 304 + 305 +((( 306 +((( 262 262 "email": "", ~/~/ Адрес электронной почты 308 +))) 309 +))) 310 + 311 +((( 312 +((( 263 263 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 314 +))) 315 +))) 316 + 317 +((( 318 +((( 264 264 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 320 +))) 321 +))) 322 + 323 +((( 324 +((( 265 265 "description": "", ~/~/ Описание 326 +))) 327 +))) 328 + 329 +((( 330 +((( 266 266 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 332 +))) 333 +))) 334 + 335 +((( 336 +((( 267 267 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 338 +))) 339 +))) 340 + 341 +((( 342 +((( 268 268 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 344 +))) 345 +))) 346 + 347 +((( 348 +((( 269 269 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 350 +))) 351 +))) 352 + 353 +((( 354 +((( 270 270 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 356 +))) 357 +))) 358 + 359 +((( 360 +((( 271 271 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 362 +))) 363 +))) 364 + 365 +((( 366 +((( 272 272 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 368 +))) 369 +))) 370 + 371 +((( 372 +((( 273 273 "groups": [], ~/~/ Список ролей пользователя 374 +))) 375 +))) 376 + 377 +((( 378 +((( 274 274 "customGroups": [], ~/~/ Список клиентских ролей пользователя 380 +))) 381 +))) 382 + 383 +((( 384 +((( 275 275 "authDevices": [ ], ~/~/ Список авторизованных устройств 386 +))) 387 +))) 388 + 389 +((( 390 +((( 276 276 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 392 +))) 393 +))) 394 + 395 +((( 396 +((( 277 277 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 398 +))) 399 +))) 400 + 401 +((( 402 +((( 278 278 } 279 279 ))) 280 280 ))) ... ... @@ -488,40 +488,145 @@ 488 488 489 489 ((( 490 490 { 616 +))) 617 + 618 +((( 491 491 "vehicleId": "", ~/~/ ID объекта 620 +))) 621 + 622 +((( 492 492 "name": "", ~/~/ Имя объекта 624 +))) 625 + 626 +((( 493 493 "imei": "", ~/~/ IMEI объекта 628 +))) 629 + 630 +((( 494 494 "deviceTypeId": , ~/~/ ID типа устройства 632 +))) 633 + 634 +((( 495 495 "deviceTypeName": "", ~/~/ Название типа устройства 636 +))) 637 + 638 +((( 496 496 "sim1": "", ~/~/ Номер SIM1 640 +))) 641 + 642 +((( 497 497 "parentId": "", Номер SIM2 498 - "parentName": "", Наименование клиента-родителя 644 +))) 645 + 646 +((( 647 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 648 +))) 649 + 650 +((( 499 499 "modelId": "", ID модели объекта 652 +))) 653 + 654 +((( 500 500 "modelName": "", Имя модели объекта 656 +))) 657 + 658 +((( 501 501 "createdAt": "", Дата создания объекта 660 +))) 661 + 662 +((( 502 502 "mileageCalcMethod": "", Выбранный метод расчета пробега 664 +))) 665 + 666 +((( 503 503 "counters": { ~/~/ Нормы 668 +))) 669 + 670 +((( 504 504 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 672 +))) 673 + 674 +((( 505 505 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 676 +))) 677 + 678 +((( 506 506 "mileage": "", ~/~/ Пробег по нормам в метрах 680 +))) 681 + 682 +((( 507 507 "motohours": "" ~/~/ Моточасы по нормам, в секундах 684 +))) 685 + 686 +((( 508 508 }, 688 +))) 689 + 690 +((( 509 509 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 692 +))) 693 + 694 +((( 510 510 { 511 - "id": "", ~/~/ ID задания 696 +))) 697 + 698 +((( 699 + "id": "", ~/~/ ID задания 700 +))) 701 + 702 +((( 512 512 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 704 +))) 705 + 706 +((( 513 513 "name": "", ~/~/ Наименование задания 708 +))) 709 + 710 +((( 514 514 "description": "", ~/~/ Описание задания 712 +))) 713 + 714 +((( 515 515 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 716 +))) 717 + 718 +((( 516 516 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 720 +))) 721 + 722 +((( 517 517 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 724 +))) 725 + 726 +((( 518 518 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 728 +))) 729 + 730 +((( 519 519 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 732 +))) 733 + 734 +((( 520 520 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 736 +))) 737 + 738 +((( 521 521 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 740 +))) 741 + 742 +((( 522 522 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 744 +))) 745 + 746 +((( 523 523 } 748 +))) 749 + 750 +((( 524 524 ] 752 +))) 753 + 754 +((( 525 525 } 526 526 ))) 527 527 ... ... @@ -684,6 +684,7 @@ 684 684 685 685 (% style="color:#000000" %)Параметры в теле запроса (JSON): 686 686 917 + 687 687 { 688 688 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 689 689 "name": null, ~/~/ Имя ТС (string, опционально) ... ... @@ -691,10 +691,15 @@ 691 691 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 692 692 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 693 693 "parentId": null, ~/~/ ID клиента (Guid, опционально) 694 - "unitId": null ,~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)695 - "customFields": null ~/~/ значение любого из произвольных полей ТС 925 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 926 + "customFields\": null ~/~/ значение любого из произвольных полей ТС 696 696 } 697 697 929 + 930 +((( 931 + 932 +))) 933 + 698 698 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 699 699 700 700 (% style="color:#000000" %)Ответ: ... ... @@ -717,16 +717,7 @@ 717 717 "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 718 718 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 719 719 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 720 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 721 - "customFields": [ 722 - { 723 - "id": "", ~/~/ идентификатор произвольного поля 724 - "name": "", ~/~/ имя произвольного поля 725 - "value": "", ~/~/ значение произвольного поля 726 - "forClient": true, ~/~/ право на отображение у клиента 727 - "forTooltip": false, ~/~/ право на отображение в подсказке 728 - "forReport": false ~/~/ право на отображение в отчетах 729 - }(%%) 956 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 730 730 (% style="color:#000000" %)} 731 731 732 732 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.