Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/07/29 15:51
<
>
отредактировано Андрей Калиновский
на 2025/04/21 14:13
на 2025/04/21 14:13
отредактировано Андрей Калиновский
на 2025/07/03 16:21
на 2025/07/03 16:21
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -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,8 @@ 766 766 (% style="text-align:left" %) 767 767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 768 768 769 += = 770 + 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,882 + "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,901 + "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" %)Метод позволяет изменить статус пользователя, указанного в запросе.935 +(% 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" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1002 +(% 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, ~/~/ Уровень топлива на конец периода 2460 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2461 + "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 объектов, вквадратных скобкахчерез запятую.2591 +В массиве указываем id объектов через запятую 2660 2660 2661 2661 Ответ: 2594 + 2595 +[ 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": [ ~/~/Сведения по геозонам. 2597 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2598 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2599 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2600 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2601 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2602 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2603 + "speed": 31, ~/~/ Скорость объекта 2604 + "course": 116, ~/~/ Курс движения [0;360] 2605 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2606 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2607 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2608 + "geozones": [ ~/~/ Сведения по геозонам. 2675 2675 { 2676 - "id": 0, 2677 - "name": "string" 2610 + "id": 10225647, ~/~/ ID Геозоны 2611 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2612 + }, 2613 + { 2614 + "id": 10282875, ~/~/ ID Геозоны 2615 + "name": "Ё2" ~/~/ Наименование геозоны 2616 + }, 2617 + { 2618 + "id": 10226240, ~/~/ ID Геозоны 2619 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2620 + }, 2621 + { 2622 + "id": 9747869, ~/~/ ID Геозоны 2623 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2624 + }, 2625 + { 2626 + "id": 10221123, ~/~/ ID Геозоны 2627 + "name": "53r" ~/~/ Наименование геозоны 2628 + }, 2629 + { 2630 + "id": 10197638, ~/~/ ID Геозоны 2631 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2678 2678 } 2633 + ] 2634 + } 2679 2679 2680 2680 2681 2681 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2806,6 +2806,35 @@ 2806 2806 } 2807 2807 ] 2808 2808 2765 + 2766 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2767 + 2768 +(% class="box successmessage" %) 2769 +((( 2770 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2771 +))) 2772 + 2773 +(% style="color:#000000" %)Метод запроса: **PUT** 2774 + 2775 +Пример запроса: 2776 + 2777 +((( 2778 +{ 2779 + "id": 0, ~/~/ Идентификатор объекта геозоны 2780 + "name": "string", ~/~/ Наименование объекта геозоны 2781 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2782 + "description": "string", ~/~/ Описание объекта геозоны 2783 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2784 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2785 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2786 +} 2787 +))) 2788 + 2789 + 2790 +Пример ответа: 2791 + 2792 +200 ~/~/ Success 2793 + 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 - Выполнение ТО 2825 + "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 2832 + 2833 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2834 + 2835 +(% class="box infomessage" %) 2836 +((( 2837 +**POST /api/v3/notifications** 2838 +))) 2839 + 2840 +Метод запроса **POST** 2841 + 2842 +(% style="text-align: left;" %) 2843 +(% style="color:#000000" %)Пример запроса 2844 + 2845 +((( 2846 +{ 2847 + "id": 0, ~/~/ ID правила 2848 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2849 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2851 + "name": "string", ~/~/ Имя правила 2852 + "active": true, ~/~/ Активность правила 2853 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2854 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2855 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2856 + ], 2857 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2858 + 0 2859 + ], 2860 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2861 + 0 2862 + ], 2863 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2864 + 0 2865 + ], 2866 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2867 + "additionalProp1": "string", 2868 + "additionalProp2": "string", 2869 + "additionalProp3": "string" 2870 + }, 2871 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2872 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2873 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2874 + ], 2875 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2876 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2877 + "string" 2878 + ], 2879 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2880 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2881 + { 2882 + "id": 0, ~/~/ Идентификатор участника чата. 2883 + "info": "string" ~/~/ Дополнительные сведения. 2884 + } 2885 + ], 2886 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2887 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2888 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2889 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2890 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2891 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2892 + "timezone": 0, ~/~/ часовой пояс 2893 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2894 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2895 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2896 + { 2897 + "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 - Срок действия правила истек 2898 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2899 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2900 + "additionalProp1": "string", 2901 + "additionalProp2": "string", 2902 + "additionalProp3": "string" 2903 + } 2904 + } 2905 + ] 2906 +} 2907 +))) 2908 + 2909 +((( 2910 + 2911 +))) 2912 + 2913 +((( 2914 + 2915 +))) 2916 + 2917 +Ответ: 2918 + 2919 +{ 2920 + "id": 0, ~/~/ ID правила 2921 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2922 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2923 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2924 + "name": "string", ~/~/ Имя правила 2925 + "active": true, ~/~/ Активность правила 2926 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2927 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2928 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2929 + ], 2930 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2931 + 0 2932 + ], 2933 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2934 + 0 2935 + ], 2936 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2937 + 0 2938 + ], 2939 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2940 + "additionalProp1": "string", 2941 + "additionalProp2": "string", 2942 + "additionalProp3": "string" 2943 + }, 2944 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2945 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2946 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2947 + ], 2948 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2949 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2950 + "string" 2951 + ], 2952 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2953 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2954 + { 2955 + "id": 0, ~/~/ Идентификатор участника чата. 2956 + "info": "string" ~/~/ Дополнительные сведения. 2957 + } 2958 + ], 2959 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2960 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2961 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2962 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2963 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2964 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2965 + "timezone": 0, ~/~/ часовой пояс 2966 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2967 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2968 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2969 + { 2970 + "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 - Срок действия правила истек 2971 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2972 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2973 + "additionalProp1": "string", 2974 + "additionalProp2": "string", 2975 + "additionalProp3": "string" 2976 + } 2977 + } 2978 + ] 2979 +} 2980 + 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 4198 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4199 + "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 4215 +((( 4085 4085 { 4086 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4087 - " Balance": 04217 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4218 + "amount": 0 ~/~/ Сумма пополнения баланса 4088 4088 } 4220 +))) 4089 4089 4222 +((( 4223 + 4224 +))) 4225 + 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" %)Значение баланса 4228 +((( 4229 +{ 4230 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4231 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4232 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4233 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4234 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4235 + "Description": "string" ~/~/ Описание корректировки. 4236 +} 4237 +))) 4095 4095 4096 4096 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4097 4097 ... ... @@ -4104,16 +4104,25 @@ 4104 4104 4105 4105 Тело запроса: 4106 4106 4250 +((( 4107 4107 { 4108 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4109 - " Balance": 04252 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4253 + "amount": 0 ~/~/ Сумма списания с баланса 4110 4110 } 4255 +))) 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" %)Значение баланса 4259 +((( 4260 +{ 4261 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4263 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4264 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4265 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4266 + "Description": "string" ~/~/ Описание корректировки 4267 +} 4268 +))) 4117 4117 4118 4118 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4119 4119 ... ... @@ -4124,28 +4124,35 @@ 4124 4124 4125 4125 Тело запроса: 4126 4126 4279 +((( 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, 4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4135 4135 } 4288 +))) 4136 4136 4290 +((( 4291 + 4292 +))) 4293 + 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 -Отсрочка, количество дней 4296 +((( 4297 +{ 4298 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4299 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4301 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4302 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4303 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4304 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4305 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4306 +} 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": [ 4319 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4320 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "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 4323 + "Feature": "string", ~/~/ Код услуги. 4324 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4325 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4326 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4327 + "Price": 0, ~/~/ Цена за единицу. 4328 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4329 + "PeriodValue": 0, ~/~/ Значение периода. 4330 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4172 4172 } 4173 4173 ] 4174 4174 } 4175 4175 4335 + 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 - Месяцы 4338 +((( 4339 +{ 4340 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4341 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4342 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4343 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4344 + "Name": "string", ~/~/ Наименование. 4345 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4346 + "Constraint": { ~/~/ Ограничения по тарифу 4347 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4348 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4349 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4350 + }, 4351 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4352 + { 4353 + "Feature": "string", ~/~/Код услуги. 4354 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4355 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4356 + "Price": 0, ~/~/ Цена за единицу. 4357 + "PeriodValue": 0, ~/~/ Значение периода. 4358 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4359 + } 4360 + ], 4361 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4362 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4363 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4364 + }, 4365 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4366 + { 4367 + "Feature": "string", ~/~/ Код услуги. 4368 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4369 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4370 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4371 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4372 + "Price": 0, ~/~/ Цена за единицу. 4373 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4374 + "PeriodValue": 0, ~/~/ Значение периода. 4375 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4376 + "Quantity": 0 ~/~/ Количество использования услуги. 4377 + } 4378 + ] 4379 +} 4380 +))) 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 4485 +== **Импортировать историю ТС (Асинхронный запрос)** == 4486 + 4487 +(% class="box successmessage" %) 4488 +((( 4489 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4490 +))) 4491 + 4492 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4493 + 4494 +Метод запроса: **POST** 4495 + 4496 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4497 + 4498 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4499 + 4500 + 4501 +Ответ: 4502 + 4503 +{ 4504 + 4505 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4506 + 4507 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4508 + 4509 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4510 + 4511 + "Message": "string", ~/~/ Информация о выполнении запроса 4512 + 4513 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4514 + 4515 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4516 + 4517 + "Data": "string" ~/~/ Данные 4518 + 4519 +} 4520 + 4521 + 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 ТС 4539 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4540 +**Параметр** 4541 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4542 +**Описание** 4543 +))) 4544 +|((( 4545 +activity 4546 +)))|((( 4547 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4548 +))) 4549 +|((( 4550 +progress 4551 +)))|((( 4552 +Guid ТС 4553 +))) 4313 4313 4555 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4556 + 4557 +(% class="box infomessage" %) 4558 +((( 4559 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4560 +))) 4561 + 4562 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4563 + 4564 +Метод запроса: **GET** 4565 + 4566 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4567 + 4568 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4569 + 4570 + 4571 +Ответ: 4572 + 4573 +{ 4574 + 4575 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4576 + 4577 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4578 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4579 + 4580 + "Message": "string", ~/~/ Информация о выполнении запроса 4581 + 4582 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4583 + 4584 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4585 + 4586 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4587 + 4588 + "Data": "string" ~/~/ Данные 4589 + 4590 +} 4591 + 4314 4314 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4315 4315 4316 4316 (% class="box infomessage" %) ... ... @@ -5871,6 +5871,62 @@ 5871 5871 ))) 5872 5872 5873 5873 6152 += **Раздел: Роли** = 6153 + 6154 +== **Получение списка клиентских и системных ролей пользователя ** == 6155 + 6156 +(% class="box successmessage" %) 6157 +((( 6158 +**POST /api/v3/groups/find** 6159 +))) 6160 + 6161 +Пример запроса: 6162 + 6163 +((( 6164 +{ 6165 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6166 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6167 +} 6168 +))) 6169 + 6170 +((( 6171 + 6172 +))) 6173 + 6174 +((( 6175 +Пример ответа: 6176 +))) 6177 + 6178 +((( 6179 +((( 6180 +{ 6181 + "groups": [ ~/~/ Системные роли пользователя 6182 + { 6183 + "code": "string", ~/~/ Код роли. 6184 + "name": "string", ~/~/ Имя 6185 + "shortName": "string" ~/~/ Короткое имя 6186 + } 6187 + ], 6188 + "customGroups": [ ~/~/ Системные роли пользователя 6189 + { 6190 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6191 + "name": "string", ~/~/ Наименование 6192 + "shortName": "string", ~/~/ Короткое наименование 6193 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6194 + } 6195 + ] 6196 +} 6197 +))) 6198 +))) 6199 + 6200 +((( 6201 + 6202 +))) 6203 + 6204 +((( 6205 + 6206 +))) 6207 + 5874 5874 = **Раздел: Локатор ** = 5875 5875 5876 5876 ... ... @@ -5878,7 +5878,7 @@ 5878 5878 5879 5879 (% class="box infomessage" %) 5880 5880 ((( 5881 -**GET /api/v3/locators** 6215 +**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 -] 6224 +((( 6225 +{ 6226 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6227 + 0 6228 + ], 6229 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6230 + 0 6231 + ], 6232 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6233 + 0 6234 + ], 6235 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6236 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6237 + "agentName": "string", ~/~/ Наименование агента. 6238 + "isEnabled": true, ~/~/ Активность 6239 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6240 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6241 + "name": "string", ~/~/ Наименование. 6242 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6243 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6244 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6245 + "validity": 0, ~/~/ Значение срока действия 6246 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6247 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6248 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6249 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6250 + "url": "string", ~/~/ Ссылка 6251 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6252 + "showVehicleName": true, ~/~/ Наименование объекта 6253 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6254 + "allowTrackReport": true, ~/~/ Трек 6255 + "showTrackTracing": true, ~/~/ Трассировка трека 6256 + "showSensors": true, ~/~/ Датчик 6257 + "availableMapLayers": [ ~/~/ Слои на карте 6258 + 0 6259 + ] 6260 +} 5913 5913 ))) 6262 +))) 5914 5914 5915 5915 6265 +((( 6266 +((( 6267 + 6268 +))) 6269 +))) 5916 5916 6271 + 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 ~/~/ Язык 6289 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6290 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6291 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6292 + 0 6293 + ], 6294 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6295 + 0 6296 + ], 6297 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6298 + 0 6299 + ], 6300 + "showVehicleName": true, ~/~/ Наименование объекта 6301 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6302 + "allowTrackReport": true, ~/~/ Трек 6303 + "showTrackTracing": true, ~/~/ Трассировка трека 6304 + "showSensors": true, ~/~/ Датчик 6305 + "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ГИС) 6306 + ] 5937 5937 } 5938 5938 ))) 5939 5939 ... ... @@ -5945,7 +5945,70 @@ 5945 5945 ))) 5946 5946 5947 5947 6318 +== **Выводит список локаторов ** == 5948 5948 6320 +(% class="box successmessage" %) 6321 +((( 6322 +**POST /api/v3/locators/find** 6323 +))) 6324 + 6325 +Пример запроса: 6326 + 6327 +((( 6328 +{ 6329 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6330 +} 6331 +))) 6332 + 6333 +((( 6334 + 6335 +))) 6336 + 6337 +((( 6338 + 6339 +))) 6340 + 6341 + 6342 +Пример ответа: 6343 + 6344 +((( 6345 +[ 6346 + { 6347 + "vehiclesCount": 0, ~/~/ Количество объектов. 6348 + "geozonesCount": 0, ~/~/ Количество геозон. 6349 + "fieldsCount": 0, ~/~/ Количество полей. 6350 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6351 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6352 + "agentName": "string", ~/~/ Наименование агента. 6353 + "isEnabled": true, ~/~/ Активность локатора 6354 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6355 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6356 + "name": "string", ~/~/ Наименование локатора 6357 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6358 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6359 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6360 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6361 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6362 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6363 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6364 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6365 + "url": "string", ~/~/ ссылка на локатор 6366 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6367 + "showVehicleName": true, ~/~/ Наименование объекта 6368 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6369 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6370 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6371 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6372 + "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ГИС) 6373 + 6374 + 0 6375 + ] 6376 + } 6377 +] 6378 +))) 6379 + 6380 + 6381 + 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 ~/~/ Язык 6400 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6401 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6402 + 0 6403 + ], 6404 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6405 + 0 6406 + ], 6407 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6408 + 0 6409 + ], 6410 + "showVehicleName": true, ~/~/ Наименование объекта 6411 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6412 + "allowTrackReport": true, ~/~/ Трек 6413 + "showTrackTracing": true, ~/~/ Трассировка трека 6414 + "showSensors": true, ~/~/ Датчик 6415 + "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ГИС) 6416 + ] 5969 5969 } 6418 + 6419 + 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 -= ===**Раздел: Управление доступа к машинам** ====6586 += **Раздел: Управление доступа к машинам** = 6139 6139 6140 6140 6141 -== Получение списка ID==6589 +== Получение списка транспортных средств видимых пользователю == 6142 6142 6143 6143 (% class="box infomessage" %) 6144 6144 ((( ... ... @@ -6145,15 +6145,64 @@ 6145 6145 **GET /api/v3/UserVisibleVehicles/{userId}** 6146 6146 ))) 6147 6147 6596 +Пример ответа: 6148 6148 6598 +((( 6599 +{ 6600 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6601 + 0 6602 + ] 6603 +} 6604 +))) 6149 6149 6150 6150 6151 6151 6608 +== Задает видимость транспортных средств пользователю == 6152 6152 6610 +(% class="box infomessage" %) 6611 +((( 6612 +**POST /api/v3/UserVisibleVehicles** 6613 +))) 6153 6153 6615 +Пример запроса: 6154 6154 6617 +((( 6618 +((( 6619 +{ 6620 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6621 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6622 + 0 6623 + ] 6624 +} 6625 +))) 6155 6155 6627 +((( 6628 + 6629 +))) 6156 6156 6631 +((( 6632 + 6633 +))) 6634 + 6635 +((( 6636 +Пример ответа : 6637 +))) 6638 + 6639 +((( 6640 + 6641 +))) 6642 + 6643 +((( 6644 +200 ~/~/ Success 6645 +))) 6646 +))) 6647 + 6648 + 6649 +== == 6650 + 6651 + 6652 + 6653 + 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]] **