Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -509,11 +509,11 @@ 509 509 510 510 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 511 511 512 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;512 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 513 513 514 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;514 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 515 515 516 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.516 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 517 517 518 518 (% style="color:#000000" %)Метод запроса: **POST** 519 519 ... ... @@ -538,31 +538,12 @@ 538 538 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 539 539 (% style="color:#000000" %)} 540 540 541 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 542 542 543 -(% style="color:#000000" %)Ответ: 543 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 544 544 545 -(% style="color:#000000" %) {545 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 546 546 547 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 548 - "name": "" ~/~/ наименование объекта 549 - "imei": "" ~/~/ IMEI объекта 550 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 551 - "deviceTypeName": "" ~/~/ наименование типа устройства 552 - "sim1": "" ~/~/ первый номер телефона 553 - "sim2": "" ~/~/ второй номер телефона 554 - "parentId": "" ~/~/ идентификатор клиента-родителя 555 - "parentName": "" ~/~/ наименование клиента-родителя 556 - "modelId": "" ~/~/ идентификатор модели объекта 557 - "modelName": "" ~/~/ наименование модели объекта 558 - "unitId": "" ~/~/ идентификатор подразделения 559 - "unitName": "" ~/~/ наименование подразделения 560 - "status": "" ~/~/ статус объекта 561 - "createdAt": "" ~/~/ дата создания объектов (%%) 562 -(% style="color:#000000" %)} 563 - 564 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 565 - 566 566 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 567 567 568 568 ... ... @@ -581,32 +581,30 @@ 581 581 582 582 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 583 583 584 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 565 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 585 585 586 -(% style="color:#000000" %){ 567 +(% class="western" %) 568 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 569 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 570 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 571 + "date": "", // Дата смены статуса (null если сменить немедленно) 572 + "description": "", // Описание 573 + "data": "", // Данные 574 + "overwrite": false, // Флаг перезаписи 575 + "stage": "", // Состояние, может быть null}}} 587 587 588 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 589 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 590 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 591 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 592 - "description": "", ~/~/ Описание 593 - "data": "", ~/~/ Данные 594 - "overwrite": false, ~/~/ Флаг перезаписи 595 - "stage": "", ~/~/ Состояние, может быть null 577 +(% style="color:#000000" %)} 596 596 597 - }579 +(% style="color:#000000" %)Ответ: { 598 598 599 -(% style="color:#000000" %)Ответ: 581 +(% class="western" %) 582 +{{{ "status": "", // значение статуса 583 + "date": "", // Дата смены статуса 584 + "description": "", // Описание 585 + "data": "", // Данные 586 + "overwrite": false, // Флаг перезаписи 587 + "stage": "", // Состояние}}} 600 600 601 -(% style="color:#000000" %){ 602 - 603 - "status": "", ~/~/ значение статуса 604 - "date": "", ~/~/ Дата смены статуса 605 - "description": "", ~/~/ Описание 606 - "data": "", ~/~/ Данные 607 - "overwrite": false, ~/~/ Флаг перезаписи 608 - "stage": "", ~/~/ Состояние 609 - 610 610 (% style="text-align:left" %) 611 611 (% style="color:#000000" %)} 612 612 ... ... @@ -626,51 +626,8 @@ 626 626 627 627 (% style="color:#000000" %)Параметры в теле запроса (JSON): 628 628 629 -(% style="color:#000000" %) { 608 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 630 630 631 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 632 - "parentId": "", ~/~/ ID клиента 633 - "name": "", ~/~/ имя ТС 634 - "imei": "", ~/~/ IMEI 635 - "deviceTypeId": "", ~/~/ ID типа устройства 636 - "modelId": "", ~/~/ , ID модели 637 - "unitId": "", ~/~/ подразделения 638 - "sim1": "", ~/~/ SIM 1 639 - "sim2": "", ~/~/ SIM2 640 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 641 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 642 - "counters": 643 - { 644 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 645 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 646 - "mileage": «», пробег 647 - "motohours": «» моточасы 648 - } 649 - "cmsv6Parameters": ~/~/ параметры CMSv6 650 - { 651 - "id": "", ~/~/ идентификатор 652 - "enabled": true, ~/~/ флаг включения 653 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 654 - "login": "", ~/~/ имя учетной записи 655 - "password": "", ~/~/ пароль учетной записи 656 - } 657 - "inspectionTasks": ~/~/ задания на ТО 658 - { 659 - "id": "", ~/~/ ID задания 660 - "enabled": false, ~/~/ Признак включения 661 - "name": "", ~/~/ Имя задания 662 - "description": "", ~/~/ Описание задания 663 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 664 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 665 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 666 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 667 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 668 - "kind": "", ~/~/ Вид периодичности по времени 669 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 670 - } 671 - 672 -(% style="color:#000000" %)} 673 - 674 674 (% style="color:#000000" %)Ответ: 675 675 676 676 (% lang="en-US" style="text-align:left" %)