Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 85.1 >
edited by Илья Крайнов
on 2023/03/29 18:03
To version < 89.1 >
edited by Илья Крайнов
on 2023/05/22 14:23
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -436,7 +436,7 @@
436 436   "email": "" , ~/~/ E-mail
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
440 440  
441 441  (% style="color:#000000" %)}
442 442  
... ... @@ -701,9 +701,9 @@
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
705 705  
706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
... ... @@ -717,20 +717,123 @@
717 717   "deviceTypeId": , ~/~/ ID типа устройства
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 - "parentId": "", Номер SIM2
721 - "parentName": "", Наименование клиента-родителя
722 - "modelId": "", ID модели объекта
723 - "modelName": "", Имя модели объекта
724 - "createdAt": "", Дата создания объекта
725 - "mileageCalcMethod": "", Выбранный метод расчета пробега
726 - "counters": { ~/~/ Нормы
727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 - "mileage": "", ~/~/ Пробег по нормам в метрах
730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
720 + "sim2": "", ~/~/ Номер SIM2
721 +
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
733 733   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
737 + "name": "string",
738 + "value": "string",
739 + "forClient": true,
740 + "forTooltip": true,
741 + "forReport": true
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": 0,
746 + "consumptionPerHour": 0,
747 + "consumptionIdle": 0,
748 + "consumptionPer100KmSeasonal": 0,
749 + "consumptionPerHourSeasonal": 0,
750 + "consumptionIdleSeasonal": 0,
751 + "consumptionPer100KmSeasonalBegin": "2023-05-22T09:57:39.562Z",
752 + "consumptionPer100KmSeasonalEnd": "2023-05-22T09:57:39.562Z",
753 + "consumptionPerHourSeasonalBegin": "2023-05-22T09:57:39.562Z",
754 + "consumptionPerHourSeasonalEnd": "2023-05-22T09:57:39.562Z",
755 + "consumptionIdleSeasonalBegin": "2023-05-22T09:57:39.562Z",
756 + "consumptionIdleSeasonalEnd": "2023-05-22T09:57:39.562Z",
757 + "mileageCalcMethod": 0,
758 + "mileageCoeff": 0,
759 + "locationByCellId": true,
760 + "dottedLineTrackWhenNoCoords": true,
761 + "counters": {
762 + "mileageEnabled": true,
763 + "motohoursEnabled": true,
764 + "mileage": 0,
765 + "motohours": 0,
766 + "mileageTime": "2023-05-22T09:57:39.562Z",
767 + "motohoursTime": "2023-05-22T09:57:39.562Z"
768 + },
769 +
770 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
771 + "id": "string",
772 + "enabled": true,
773 + "host": "string",
774 + "login": "string",
775 + "password": "string"
776 + },
777 +
778 +"commandTemplates": [ ~/~/ Шаблоны команд
779 + {
780 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
781 + "name": "string",
782 + "command": "string",
783 + "retries": 0
784 + }
785 + ],
786 +
787 + "sensors": [ ~/~/ Датчики
788 + {
789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
790 + "kind": 0,
791 + "type": 0,
792 + "name": "string",
793 + "inputType": 0,
794 + "inputNumber": 0,
795 + "pseudonym": "string",
796 + "medianDegree": 0,
797 + "isInverted": true,
798 + "disabled": true,
799 + "gradeType": 0,
800 + "gradesTables": [
801 + {
802 + "grades": [
803 + {
804 + "input": 0,
805 + "output": 0
806 + }
807 + ],
808 + "relevanceTime": "2023-05-22T09:57:39.562Z"
809 + }
810 + ],
811 + "showInTooltip": true,
812 + "showLastValid": true,
813 + "showAsDutOnGraph": true,
814 + "showWithoutIgn": true,
815 + "agrFunction": 0,
816 + "expr": "string",
817 + "children": [
818 + "string"
819 + ],
820 + "customParams": {
821 + "additionalProp1": "string",
822 + "additionalProp2": "string",
823 + "additionalProp3": "string"
824 + },
825 + "summaryMaxValue": 0
826 + }
827 +
828 + "drivers": [ ~/~/ Водители
829 + {
830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
831 + "name": "string",
832 + "description": "string",
833 + "isDefault": true
834 + }
835 + ],
836 +
734 734   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 735   {
736 736   "id": "", ~/~/ ID  задания
... ... @@ -746,7 +746,17 @@
746 746   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
747 747   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
748 748   }
749 - ]
852 + ],
853 +
854 + "statusHistory": [ ~/~/ История статусов
855 + {
856 + "status": 0,
857 + "date": "2023-05-22T09:57:39.562Z",
858 + "description": "string",
859 + "additionalInfo": "string"
860 + }
861 + ]
862 +
750 750  }
751 751  )))
752 752  
... ... @@ -763,7 +763,7 @@
763 763  (% lang="en-US" %)**POST /api/v3/vehicles**
764 764  )))
765 765  
766 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
879 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
767 767  
768 768  (% style="color:#000000" %)Метод запроса: **POST**
769 769  
... ... @@ -1011,7 +1011,7 @@
1011 1011  (% lang="en-US" %)**PUT /api/v3/vehicles**
1012 1012  )))
1013 1013  
1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
1127 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1015 1015  
1016 1016  (% style="color:#000000" %)Метод запроса: **PUT**
1017 1017  
... ... @@ -1140,7 +1140,7 @@
1140 1140  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1141 1141  )))
1142 1142  
1143 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
1256 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1144 1144  
1145 1145  (% style="color:#000000" %)Метод запроса: **DELETE**
1146 1146  
... ... @@ -1349,7 +1349,7 @@
1349 1349  Метод запроса **GET**
1350 1350  
1351 1351  (% style="text-align: left;" %)
1352 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
1465 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1353 1353  
1354 1354  (% style="text-align: left;" %)
1355 1355  (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
... ... @@ -1409,15 +1409,6 @@
1409 1409  (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 1410  (% style="color:#000000" %)}
1411 1411  
1412 -== (% style="color:#000000; font-size:16px" %)**Добавление уведомления**(%%) ==
1413 -
1414 -(% class="box successmessage" %)
1415 -(((
1416 -**POST /api/v3/notifications/**
1417 -)))
1418 -
1419 -Метод возвращает
1420 -
1421 1421  == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1422 1422  
1423 1423  (% class="box warningmessage" %)
... ... @@ -1425,8 +1425,67 @@
1425 1425  **PUT /api/v3/notifications/**
1426 1426  )))
1427 1427  
1428 -Метод возвращает
1532 +Метод позволяет отредактировать уведомление.
1429 1429  
1534 +Метод запроса **PUT**
1535 +
1536 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1537 +
1538 +В заголовках запроса: X-Auth: Токен авторизации
1539 +
1540 +Тело запроса:
1541 +{
1542 + "id": 0, ~/~/ id уведомления
1543 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1544 + "userId": "", ~/~/ Пользователь, создавший уведомление
1545 + "parentId": "", ~/~/ Идентификатор клиента
1546 + "parentName": "string", ~/~/ Имя клиента
1547 + "name": "string", ~/~/ Название уведомления
1548 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1549 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1550 + 0
1551 + ],
1552 + "geoids": [ ~/~/ Список id геообъектов для анализа
1553 + 0
1554 + ],
1555 + "fieldids": [ ~/~/ Список id полей для анализа
1556 + 0
1557 + ],
1558 + "settings": { ~/~/ Список параметров уведомления
1559 + "additionalProp1": "string",
1560 + "additionalProp2": "string",
1561 + "additionalProp3": "string"
1562 + },
1563 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1564 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1565 + ""
1566 + ],
1567 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1568 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1569 + "string"
1570 + ],
1571 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1572 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1573 + {
1574 + "id": 0, ~/~/ Идентификатор участника чата
1575 + "info": "string" ~/~/ Дополнительные сведения
1576 + }
1577 + ],
1578 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1579 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1580 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1581 + "kind": 0, ~/~/ Определяет вид уведомления
1582 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1583 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1584 + "timezone": 0, ~/~/ Сдвиг часового пояса
1585 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1586 + "autoProlongation": true ~/~/ Автопродление срока действия
1587 +}
1588 +
1589 +Ответ:
1590 +
1591 +Success
1592 +
1430 1430  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1431 1431  
1432 1432  (% class="box errormessage" %)
... ... @@ -1434,9 +1434,20 @@
1434 1434  **DELETE /api/v3/notifications/{id}**
1435 1435  )))
1436 1436  
1437 -Метод возвращает
1600 +Метод позволяет удалить выбранное уведомление.
1438 1438  
1602 +Метод запроса **DELETE**
1439 1439  
1604 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1605 +
1606 +Передаваемый параметр: {id} - id уведомления
1607 +
1608 +В заголовках запроса: X-Auth: Токен авторизации
1609 +
1610 +Ответ:
1611 +
1612 +Success
1613 +
1440 1440  (% class="box" lang="en-US" style="text-align: center;" %)
1441 1441  (((
1442 1442  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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