Last modified by Андрей Калиновский on 2025/06/27 16:12
<
From version < 240.1 >
edited by Андрей Калиновский
on 2025/06/09 16:36
To version < 218.1 >
edited by Андрей Калиновский
on 2025/04/21 13:43
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -877,7 +877,7 @@
877 877  {
878 878   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 879   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 - "deleted": false,
880 + "deleted": true,
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": false,
899 + "deleted": true,
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" %)Метод позволяет изменить статус модели, указанного в запросе.
933 +(% 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" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
1000 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1001 1001  
1002 1002  (% style="color:#000000" %)Метод запроса: **DELETE**
1003 1003  
... ... @@ -1628,6 +1628,77 @@
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 +
1631 1631  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1632 1632  
1633 1633  (% class="box infomessage" %)
... ... @@ -1773,6 +1773,7 @@
1773 1773   "stage": "", ~/~/ Состояние
1774 1774  (% style="color:#000000" %) }
1775 1775  
1847 +== ==
1776 1776  
1777 1777  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1778 1778  
... ... @@ -2455,8 +2455,6 @@
2455 2455   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2456 2456   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2457 2457   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2458 - "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2459 - "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2460 2460   "fuelConsumption": 0, ~/~/ Расход топлива
2461 2461   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2462 2462   "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
... ... @@ -2736,35 +2736,6 @@
2736 2736   }
2737 2737  ]
2738 2738  
2739 -
2740 -== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2741 -
2742 -(% class="box successmessage" %)
2743 -(((
2744 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2745 -)))
2746 -
2747 -(% style="color:#000000" %)Метод запроса: **PUT**
2748 -
2749 -Пример запроса:
2750 -
2751 -(((
2752 -{
2753 - "id": 0,  ~/~/ Идентификатор объекта геозоны
2754 - "name": "string",  ~/~/ Наименование объекта геозоны
2755 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2756 - "description": "string", ~/~/ Описание объекта геозоны
2757 - "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2758 - "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2759 - "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2760 -}
2761 -)))
2762 -
2763 -
2764 -Пример ответа:
2765 -
2766 -200 ~/~/ Success
2767 -
2768 2768  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2769 2769  
2770 2770  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2796,7 +2796,7 @@
2796 2796   "id": 0, ~/~/ ID уведомления
2797 2797   "name": "string", ~/~/ Название уведомления
2798 2798   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2799 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2840 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2800 2800   "userId": "", ~/~/ Пользователь, создавший уведомление
2801 2801   "parentId": "", ~/~/ Идентификатор клиента
2802 2802   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2803,155 +2803,6 @@
2803 2803   }
2804 2804  ]
2805 2805  
2806 -
2807 -== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2808 -
2809 -(% class="box infomessage" %)
2810 -(((
2811 -**POST /api/v3/notifications**
2812 -)))
2813 -
2814 -Метод запроса **POST**
2815 -
2816 -(% style="text-align: left;" %)
2817 -(% style="color:#000000" %)Пример запроса
2818 -
2819 -(((
2820 -{
2821 - "id": 0, ~/~/ ID правила
2822 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2823 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2824 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2825 - "name": "string", ~/~/ Имя правила
2826 - "active": true, ~/~/ Активность правила
2827 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2828 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2829 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2830 - ],
2831 - "vehicleIds": [ ~/~/ Список объектов для анализа.
2832 - 0
2833 - ],
2834 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2835 - 0
2836 - ],
2837 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2838 - 0
2839 - ],
2840 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2841 - "additionalProp1": "string",  
2842 - "additionalProp2": "string",
2843 - "additionalProp3": "string"
2844 - },
2845 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2846 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2847 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2848 - ],
2849 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2850 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2851 - "string"
2852 - ],
2853 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2854 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2855 - {
2856 - "id": 0, ~/~/ Идентификатор участника чата.
2857 - "info": "string" ~/~/ Дополнительные сведения.
2858 - }
2859 - ],
2860 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2861 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2862 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2863 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2864 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2865 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2866 - "timezone": 0, ~/~/ часовой пояс 
2867 - "validity": 0, ~/~/ Срок действия в днях (1-90).
2868 - "autoProlongation": true, ~/~/ Автопродление срока действия.
2869 - "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2870 - {
2871 - "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 - Срок действия правила истек
2872 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2873 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2874 - "additionalProp1": "string",
2875 - "additionalProp2": "string",
2876 - "additionalProp3": "string"
2877 - }
2878 - }
2879 - ]
2880 -}
2881 -)))
2882 -
2883 -(((
2884 -
2885 -)))
2886 -
2887 -(((
2888 -
2889 -)))
2890 -
2891 -Ответ:
2892 -
2893 -{
2894 - "id": 0, ~/~/ ID правила
2895 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2896 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2897 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2898 - "name": "string", ~/~/ Имя правила
2899 - "active": true, ~/~/ Активность правила
2900 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2901 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2902 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2903 - ],
2904 - "vehicleIds": [ ~/~/ Список объектов для анализа.
2905 - 0
2906 - ],
2907 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2908 - 0
2909 - ],
2910 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2911 - 0
2912 - ],
2913 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2914 - "additionalProp1": "string",  
2915 - "additionalProp2": "string",
2916 - "additionalProp3": "string"
2917 - },
2918 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2919 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2920 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2921 - ],
2922 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2923 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2924 - "string"
2925 - ],
2926 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2927 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2928 - {
2929 - "id": 0, ~/~/ Идентификатор участника чата.
2930 - "info": "string" ~/~/ Дополнительные сведения.
2931 - }
2932 - ],
2933 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2934 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2935 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2936 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2937 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2938 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2939 - "timezone": 0, ~/~/ часовой пояс 
2940 - "validity": 0, ~/~/ Срок действия в днях (1-90).
2941 - "autoProlongation": true, ~/~/ Автопродление срока действия.
2942 - "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2943 - {
2944 - "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 - Срок действия правила истек
2945 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2946 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2947 - "additionalProp1": "string",
2948 - "additionalProp2": "string",
2949 - "additionalProp3": "string"
2950 - }
2951 - }
2952 - ]
2953 -}
2954 -
2955 2955  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2956 2956  
2957 2957  (% class="box infomessage" %)
... ... @@ -4398,43 +4398,6 @@
4398 4398  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4399 4399  |msgCount|Кол-во обработанных сообщений всего
4400 4400  
4401 -== **Импортировать историю ТС (Асинхронный запрос)** ==
4402 -
4403 -(% class="box successmessage" %)
4404 -(((
4405 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4406 -)))
4407 -
4408 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4409 -
4410 -Метод запроса: **POST**
4411 -
4412 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4413 -
4414 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4415 -
4416 -
4417 -Ответ:
4418 -
4419 -{
4420 -
4421 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4422 -
4423 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4424 -
4425 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4426 -
4427 - "Message": "string", ~/~/ Информация о выполнении запроса
4428 -
4429 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4430 -
4431 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4432 -
4433 - "Data": "string" ~/~/ Данные
4434 -
4435 -}
4436 -
4437 -
4438 4438  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4439 4439  
4440 4440  (% class="box infomessage" %)
... ... @@ -4452,59 +4452,10 @@
4452 4452   "message": "string"
4453 4453  }
4454 4454  
4455 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4456 -**Параметр**
4457 -)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4458 -**Описание**
4459 -)))
4460 -|(((
4461 -activity
4462 -)))|(((
4463 -Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4464 -)))
4465 -|(((
4466 -progress
4467 -)))|(((
4468 -Guid ТС
4469 -)))
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 ТС
4470 4470  
4471 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4472 -
4473 -(% class="box infomessage" %)
4474 -(((
4475 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4476 -)))
4477 -
4478 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4479 -
4480 -Метод запроса: **GET**
4481 -
4482 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4483 -
4484 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4485 -
4486 -
4487 -Ответ:
4488 -
4489 -{
4490 -
4491 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4492 -
4493 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
4494 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4495 -
4496 - "Message": "string", ~/~/ Информация о выполнении запроса
4497 -
4498 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4499 -
4500 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4501 -
4502 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4503 -
4504 - "Data": "string" ~/~/ Данные
4505 -
4506 -}
4507 -
4508 4508  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4509 4509  
4510 4510  (% class="box infomessage" %)
... ... @@ -5016,51 +5016,8 @@
5016 5016   }
5017 5017   ]
5018 5018  }
5019 -
5020 -
5021 -== **Превышение скорости** ==
5022 -
5023 -(% class="box infomessage" %)
5024 -(((
5025 -**POST /api/v3/Reports/overSpeedDuration**
5026 5026  )))
5027 5027  
5028 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5029 -
5030 -Пример запроса:
5031 -
5032 -(((
5033 -{
5034 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5035 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5036 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5037 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5038 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5039 -}
5040 -)))
5041 -
5042 -(((
5043 -
5044 -)))
5045 -
5046 -(((
5047 -Пример ответа:
5048 -)))
5049 -
5050 -(((
5051 -(((
5052 -[
5053 - {
5054 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5055 - "duration": 0, ~/~/ Продолжительность события в секундах 
5056 - "maxSpeed": 0, ~/~/ Максимальная скорость 
5057 - "speedLimit": 0 ~/~/ Ограничение скорости 
5058 - }
5059 -]
5060 -)))
5061 -)))
5062 -)))
5063 -
5064 5064  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5065 5065  
5066 5066  
... ... @@ -6065,62 +6065,6 @@
6065 6065  )))
6066 6066  
6067 6067  
6068 -= **Раздел: Роли** =
6069 -
6070 -== **Получение списка клиентских и системных ролей пользователя ** ==
6071 -
6072 -(% class="box successmessage" %)
6073 -(((
6074 -**POST /api/v3/groups/find**
6075 -)))
6076 -
6077 -Пример запроса:
6078 -
6079 -(((
6080 -{
6081 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6082 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6083 -}
6084 -)))
6085 -
6086 -(((
6087 -
6088 -)))
6089 -
6090 -(((
6091 -Пример ответа:
6092 -)))
6093 -
6094 -(((
6095 -(((
6096 -{
6097 - "groups": [  ~/~/ Системные роли пользователя
6098 - {
6099 - "code": "string", ~/~/ Код роли.
6100 - "name": "string", ~/~/ Имя  
6101 - "shortName": "string" ~/~/ Короткое имя 
6102 - }
6103 - ],
6104 - "customGroups": [ ~/~/ Системные роли пользователя
6105 - {
6106 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6107 - "name": "string", ~/~/ Наименование 
6108 - "shortName": "string", ~/~/ Короткое наименование 
6109 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6110 - }
6111 - ]
6112 -}
6113 -)))
6114 -)))
6115 -
6116 -(((
6117 -
6118 -)))
6119 -
6120 -(((
6121 -
6122 -)))
6123 -
6124 6124  = **Раздел: Локатор ** =
6125 6125  
6126 6126  
... ... @@ -6128,7 +6128,7 @@
6128 6128  
6129 6129  (% class="box infomessage" %)
6130 6130  (((
6131 -**GET /api/v3/locators **
5838 +**GET /api/v3/locators**
6132 6132  )))
6133 6133  
6134 6134  В заголовках запроса: X-Auth: Токен авторизации
... ... @@ -6137,83 +6137,33 @@
6137 6137  Пример ответа:
6138 6138  
6139 6139  (((
6140 -(((
6141 -{
6142 - "vehiclesIds": [ ~/~/ Объекты
6143 - 0
6144 - ],
6145 - "geoIds": [ ~/~/ Геозоны
6146 - 0
6147 - ],
6148 - "fieldsIds": [ ~/~/ Поля
6149 - 0
6150 - ],
6151 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6152 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6153 - "agentName": "string", ~/~/ Наименование агента.
6154 - "isEnabled": true, ~/~/ Активность 
6155 - "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6156 - "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6157 - "name": "string", ~/~/ Наименование.
6158 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6159 - "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6160 - "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6161 - "validity": 0, ~/~/ Значение срока действия
6162 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6163 - "autoProlongation": true, ~/~/ Автопродление срока действия.
6164 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6165 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6166 - "url": "string", ~/~/ Ссылка
6167 - "language": 0, ~/~/ Язык
6168 - "showVehicleName": true, ~/~/ Наименование объекта
6169 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6170 - "allowTrackReport": true, ~/~/ Трек
6171 - "showTrackTracing": true, ~/~/ Трассировка трека
6172 - "showSensors": true, ~/~/ Датчик
6173 - "availableMapLayers": [ ~/~/  Слои на карте
6174 - 0
6175 - ]
6176 -}
6177 -)))
6178 -)))
6179 -
6180 -
6181 -== **Получение перечня моделей ** ==
6182 -
6183 -(% class="box successmessage" %)
6184 -(((
6185 -**POST /api/v3/models/find**
6186 -)))
6187 -
6188 -Пример запроса:
6189 -
6190 -(((
6191 -(((
6192 -{
6193 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6194 - "name": "string", ~/~/ Наименование локатора
6195 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6196 -)))
6197 -
6198 -
6199 -
6200 - Пример ответа: 
6201 -
6202 -
6203 -(((
6204 6204  [
6205 6205   {
6206 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6207 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6208 - "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6209 - "name": "string", ~/~/ Наименование локатора
6210 - "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
5849 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5850 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5851 + "agentName": "string", ~/~/ Наименование агента.
5852 + "isEnabled": true, ~/~/ Активен 
5853 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5854 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5855 + "name": "string", ~/~/ Наименование
5856 + "status": 0, ~/~/ 
5857 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5858 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5859 + "validity": 0, ~/~/ Срок действия в днях (1-90).
5860 + "autoProlongation": true, ~/~/ Автопродление срока действия.
5861 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5862 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5863 + "url": "string", ~/~/ Ссылка
5864 + "language": 0, ~/~/ Язык.
5865 + "vehiclesCount": 0, ~/~/ Количество объектов.
5866 + "geozonesCount": 0, ~/~/ Количество геозон.
5867 + "fieldsCount": 0 ~/~/ Количество полей.
6211 6211   }
6212 6212  ]
6213 6213  )))
6214 -)))
6215 6215  
6216 6216  
5873 +
6217 6217  == **Создание локатора** ==
6218 6218  
6219 6219  (% class="box successmessage" %)
... ... @@ -6234,24 +6234,6 @@
6234 6234   "autoProlongation": true, ~/~/ Автопродление срока действия.
6235 6235   "url": "string", ~/~/ Ссылка
6236 6236   "language": 0 ~/~/ Язык
6237 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6238 - "vehiclesIds": [ ~/~/ Oбъекты
6239 - 0
6240 - ],
6241 - "geoIds": [ ~/~/ Геозоны
6242 - 0
6243 - ],
6244 - "fieldsIds": [ ~/~/ Поля
6245 - 0
6246 - ],
6247 - "showVehicleName": true, ~/~/ Наименование объекта
6248 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6249 - "allowTrackReport": true, ~/~/ Трек
6250 - "showTrackTracing": true, ~/~/ Трассировка трека
6251 - "showSensors": true, ~/~/ Датчик
6252 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6253 - 0
6254 - ]
6255 6255  }
6256 6256  )))
6257 6257  
... ... @@ -6284,29 +6284,10 @@
6284 6284   "autoProlongation": true, ~/~/ Автопродление срока действия
6285 6285   "url": "string", ~/~/ Ссылка
6286 6286   "language": 0 ~/~/ Язык
6287 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6288 - "vehiclesIds": [ ~/~/ Oбъекты
6289 - 0
6290 - ],
6291 - "geoIds": [ ~/~/ Геозоны
6292 - 0
6293 - ],
6294 - "fieldsIds": [ ~/~/ Поля
6295 - 0
6296 - ],
6297 - "showVehicleName": true, ~/~/ Наименование объекта
6298 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6299 - "allowTrackReport": true, ~/~/ Трек
6300 - "showTrackTracing": true, ~/~/ Трассировка трека
6301 - "showSensors": true, ~/~/ Датчик
6302 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6303 - 0
6304 - ]
6305 6305  }
6306 -
6307 -
6308 6308  )))
6309 6309  
5929 +
6310 6310  Пример ответа:
6311 6311  
6312 6312  200 ~/~/ Success
... ... @@ -6470,11 +6470,12 @@
6470 6470  Id  ~/~/ Идентификатор поля
6471 6471  
6472 6472  
6093 +==== ====
6473 6473  
6474 -= **Раздел: Управление доступа к машинам** =
6095 +==== **Раздел: Управление доступа к машинам** ====
6475 6475  
6476 6476  
6477 -== Получение списка транспортных средств видимых пользователю ==
6098 +== Получение списка ID ==
6478 6478  
6479 6479  (% class="box infomessage" %)
6480 6480  (((
... ... @@ -6481,63 +6481,15 @@
6481 6481  **GET /api/v3/UserVisibleVehicles/{userId}**
6482 6482  )))
6483 6483  
6484 -Пример ответа:
6485 6485  
6486 -(((
6487 -{
6488 - "vehicleIds": [  ~/~/ Идентификаторы ТС
6489 - 0
6490 - ]
6491 -}
6492 -)))
6493 6493  
6494 6494  
6495 6495  
6496 -== Задает видимость транспортных средств пользователю ==
6497 6497  
6498 -(% class="box infomessage" %)
6499 -(((
6500 -**POST /api/v3/UserVisibleVehicles**
6501 -)))
6502 6502  
6503 -Пример запроса:
6504 6504  
6505 -(((
6506 -(((
6507 -{
6508 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6509 - "vehicleIds": [ ~/~/ Идентификаторы ТС
6510 - 0
6511 - ]
6512 -}
6513 -)))
6514 6514  
6515 -(((
6516 -
6517 -)))
6518 6518  
6519 -(((
6520 -
6521 -)))
6522 -
6523 -(((
6524 -Пример ответа :
6525 -)))
6526 -
6527 -(((
6528 -
6529 -)))
6530 -
6531 -(((
6532 -200 ~/~/ Success
6533 -)))
6534 -)))
6535 -
6536 -
6537 -
6538 -
6539 -
6540 -
6541 6541  (% class="box" lang="en-US" style="text-align: center;" %)
6542 6542  (((
6543 6543  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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