Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/07/29 15:51
<
>
отредактировано Андрей Калиновский
на 2025/04/21 14:04
на 2025/04/21 14:04
отредактировано Андрей Калиновский
на 2025/07/03 16:18
на 2025/07/03 16:18
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -454,7 +454,7 @@ 454 454 [ 455 455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 456 456 ], 457 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский457 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 458 458 } 459 459 { 460 460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -766,6 +766,9 @@ 766 766 (% style="text-align:left" %) 767 767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 768 768 769 +(% class="wikigeneratedid" %) 770 += = 771 + 769 769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 770 770 771 771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -877,7 +877,7 @@ 877 877 { 878 878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 - "deleted": true,883 + "deleted": false, 881 881 "extId": "string", 882 882 "name": "string", 883 883 "picture": "string", ... ... @@ -896,7 +896,7 @@ 896 896 { 897 897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 - "deleted": true,902 + "deleted": false, 900 900 "extId": "string", 901 901 "name": "string", 902 902 "picture": "string", ... ... @@ -930,7 +930,7 @@ 930 930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 931 ))) 932 932 933 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.936 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 934 934 935 935 (% style="color:#000000" %)Метод запроса: **PUT** 936 936 ... ... @@ -997,7 +997,7 @@ 997 997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 998 ))) 999 999 1000 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1003 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 1001 1001 1002 1002 (% style="color:#000000" %)Метод запроса: **DELETE** 1003 1003 ... ... @@ -1628,77 +1628,6 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -== **Импортировать историю ТС (Асинхронный запрос)** == 1632 - 1633 -(% class="box successmessage" %) 1634 -((( 1635 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 -))) 1637 - 1638 -Метод запроса: **POST** 1639 - 1640 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1641 - 1642 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1643 - 1644 - 1645 -Ответ: 1646 - 1647 -{ 1648 - 1649 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1650 - 1651 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1652 - 1653 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1654 - 1655 - "Message": "string", ~/~/ Информация о выполнении запроса 1656 - 1657 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1658 - 1659 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1660 - 1661 - "Data": "string" ~/~/ Данные 1662 - 1663 -} 1664 - 1665 - 1666 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1667 - 1668 -(% class="box infomessage" %) 1669 -((( 1670 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1671 -))) 1672 - 1673 -Метод запроса: **GET** 1674 - 1675 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1676 - 1677 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1678 - 1679 - 1680 -Ответ: 1681 - 1682 -{ 1683 - 1684 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1685 - 1686 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1687 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1688 - 1689 - "Message": "string", ~/~/ Информация о выполнении запроса 1690 - 1691 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1692 - 1693 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1694 - 1695 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1696 - 1697 - "Data": "string" ~/~/ Данные 1698 - 1699 -} 1700 - 1701 - 1702 1702 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1703 1703 1704 1704 (% class="box infomessage" %) ... ... @@ -1844,7 +1844,6 @@ 1844 1844 "stage": "", ~/~/ Состояние 1845 1845 (% style="color:#000000" %) } 1846 1846 1847 -== == 1848 1848 1849 1849 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1850 1850 ... ... @@ -2527,6 +2527,8 @@ 2527 2527 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2528 2528 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2529 2529 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2461 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2462 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2530 2530 "fuelConsumption": 0, ~/~/ Расход топлива 2531 2531 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2532 2532 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2656,26 +2656,50 @@ 2656 2656 В заголовках запроса: X-Auth: Токен авторизации 2657 2657 2658 2658 2659 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2592 +В массиве указываем id объектов через запятую 2660 2660 2661 2661 Ответ: 2595 + 2596 +[ 2662 2662 { 2663 - "vehicleId": 0, ~/~/Идентификатор объекта.2664 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2665 - "vehicleNumber": " string",~/~/Номер объекта.2666 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2667 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2668 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2669 - "speed": 0,~/~/Скорость объекта.2670 - "course": 0,~/~/Курс движения [0;360]2671 - "latitude": 0,~/~/Широта [-90°;90°].2672 - "longitude": 0,~/~/Долгота [-180°;180°]. 2673 - "address": " string",~/~/Адрес.2674 - "geozones": [ ~/~/Сведения по геозонам. 2598 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2599 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2600 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2601 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2602 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2603 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2604 + "speed": 31, ~/~/ Скорость объекта 2605 + "course": 116, ~/~/ Курс движения [0;360] 2606 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2607 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2608 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2609 + "geozones": [ ~/~/ Сведения по геозонам. 2675 2675 { 2676 - "id": 0, 2677 - "name": "string" 2611 + "id": 10225647, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2613 + }, 2614 + { 2615 + "id": 10282875, ~/~/ ID Геозоны 2616 + "name": "Ё2" ~/~/ Наименование геозоны 2617 + }, 2618 + { 2619 + "id": 10226240, ~/~/ ID Геозоны 2620 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2621 + }, 2622 + { 2623 + "id": 9747869, ~/~/ ID Геозоны 2624 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2625 + }, 2626 + { 2627 + "id": 10221123, ~/~/ ID Геозоны 2628 + "name": "53r" ~/~/ Наименование геозоны 2629 + }, 2630 + { 2631 + "id": 10197638, ~/~/ ID Геозоны 2632 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2678 2678 } 2634 + ] 2635 + } 2679 2679 2680 2680 2681 2681 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2806,6 +2806,35 @@ 2806 2806 } 2807 2807 ] 2808 2808 2766 + 2767 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2768 + 2769 +(% class="box successmessage" %) 2770 +((( 2771 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2772 +))) 2773 + 2774 +(% style="color:#000000" %)Метод запроса: **PUT** 2775 + 2776 +Пример запроса: 2777 + 2778 +((( 2779 +{ 2780 + "id": 0, ~/~/ Идентификатор объекта геозоны 2781 + "name": "string", ~/~/ Наименование объекта геозоны 2782 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2783 + "description": "string", ~/~/ Описание объекта геозоны 2784 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2785 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2786 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2787 +} 2788 +))) 2789 + 2790 + 2791 +Пример ответа: 2792 + 2793 +200 ~/~/ Success 2794 + 2809 2809 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2810 2810 2811 2811 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2837,7 +2837,7 @@ 2837 2837 "id": 0, ~/~/ ID уведомления 2838 2838 "name": "string", ~/~/ Название уведомления 2839 2839 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2840 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2841 2841 "userId": "", ~/~/ Пользователь, создавший уведомление 2842 2842 "parentId": "", ~/~/ Идентификатор клиента 2843 2843 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2844,6 +2844,155 @@ 2844 2844 } 2845 2845 ] 2846 2846 2833 + 2834 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2835 + 2836 +(% class="box infomessage" %) 2837 +((( 2838 +**POST /api/v3/notifications** 2839 +))) 2840 + 2841 +Метод запроса **POST** 2842 + 2843 +(% style="text-align: left;" %) 2844 +(% style="color:#000000" %)Пример запроса 2845 + 2846 +((( 2847 +{ 2848 + "id": 0, ~/~/ ID правила 2849 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2850 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2852 + "name": "string", ~/~/ Имя правила 2853 + "active": true, ~/~/ Активность правила 2854 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2855 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2856 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2857 + ], 2858 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2859 + 0 2860 + ], 2861 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2862 + 0 2863 + ], 2864 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2865 + 0 2866 + ], 2867 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2868 + "additionalProp1": "string", 2869 + "additionalProp2": "string", 2870 + "additionalProp3": "string" 2871 + }, 2872 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2873 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2874 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2875 + ], 2876 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2877 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2878 + "string" 2879 + ], 2880 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2881 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2882 + { 2883 + "id": 0, ~/~/ Идентификатор участника чата. 2884 + "info": "string" ~/~/ Дополнительные сведения. 2885 + } 2886 + ], 2887 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2888 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2889 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2890 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2891 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2892 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2893 + "timezone": 0, ~/~/ часовой пояс 2894 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2895 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2896 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2897 + { 2898 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2899 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2900 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2901 + "additionalProp1": "string", 2902 + "additionalProp2": "string", 2903 + "additionalProp3": "string" 2904 + } 2905 + } 2906 + ] 2907 +} 2908 +))) 2909 + 2910 +((( 2911 + 2912 +))) 2913 + 2914 +((( 2915 + 2916 +))) 2917 + 2918 +Ответ: 2919 + 2920 +{ 2921 + "id": 0, ~/~/ ID правила 2922 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2923 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2924 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2925 + "name": "string", ~/~/ Имя правила 2926 + "active": true, ~/~/ Активность правила 2927 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2928 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2929 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2930 + ], 2931 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2932 + 0 2933 + ], 2934 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2935 + 0 2936 + ], 2937 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2938 + 0 2939 + ], 2940 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2941 + "additionalProp1": "string", 2942 + "additionalProp2": "string", 2943 + "additionalProp3": "string" 2944 + }, 2945 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2946 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2947 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2948 + ], 2949 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2950 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2951 + "string" 2952 + ], 2953 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2954 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2955 + { 2956 + "id": 0, ~/~/ Идентификатор участника чата. 2957 + "info": "string" ~/~/ Дополнительные сведения. 2958 + } 2959 + ], 2960 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2961 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2962 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2963 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2964 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2965 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2966 + "timezone": 0, ~/~/ часовой пояс 2967 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2968 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2969 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2970 + { 2971 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2972 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2973 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2974 + "additionalProp1": "string", 2975 + "additionalProp2": "string", 2976 + "additionalProp3": "string" 2977 + } 2978 + } 2979 + ] 2980 +} 2981 + 2847 2847 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2848 2848 2849 2849 (% class="box infomessage" %) ... ... @@ -4061,16 +4061,12 @@ 4061 4061 Тело запроса: 4062 4062 4063 4063 { 4064 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4065 - "Balance": 0 4199 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4200 + "Balance": 0 ~/~/ Значение баланса. 4066 4066 } 4067 4067 4068 4068 Ответ: Success 4069 4069 4070 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4071 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4072 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4073 - 4074 4074 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4075 4075 4076 4076 (% class="box warningmessage" %) ... ... @@ -4082,16 +4082,29 @@ 4082 4082 4083 4083 Тело запроса: 4084 4084 4216 +((( 4085 4085 { 4086 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4087 - " Balance": 04218 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4219 + "amount": 0 ~/~/ Сумма пополнения баланса 4088 4088 } 4221 +))) 4089 4089 4223 +((( 4224 + 4225 +))) 4226 + 4090 4090 Ответ: Success 4091 4091 4092 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4094 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4229 +((( 4230 +{ 4231 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4232 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4233 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4234 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4235 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4236 + "Description": "string" ~/~/ Описание корректировки. 4237 +} 4238 +))) 4095 4095 4096 4096 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4097 4097 ... ... @@ -4104,16 +4104,25 @@ 4104 4104 4105 4105 Тело запроса: 4106 4106 4251 +((( 4107 4107 { 4108 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4109 - " Balance": 04253 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4254 + "amount": 0 ~/~/ Сумма списания с баланса 4110 4110 } 4256 +))) 4111 4111 4112 4112 Ответ: Success 4113 4113 4114 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4115 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4116 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4260 +((( 4261 +{ 4262 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4263 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4264 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4265 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4266 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4267 + "Description": "string" ~/~/ Описание корректировки 4268 +} 4269 +))) 4117 4117 4118 4118 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4119 4119 ... ... @@ -4124,28 +4124,35 @@ 4124 4124 4125 4125 Тело запроса: 4126 4126 4280 +((( 4127 4127 { 4128 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4129 - "CalculationType": 0, 4130 - "PermissibleBalance": 0, 4131 - "DefermentDays": 0, 4132 - "SendUiNotifications": true, 4133 - "SendEmailNotifications": true, 4134 - "IsPrivate": true, 4282 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4283 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4284 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4285 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4286 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4287 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4135 4135 } 4289 +))) 4136 4136 4291 +((( 4292 + 4293 +))) 4294 + 4137 4137 Ответ: Success 4138 4138 4139 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4140 -|ClientId|Идентификатор клиента 4141 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4142 -|PermissibleBalance|Допустимый баланс 4143 -|DefermentDays|((( 4144 -Отсрочка, количество дней 4297 +((( 4298 +{ 4299 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4300 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4301 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4302 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4303 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4304 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4305 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4306 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4307 +} 4145 4145 ))) 4146 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4147 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4148 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4149 4149 4150 4150 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4151 4151 ... ... @@ -4157,35 +4157,68 @@ 4157 4157 Тело запроса: 4158 4158 4159 4159 { 4160 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4161 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4162 - "Features": [ 4320 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4321 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4322 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4163 4163 { 4164 - "Feature": "string", 4165 - "IsEnabled": true, 4166 - "IsFactual": true, 4167 - "Limit": 0, 4168 - "Price": 0, 4169 - "DebitDate": "2023-10-18T13:26:58.987Z", 4170 - "PeriodValue": 0, 4171 - "PeriodType": 0 4324 + "Feature": "string", ~/~/ Код услуги. 4325 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4326 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4327 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4328 + "Price": 0, ~/~/ Цена за единицу. 4329 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4330 + "PeriodValue": 0, ~/~/ Значение периода. 4331 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4172 4172 } 4173 4173 ] 4174 4174 } 4175 4175 4336 + 4176 4176 Ответ: Success 4177 4177 4178 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4179 -|ClientId|Идентификатор клиента 4180 -|PlanId|Идентификатор тарифного плана 4181 -|Feature|Код услуги 4182 -|IsEnabled|Признак, определяющий активирована ли услуга 4183 -|IsFactual|Признак, определяющий расчёт по факту 4184 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4185 -|Price|Цена за единицу. 4186 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4187 -|PeriodValue|Значение периода. 4188 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4339 +((( 4340 +{ 4341 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4342 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4343 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4344 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4345 + "Name": "string", ~/~/ Наименование. 4346 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4347 + "Constraint": { ~/~/ Ограничения по тарифу 4348 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4349 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4350 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4351 + }, 4352 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4353 + { 4354 + "Feature": "string", ~/~/Код услуги. 4355 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4356 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4357 + "Price": 0, ~/~/ Цена за единицу. 4358 + "PeriodValue": 0, ~/~/ Значение периода. 4359 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4360 + } 4361 + ], 4362 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4363 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4364 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4365 + }, 4366 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4367 + { 4368 + "Feature": "string", ~/~/ Код услуги. 4369 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4370 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4371 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4372 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4373 + "Price": 0, ~/~/ Цена за единицу. 4374 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4375 + "PeriodValue": 0, ~/~/ Значение периода. 4376 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4377 + "Quantity": 0 ~/~/ Количество использования услуги. 4378 + } 4379 + ] 4380 +} 4381 +))) 4189 4189 4190 4190 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4191 4191 ... ... @@ -4290,6 +4290,43 @@ 4290 4290 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4291 4291 |msgCount|Кол-во обработанных сообщений всего 4292 4292 4486 +== **Импортировать историю ТС (Асинхронный запрос)** == 4487 + 4488 +(% class="box successmessage" %) 4489 +((( 4490 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4491 +))) 4492 + 4493 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4494 + 4495 +Метод запроса: **POST** 4496 + 4497 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4498 + 4499 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4500 + 4501 + 4502 +Ответ: 4503 + 4504 +{ 4505 + 4506 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4507 + 4508 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4509 + 4510 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4511 + 4512 + "Message": "string", ~/~/ Информация о выполнении запроса 4513 + 4514 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4515 + 4516 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4517 + 4518 + "Data": "string" ~/~/ Данные 4519 + 4520 +} 4521 + 4522 + 4293 4293 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4294 4294 4295 4295 (% class="box infomessage" %) ... ... @@ -4307,10 +4307,59 @@ 4307 4307 "message": "string" 4308 4308 } 4309 4309 4310 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4311 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4312 -|progress|Guid ТС 4540 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4541 +**Параметр** 4542 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4543 +**Описание** 4544 +))) 4545 +|((( 4546 +activity 4547 +)))|((( 4548 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4549 +))) 4550 +|((( 4551 +progress 4552 +)))|((( 4553 +Guid ТС 4554 +))) 4313 4313 4556 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4557 + 4558 +(% class="box infomessage" %) 4559 +((( 4560 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4561 +))) 4562 + 4563 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4564 + 4565 +Метод запроса: **GET** 4566 + 4567 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4568 + 4569 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4570 + 4571 + 4572 +Ответ: 4573 + 4574 +{ 4575 + 4576 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4577 + 4578 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4579 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4580 + 4581 + "Message": "string", ~/~/ Информация о выполнении запроса 4582 + 4583 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4584 + 4585 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4586 + 4587 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4588 + 4589 + "Data": "string" ~/~/ Данные 4590 + 4591 +} 4592 + 4314 4314 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4315 4315 4316 4316 (% class="box infomessage" %) ... ... @@ -4841,7 +4841,7 @@ 4841 4841 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4842 4842 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4843 4843 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4844 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение ;2-фиксированный;)5123 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4845 4845 } 4846 4846 ))) 4847 4847 ... ... @@ -5871,6 +5871,62 @@ 5871 5871 ))) 5872 5872 5873 5873 6153 += **Раздел: Роли** = 6154 + 6155 +== **Получение списка клиентских и системных ролей пользователя ** == 6156 + 6157 +(% class="box successmessage" %) 6158 +((( 6159 +**POST /api/v3/groups/find** 6160 +))) 6161 + 6162 +Пример запроса: 6163 + 6164 +((( 6165 +{ 6166 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6167 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6168 +} 6169 +))) 6170 + 6171 +((( 6172 + 6173 +))) 6174 + 6175 +((( 6176 +Пример ответа: 6177 +))) 6178 + 6179 +((( 6180 +((( 6181 +{ 6182 + "groups": [ ~/~/ Системные роли пользователя 6183 + { 6184 + "code": "string", ~/~/ Код роли. 6185 + "name": "string", ~/~/ Имя 6186 + "shortName": "string" ~/~/ Короткое имя 6187 + } 6188 + ], 6189 + "customGroups": [ ~/~/ Системные роли пользователя 6190 + { 6191 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6192 + "name": "string", ~/~/ Наименование 6193 + "shortName": "string", ~/~/ Короткое наименование 6194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6195 + } 6196 + ] 6197 +} 6198 +))) 6199 +))) 6200 + 6201 +((( 6202 + 6203 +))) 6204 + 6205 +((( 6206 + 6207 +))) 6208 + 5874 5874 = **Раздел: Локатор ** = 5875 5875 5876 5876 ... ... @@ -5878,7 +5878,7 @@ 5878 5878 5879 5879 (% class="box infomessage" %) 5880 5880 ((( 5881 -**GET /api/v3/locators** 6216 +**GET /api/v3/locators ** 5882 5882 ))) 5883 5883 5884 5884 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5887,33 +5887,54 @@ 5887 5887 Пример ответа: 5888 5888 5889 5889 ((( 5890 -[ 5891 - { 5892 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5893 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5894 - "agentName": "string", ~/~/ Наименование агента. 5895 - "isEnabled": true, ~/~/ Активен 5896 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5897 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5898 - "name": "string", ~/~/ Наименование 5899 - "status": 0, ~/~/ 5900 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5901 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5902 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5903 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5904 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5905 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5906 - "url": "string", ~/~/ Ссылка 5907 - "language": 0, ~/~/ Язык. 5908 - "vehiclesCount": 0, ~/~/ Количество объектов. 5909 - "geozonesCount": 0, ~/~/ Количество геозон. 5910 - "fieldsCount": 0 ~/~/ Количество полей. 5911 - } 5912 -] 6225 +((( 6226 +{ 6227 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6228 + 0 6229 + ], 6230 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6231 + 0 6232 + ], 6233 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6234 + 0 6235 + ], 6236 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6237 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6238 + "agentName": "string", ~/~/ Наименование агента. 6239 + "isEnabled": true, ~/~/ Активность 6240 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6241 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6242 + "name": "string", ~/~/ Наименование. 6243 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6244 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6245 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6246 + "validity": 0, ~/~/ Значение срока действия 6247 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6248 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6249 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6250 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6251 + "url": "string", ~/~/ Ссылка 6252 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6253 + "showVehicleName": true, ~/~/ Наименование объекта 6254 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6255 + "allowTrackReport": true, ~/~/ Трек 6256 + "showTrackTracing": true, ~/~/ Трассировка трека 6257 + "showSensors": true, ~/~/ Датчик 6258 + "availableMapLayers": [ ~/~/ Слои на карте 6259 + 0 6260 + ] 6261 +} 5913 5913 ))) 6263 +))) 5914 5914 5915 5915 6266 +((( 6267 +((( 6268 + 6269 +))) 6270 +))) 5916 5916 6272 + 5917 5917 == **Создание локатора** == 5918 5918 5919 5919 (% class="box successmessage" %) ... ... @@ -5925,7 +5925,6 @@ 5925 5925 5926 5926 ((( 5927 5927 { 5928 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5929 5929 "isEnabled": true, ~/~/ Активность 5930 5930 "name": "string", ~/~/ Наименование локатора 5931 5931 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5932,8 +5932,24 @@ 5932 5932 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5933 5933 "validity": 0, ~/~/ Срок действия в днях (1-90) 5934 5934 "autoProlongation": true, ~/~/ Автопродление срока действия. 5935 - "url": "string", ~/~/ Ссылка 5936 - "language": 0 ~/~/ Язык 6290 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6291 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6292 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6293 + 0 6294 + ], 6295 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6296 + 0 6297 + ], 6298 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6299 + 0 6300 + ], 6301 + "showVehicleName": true, ~/~/ Наименование объекта 6302 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6303 + "allowTrackReport": true, ~/~/ Трек 6304 + "showTrackTracing": true, ~/~/ Трассировка трека 6305 + "showSensors": true, ~/~/ Датчик 6306 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6307 + ] 5937 5937 } 5938 5938 ))) 5939 5939 ... ... @@ -5945,7 +5945,95 @@ 5945 5945 ))) 5946 5946 5947 5947 6319 +== **Выводит список локаторов ** == 5948 5948 6321 +(% class="box successmessage" %) 6322 +((( 6323 +**POST /api/v3/locators/find** 6324 +))) 6325 + 6326 +Пример запроса: 6327 + 6328 +((( 6329 +{ 6330 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6331 +} 6332 +))) 6333 + 6334 +((( 6335 + 6336 +))) 6337 + 6338 +((( 6339 +{ 6340 + "isEnabled": true, ~/~/ Активность 6341 + "name": "string", ~/~/ Наименование локатора 6342 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6343 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6344 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6345 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6346 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6347 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6348 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6349 + 0 6350 + ], 6351 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6352 + 0 6353 + ], 6354 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6355 + 0 6356 + ], 6357 + "showVehicleName": true, ~/~/ Наименование объекта 6358 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6359 + "allowTrackReport": true, ~/~/ Трек 6360 + "showTrackTracing": true, ~/~/ Трассировка трека 6361 + "showSensors": true, ~/~/ Датчик 6362 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6363 + ] 6364 +} 6365 +))) 6366 + 6367 + 6368 +Пример ответа: 6369 + 6370 +((( 6371 +[ 6372 + { 6373 + "vehiclesCount": 0, ~/~/ Количество объектов. 6374 + "geozonesCount": 0, ~/~/ Количество геозон. 6375 + "fieldsCount": 0, ~/~/ Количество полей. 6376 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6377 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6378 + "agentName": "string", ~/~/ Наименование агента. 6379 + "isEnabled": true, ~/~/ Активность локатора 6380 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6381 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6382 + "name": "string", ~/~/ Наименование локатора 6383 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6384 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6385 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6386 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6387 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6388 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6389 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6390 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6391 + "url": "string", ~/~/ ссылка на локатор 6392 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6393 + "showVehicleName": true, ~/~/ Наименование объекта 6394 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6395 + "allowTrackReport": true, ~/~/ Трек 6396 + "showTrackTracing": true, ~/~/ Трассировка трека 6397 + "showSensors": true, ~/~/ Датчик 6398 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6399 + 6400 + 0 6401 + ] 6402 + } 6403 +] 6404 +))) 6405 + 6406 + 6407 + 5949 5949 == **Изменение локатора** == 5950 5950 5951 5951 (% class="box infomessage" %) ... ... @@ -5964,12 +5964,28 @@ 5964 5964 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5965 5965 "validity": 0, ~/~/ Срок действия в днях (1-90) 5966 5966 "autoProlongation": true, ~/~/ Автопродление срока действия 5967 - "url": "string", ~/~/ Ссылка 5968 - "language": 0 ~/~/ Язык 6426 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6427 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6428 + 0 6429 + ], 6430 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6431 + 0 6432 + ], 6433 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6434 + 0 6435 + ], 6436 + "showVehicleName": true, ~/~/ Наименование объекта 6437 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6438 + "allowTrackReport": true, ~/~/ Трек 6439 + "showTrackTracing": true, ~/~/ Трассировка трека 6440 + "showSensors": true, ~/~/ Датчик 6441 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6442 + ] 5969 5969 } 6444 + 6445 + 5970 5970 ))) 5971 5971 5972 - 5973 5973 Пример ответа: 5974 5974 5975 5975 200 ~/~/ Success ... ... @@ -6133,12 +6133,11 @@ 6133 6133 Id ~/~/ Идентификатор поля 6134 6134 6135 6135 6136 -==== ==== 6137 6137 6138 -= ===**Раздел: Управление доступа к машинам** ====6612 += **Раздел: Управление доступа к машинам** = 6139 6139 6140 6140 6141 -== Получение списка ID==6615 +== Получение списка транспортных средств видимых пользователю == 6142 6142 6143 6143 (% class="box infomessage" %) 6144 6144 ((( ... ... @@ -6145,15 +6145,97 @@ 6145 6145 **GET /api/v3/UserVisibleVehicles/{userId}** 6146 6146 ))) 6147 6147 6622 +Пример ответа: 6148 6148 6624 +((( 6625 +{ 6626 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6627 + 0 6628 + ] 6629 +} 6630 +))) 6149 6149 6150 6150 6151 6151 6634 +== Задает видимость транспортных средств пользователю == 6152 6152 6636 +(% class="box infomessage" %) 6637 +((( 6638 +**POST /api/v3/UserVisibleVehicles** 6639 +))) 6153 6153 6641 +Пример запроса: 6154 6154 6643 +((( 6644 +((( 6645 +{ 6646 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6647 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6648 + 0 6649 + ] 6650 +} 6651 +))) 6155 6155 6653 +((( 6654 + 6655 +))) 6156 6156 6657 +((( 6658 + 6659 +))) 6660 + 6661 +((( 6662 +Пример ответа : 6663 +))) 6664 + 6665 +((( 6666 + 6667 +))) 6668 + 6669 +((( 6670 +200 ~/~/ Success 6671 +))) 6672 +))) 6673 + 6674 + 6675 +== **Получение перечня моделей ** == 6676 + 6677 +(% class="box successmessage" %) 6678 +((( 6679 +**POST /api/v3/models/find** 6680 +))) 6681 + 6682 +Пример запроса: 6683 + 6684 +((( 6685 +((( 6686 +{ 6687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6688 + "name": "string", ~/~/ Наименование локатора 6689 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6690 +))) 6691 + 6692 + 6693 + 6694 + Пример ответа: 6695 + 6696 + 6697 +((( 6698 +[ 6699 + { 6700 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6701 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6702 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6703 + "name": "string", ~/~/ Наименование локатора 6704 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6705 + } 6706 +] 6707 +))) 6708 +))) 6709 + 6710 + 6711 + 6712 + 6157 6157 (% class="box" lang="en-US" style="text-align: center;" %) 6158 6158 ((( 6159 6159 (% 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]] **