Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/20 09:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -436,7 +436,7 @@ 436 436 "email": "" , ~/~/ E-mail 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 - " lastLogged": "", ~/~/ дата/время последней авторизации439 + "astLogged": "", ~/~/ дата/время последней авторизации 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}**__integer($int32))706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 707 707 708 708 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 709 ... ... @@ -717,124 +717,20 @@ 717 717 "deviceTypeId": , ~/~/ ID типа устройства 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 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": "", ~/~/ Дата создания объекта 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" ~/~/ временная метка редактирования/обновления счетчика моточасов 732 732 }, 733 - 734 -"customFields": [ ~/~/ Произвольные поля 735 - { 736 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 737 - "name": "string", ~/~/ Имя поля 738 - "value": "string", ~/~/ Значение поля 739 - "forClient": true, ~/~/ Не используемая функция 740 - "forTooltip": true, ~/~/ Отображать в подсказке 741 - "forReport": true ~/~/ Отображать в отчете 742 - } 743 - 744 -], ~/~/ Данные с вкладки нормы 745 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 746 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 747 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 748 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 749 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 750 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 751 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 752 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 753 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 758 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 - "mileageCoeff": 0, ~/~/ коэффициент пробега 760 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 761 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 762 - "counters": { ~/~/ Счетчики 763 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 764 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 765 - "mileage": 0, ~/~/ Текущий пробег 766 - "motohours": 0, ~/~/ Текущие моточасы 767 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 768 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 769 - }, 770 - 771 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 772 - "id": "string", ~/~/ ID объекта 773 - "enabled": true, ~/~/ Включить, true - активна, false - не активна 774 - "host": "string", ~/~/ CMSV6 Web Host 775 - "login": "string", ~/~/ CMSV6 Account 776 - "password": "string" ~/~/ CMSV6 Password 777 - }, 778 - 779 -"commandTemplates": [ ~/~/ Шаблоны команд 780 - { 781 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 782 - "name": "string", ~/~/ Наименование команды 783 - "command": "string", ~/~/ Текст команды 784 - "retries": 0 ~/~/ Количество попыток 785 - } 786 - ], 787 - 788 - "sensors": [ ~/~/ Датчики 789 - { 790 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 791 - "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный 792 - "type": 0, ~/~/ Тип датчика 793 - "name": "string", ~/~/ Имя датчика 794 - "inputType": 0, ~/~/ Тип входа 795 - "inputNumber": 0, ~/~/ Номер входа 796 - "pseudonym": "string", ~/~/ Псевдоним 797 - "medianDegree": 0, ~/~/ Медианная фильтрация 798 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 799 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 800 - "gradeType": 0, 801 - "gradesTables": [ 802 - { 803 - "grades": [ 804 - { 805 - "input": 0, 806 - "output": 0 807 - } 808 - ], 809 - "relevanceTime": "2023-05-22T09:57:39.562Z" 810 - } 811 - ], 812 - "showInTooltip": true, 813 - "showLastValid": true, 814 - "showAsDutOnGraph": true, 815 - "showWithoutIgn": true, 816 - "agrFunction": 0, 817 - "expr": "string", 818 - "children": [ 819 - "string" 820 - ], 821 - "customParams": { 822 - "additionalProp1": "string", 823 - "additionalProp2": "string", 824 - "additionalProp3": "string" 825 - }, 826 - "summaryMaxValue": 0 827 - } 828 - 829 - "drivers": [ ~/~/ Водители 830 - { 831 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 832 - "name": "string", 833 - "description": "string", 834 - "isDefault": true 835 - } 836 - ], 837 - 838 838 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 839 839 { 840 840 "id": "", ~/~/ ID задания ... ... @@ -850,17 +850,7 @@ 850 850 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 851 851 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 852 852 } 853 - ], 854 - 855 - "statusHistory": [ ~/~/ История статусов 856 - { 857 - "status": 0, 858 - "date": "2023-05-22T09:57:39.562Z", 859 - "description": "string", 860 - "additionalInfo": "string" 861 - } 862 - ] 863 - 749 + ] 864 864 } 865 865 ))) 866 866 ... ... @@ -877,7 +877,7 @@ 877 877 (% lang="en-US" %)**POST /api/v3/vehicles** 878 878 ))) 879 879 880 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе. 881 881 882 882 (% style="color:#000000" %)Метод запроса: **POST** 883 883 ... ... @@ -1125,7 +1125,7 @@ 1125 1125 (% lang="en-US" %)**PUT /api/v3/vehicles** 1126 1126 ))) 1127 1127 1128 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе. 1129 1129 1130 1130 (% style="color:#000000" %)Метод запроса: **PUT** 1131 1131 ... ... @@ -1254,7 +1254,7 @@ 1254 1254 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1255 1255 ))) 1256 1256 1257 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса. 1258 1258 1259 1259 (% style="color:#000000" %)Метод запроса: **DELETE** 1260 1260 ... ... @@ -1416,10 +1416,7 @@ 1416 1416 1417 1417 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1418 1418 1419 -(% class="box infomessage" %) 1420 -((( 1421 -**POST /api/v3/notifications/find** 1422 -))) 1305 +POST /api/v3/notifications/find 1423 1423 1424 1424 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1425 1425 ... ... @@ -1440,22 +1440,19 @@ 1440 1440 1441 1441 [ 1442 1442 { 1443 - "id": 0, ~/~/ ID уведомления1444 - "name": "string", ~/~/ Название уведомления1445 - "active": true, ~/~/ Состояние true - активен, false - деактивирован1446 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО1447 - "userId": "", ~/~/ Пользователь, создавший уведомление1448 - "parentId": "", ~/~/ Идентификатор клиента1449 - "parentName": "string" ~/~/ Имя клиента1326 + "id": 0, 1327 + "name": "string", 1328 + "active": true, 1329 + "type": 0, 1330 + "userId": "", 1331 + "parentId": "", 1332 + "parentName": "string" 1450 1450 } 1451 1451 ] 1452 1452 1453 1453 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1454 1454 1455 -(% class="box infomessage" %) 1456 -((( 1457 -**GET /api/v3/notifications/{id}** 1458 -))) 1338 +GET /api/v3/notifications/{id} 1459 1459 1460 1460 Метод возвращает данные правил формирования выбранного уведомления. 1461 1461 ... ... @@ -1463,7 +1463,7 @@ 1463 1463 Метод запроса **GET** 1464 1464 1465 1465 (% style="text-align: left;" %) 1466 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1346 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]] 1467 1467 1468 1468 (% style="text-align: left;" %) 1469 1469 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1476,142 +1476,54 @@ 1476 1476 1477 1477 (% style="text-align: left;" %) 1478 1478 (% style="color:#000000" %){ 1479 - "id": 0, ~/~/ (%%)id уведомления 1480 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1481 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1482 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1483 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1484 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1485 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1486 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1487 -(% style="color:#000000" %) 0 1488 - ], 1489 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1490 -(% style="color:#000000" %) 0 1491 - ], 1492 - "fieldids": [ ~/~/ (%%)Список id полей для анализа 1493 -(% style="color:#000000" %) 0 1494 - ], 1495 - "settings": { ~/~/ Список параметров уведомления 1496 - "additionalProp1": "string", 1497 - "additionalProp2": "string", 1498 - "additionalProp3": "string" 1499 - }, 1500 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1501 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1502 -(% style="color:#000000" %) "" 1503 - ], 1504 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1505 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1506 -(% style="color:#000000" %) "string" 1507 - ], 1508 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1509 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1510 -(% style="color:#000000" %) { 1511 - "id": 0, ~/~/ (%%)Идентификатор участника чата 1512 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1513 -(% style="color:#000000" %) } 1514 - ], 1515 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1516 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1517 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1518 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1519 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1520 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1521 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1522 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1523 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1524 -(% style="color:#000000" %)} 1525 - 1526 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1527 - 1528 -(% class="box warningmessage" %) 1529 -((( 1530 -**PUT /api/v3/notifications/** 1531 -))) 1532 - 1533 -Метод позволяет отредактировать уведомление. 1534 - 1535 -Метод запроса **PUT** 1536 - 1537 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 1538 - 1539 -В заголовках запроса: X-Auth: Токен авторизации 1540 - 1541 -Тело запроса: 1542 -{ 1543 - "id": 0, ~/~/ id уведомления 1544 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1545 - "userId": "", ~/~/ Пользователь, создавший уведомление 1546 - "parentId": "", ~/~/ Идентификатор клиента 1547 - "parentName": "string", ~/~/ Имя клиента 1548 - "name": "string", ~/~/ Название уведомления 1549 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 1550 - "vehicleIds": [ ~/~/ Список id объектов для анализа 1359 + "id": 0, 1360 + "type": 0, 1361 + "userId": "", 1362 + "parentId": "", 1363 + "parentName": "string", 1364 + "name": "string", 1365 + "active": true, 1366 + "vehicleIds": [ 1551 1551 0 1552 1552 ], 1553 - ~/~/ Список id геообъектов для анализа1369 + "geoids": [ 1554 1554 0 1555 1555 ], 1556 - "fieldids": [ ~/~/ Список id полей для анализа1372 + "fieldids": [ 1557 1557 0 1558 1558 ], 1559 - "settings": { ~/~/ Список параметров уведомления1375 + "settings": { 1560 1560 "additionalProp1": "string", 1561 1561 "additionalProp2": "string", 1562 1562 "additionalProp3": "string" 1563 1563 }, 1564 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"1565 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила1380 + "toEmail": true, 1381 + "recipientIds": [ 1566 1566 "" 1567 1567 ], 1568 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"1569 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений1384 + "enableSideEmails": true, 1385 + "sideEmails": [ 1570 1570 "string" 1571 1571 ], 1572 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram1573 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.1388 + "toTelegram": true, 1389 + "telegrams": [ 1574 1574 { 1575 - "id": 0, ~/~/ Идентификатор участника чата1576 - "info": "string" ~/~/ Дополнительные сведения1391 + "id": 0, 1392 + "info": "string" 1577 1577 } 1578 1578 ], 1579 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение1580 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы1581 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.1582 - "kind": 0, ~/~/ Определяет вид уведомления1583 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время1584 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)1585 - "timezone": 0, ~/~/ Сдвиг часового пояса1586 - "validity": 0, ~/~/ Срок действия в днях (1-90)1587 - "autoProlongation": true ~/~/ Автопродление срока действия1395 + "toMobile": true, 1396 + "toClient": true, 1397 + "stored": true, 1398 + "kind": 0, 1399 + "activationMode": 0, 1400 + "activationTime": "2023-03-29T09:57:48.932Z", 1401 + "timezone": 0, 1402 + "validity": 0, 1403 + "autoProlongation": true 1588 1588 } 1589 1589 1590 -Ответ: 1591 1591 1592 -Success 1593 - 1594 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1595 - 1596 -(% class="box errormessage" %) 1597 -((( 1598 -**DELETE /api/v3/notifications/{id}** 1599 -))) 1600 - 1601 -Метод позволяет удалить выбранное уведомление. 1602 - 1603 -Метод запроса **DELETE** 1604 - 1605 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1606 - 1607 -Передаваемый параметр: {id} - id уведомления 1608 - 1609 -В заголовках запроса: X-Auth: Токен авторизации 1610 - 1611 -Ответ: 1612 - 1613 -Success 1614 - 1615 1615 (% class="box" lang="en-US" style="text-align: center;" %) 1616 1616 ((( 1617 1617 (% 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]] **