<
From version < 243.1
edited by Андрей Калиновский
on 2025/06/27 16:12
To version < 207.2 >
edited by Андрей Калиновский
on 2025/02/20 09:27
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -11,11 +11,6 @@
11 11  
12 12  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 13  
14 -(% class="box infomessage" %)
15 -(((
16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 -\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 -)))
19 19  
20 20  **Содержание страницы:**
21 21  )))
... ... @@ -123,41 +123,29 @@
123 123  Запрос должен содержать данные параметра "**agentId**"
124 124  
125 125  (% style="color:#000000" %)Ответ:
126 -
127 -(((
128 128  {
129 - "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 - "parentName": "string", ~/~/ Наименование агента
132 - "name": "string", ~/~/ Имя клиента
133 - "fullName": "string", ~/~/ ФИО клиента
134 - "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 - "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 - "district": "string", ~/~/ Район
137 - "region": "string", ~/~/ Область
138 - "city": "string", ~/~/ Город
139 - "email": "string", ~/~/ Email
140 - "director": "string", ~/~/ Руководитель
141 - "RegionalData": [ ~/~/ Определяет региональные сведения.
142 - {
143 - "Country": 0, ~/~/ Страна
144 - "groups": [ ~/~/ Список групп
145 - {
146 - "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 - "fields": [ ~/~/ Список значений полей
148 - {
149 - "name": "string", ~/~/ Имя поля формы
150 - "value": "string" ~/~/ Значение поля формы
151 - }
152 - ]
153 - }
154 - ]
155 - }
156 - ]
157 -}
158 -)))
122 + "agentId": "",  (%%)
123 + "parentId": "",
124 + "parentName": "string",
125 + "name": "string",
126 + "fullName": "string",
127 + "agentInfoType": 0,
128 + "isForeign": true/false,
129 + "district": "string", 
130 + "region": "string",
131 + "city": "string",
132 + "inn": "string",
133 + "kpp": "string",
134 + "address": "string",
135 + "addressFact": "string",
136 + "email": "string",
137 + "director": "string",
138 + "bankName": "string",
139 + "bankBIK": "string",
140 + "bankRS": "string",
141 + "bankKS": "string"
142 + }
159 159  
160 -
161 161  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 162  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 163  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -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,
863 + "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,
882 + "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" %)Метод позволяет изменить статус модели, указанного в запросе.
916 +(% 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" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
983 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1001 1001  
1002 1002  (% style="color:#000000" %)Метод запроса: **DELETE**
1003 1003  
... ... @@ -1628,6 +1628,77 @@
1628 1628  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629 1629  
1630 1630  
1614 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1615 +
1616 +(% class="box successmessage" %)
1617 +(((
1618 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 +)))
1620 +
1621 +Метод запроса: **POST**
1622 +
1623 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 +
1625 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626 +
1627 +
1628 +Ответ:
1629 +
1630 +{
1631 +
1632 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 +
1634 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635 +
1636 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637 +
1638 + "Message": "string", ~/~/ Информация о выполнении запроса
1639 +
1640 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641 +
1642 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643 +
1644 + "Data": "string" ~/~/ Данные
1645 +
1646 +}
1647 +
1648 +
1649 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650 +
1651 +(% class="box infomessage" %)
1652 +(((
1653 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 +)))
1655 +
1656 +Метод запроса: **GET**
1657 +
1658 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 +
1660 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661 +
1662 +
1663 +Ответ:
1664 +
1665 +{
1666 +
1667 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668 +
1669 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671 +
1672 + "Message": "string", ~/~/ Информация о выполнении запроса
1673 +
1674 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675 +
1676 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677 +
1678 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679 +
1680 + "Data": "string" ~/~/ Данные
1681 +
1682 +}
1683 +
1684 +
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  
1830 +== ==
1776 1776  
1777 1777  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1778 1778  
... ... @@ -2455,12 +2455,8 @@
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 - "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2463 -
2464 2464   }
2465 2465   ]
2466 2466   }
... ... @@ -2506,8 +2506,7 @@
2506 2506   "model": "string", ~/~/ Модель объекта
2507 2507   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2508 2508   {
2509 - "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2510 -
2560 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2511 2511   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2512 2512   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2513 2513   "valueFuel": 0, ~/~/ Количество
... ... @@ -2586,50 +2586,26 @@
2586 2586  В заголовках запроса: X-Auth: Токен авторизации
2587 2587  
2588 2588  
2589 массиве указываем id объектов через запятую
2639 теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2590 2590  
2591 2591  Ответ:
2592 -
2593 -[
2594 2594   {
2595 - "vehicleId": 55728, ~/~/ Идентификатор объекта 
2596 - "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2597 - "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2598 - "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2599 - "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2600 - "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2601 - "speed": 31, ~/~/ Скорость объекта 
2602 - "course": 116, ~/~/ Курс движения [0;360]
2603 - "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2604 - "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2605 - "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2606 - "geozones": [ ~/~/ Сведения по геозонам. 
2643 + "vehicleId": 0, ~/~/Идентификатор объекта.
2644 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2645 + "vehicleNumber": "string",~/~/Номер объекта.
2646 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2647 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2648 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2649 + "speed": 0,~/~/Скорость объекта.
2650 + "course": 0,~/~/Курс движения [0;360]
2651 + "latitude": 0,~/~/Широта [-90°;90°].
2652 + "longitude": 0,~/~/Долгота [-180°;180°].
2653 + "address": "string",~/~/Адрес.
2654 + "geozones": [ ~/~/Сведения по геозонам.
2607 2607   {
2608 - "id": 10225647, ~/~/ ID Геозоны 
2609 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2610 - },
2611 - {
2612 - "id": 10282875, ~/~/ ID Геозоны 
2613 - "name": "Ё2" ~/~/ Наименование геозоны 
2614 - },
2615 - {
2616 - "id": 10226240, ~/~/ ID Геозоны 
2617 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2618 - },
2619 - {
2620 - "id": 9747869, ~/~/ ID Геозоны 
2621 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2622 - },
2623 - {
2624 - "id": 10221123, ~/~/ ID Геозоны 
2625 - "name": "53r" ~/~/ Наименование геозоны 
2626 - },
2627 - {
2628 - "id": 10197638, ~/~/ ID Геозоны 
2629 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2656 + "id": 0,
2657 + "name": "string"
2630 2630   }
2631 - ]
2632 - }
2633 2633  
2634 2634  
2635 2635  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
... ... @@ -2760,35 +2760,6 @@
2760 2760   }
2761 2761  ]
2762 2762  
2763 -
2764 -== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2765 -
2766 -(% class="box successmessage" %)
2767 -(((
2768 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2769 -)))
2770 -
2771 -(% style="color:#000000" %)Метод запроса: **PUT**
2772 -
2773 -Пример запроса:
2774 -
2775 -(((
2776 -{
2777 - "id": 0,  ~/~/ Идентификатор объекта геозоны
2778 - "name": "string",  ~/~/ Наименование объекта геозоны
2779 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2780 - "description": "string", ~/~/ Описание объекта геозоны
2781 - "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2782 - "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2783 - "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2784 -}
2785 -)))
2786 -
2787 -
2788 -Пример ответа:
2789 -
2790 -200 ~/~/ Success
2791 -
2792 2792  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2793 2793  
2794 2794  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2820,7 +2820,7 @@
2820 2820   "id": 0, ~/~/ ID уведомления
2821 2821   "name": "string", ~/~/ Название уведомления
2822 2822   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2823 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2820 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2824 2824   "userId": "", ~/~/ Пользователь, создавший уведомление
2825 2825   "parentId": "", ~/~/ Идентификатор клиента
2826 2826   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2827,155 +2827,6 @@
2827 2827   }
2828 2828  ]
2829 2829  
2830 -
2831 -== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2832 -
2833 -(% class="box infomessage" %)
2834 -(((
2835 -**POST /api/v3/notifications**
2836 -)))
2837 -
2838 -Метод запроса **POST**
2839 -
2840 -(% style="text-align: left;" %)
2841 -(% style="color:#000000" %)Пример запроса
2842 -
2843 -(((
2844 -{
2845 - "id": 0, ~/~/ ID правила
2846 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2847 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2848 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2849 - "name": "string", ~/~/ Имя правила
2850 - "active": true, ~/~/ Активность правила
2851 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2852 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2853 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2854 - ],
2855 - "vehicleIds": [ ~/~/ Список объектов для анализа.
2856 - 0
2857 - ],
2858 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2859 - 0
2860 - ],
2861 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2862 - 0
2863 - ],
2864 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2865 - "additionalProp1": "string",  
2866 - "additionalProp2": "string",
2867 - "additionalProp3": "string"
2868 - },
2869 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2870 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2871 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2872 - ],
2873 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2874 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2875 - "string"
2876 - ],
2877 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2878 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2879 - {
2880 - "id": 0, ~/~/ Идентификатор участника чата.
2881 - "info": "string" ~/~/ Дополнительные сведения.
2882 - }
2883 - ],
2884 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2885 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2886 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2887 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2888 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2889 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2890 - "timezone": 0, ~/~/ часовой пояс 
2891 - "validity": 0, ~/~/ Срок действия в днях (1-90).
2892 - "autoProlongation": true, ~/~/ Автопродление срока действия.
2893 - "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2894 - {
2895 - "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 - Срок действия правила истек
2896 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2897 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2898 - "additionalProp1": "string",
2899 - "additionalProp2": "string",
2900 - "additionalProp3": "string"
2901 - }
2902 - }
2903 - ]
2904 -}
2905 -)))
2906 -
2907 -(((
2908 -
2909 -)))
2910 -
2911 -(((
2912 -
2913 -)))
2914 -
2915 -Ответ:
2916 -
2917 -{
2918 - "id": 0, ~/~/ ID правила
2919 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2920 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2921 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2922 - "name": "string", ~/~/ Имя правила
2923 - "active": true, ~/~/ Активность правила
2924 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2925 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2926 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2927 - ],
2928 - "vehicleIds": [ ~/~/ Список объектов для анализа.
2929 - 0
2930 - ],
2931 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2932 - 0
2933 - ],
2934 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2935 - 0
2936 - ],
2937 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2938 - "additionalProp1": "string",  
2939 - "additionalProp2": "string",
2940 - "additionalProp3": "string"
2941 - },
2942 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2943 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2944 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2945 - ],
2946 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2947 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2948 - "string"
2949 - ],
2950 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2951 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2952 - {
2953 - "id": 0, ~/~/ Идентификатор участника чата.
2954 - "info": "string" ~/~/ Дополнительные сведения.
2955 - }
2956 - ],
2957 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2958 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2959 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2960 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2961 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2962 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2963 - "timezone": 0, ~/~/ часовой пояс 
2964 - "validity": 0, ~/~/ Срок действия в днях (1-90).
2965 - "autoProlongation": true, ~/~/ Автопродление срока действия.
2966 - "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2967 - {
2968 - "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 - Срок действия правила истек
2969 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2970 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2971 - "additionalProp1": "string",
2972 - "additionalProp2": "string",
2973 - "additionalProp3": "string"
2974 - }
2975 - }
2976 - ]
2977 -}
2978 -
2979 2979  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2980 2980  
2981 2981  (% class="box infomessage" %)
... ... @@ -4193,12 +4193,16 @@
4193 4193  Тело запроса:
4194 4194  
4195 4195  {
4196 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4197 - "Balance": 0 ~/~/ Значение баланса.
4044 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 + "Balance": 0
4198 4198  }
4199 4199  
4200 4200  Ответ: Success
4201 4201  
4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4053 +
4202 4202  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4203 4203  
4204 4204  (% class="box warningmessage" %)
... ... @@ -4210,29 +4210,16 @@
4210 4210  
4211 4211  Тело запроса:
4212 4212  
4213 -(((
4214 4214  {
4215 - "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4216 - "amount": 0 ~/~/ Сумма пополнения баланса 
4066 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 + "Balance": 0
4217 4217  }
4218 -)))
4219 4219  
4220 -(((
4221 -
4222 -)))
4223 -
4224 4224  Ответ: Success
4225 4225  
4226 -(((
4227 -{
4228 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4229 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4230 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4231 - "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4232 - "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4233 - "Description": "string" ~/~/ Описание корректировки.
4234 -}
4235 -)))
4072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4236 4236  
4237 4237  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4238 4238  
... ... @@ -4245,25 +4245,16 @@
4245 4245  
4246 4246  Тело запроса:
4247 4247  
4248 -(((
4249 4249  {
4250 - "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4251 - "amount": 0 ~/~/ Сумма списания с баланса
4088 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4089 + "Balance": 0
4252 4252  }
4253 -)))
4254 4254  
4255 4255  Ответ: Success
4256 4256  
4257 -(((
4258 -{
4259 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4260 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4261 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4262 - "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4263 - "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4264 - "Description": "string" ~/~/ Описание корректировки
4265 -}
4266 -)))
4094 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4095 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4096 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4267 4267  
4268 4268  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4269 4269  
... ... @@ -4274,35 +4274,28 @@
4274 4274  
4275 4275  Тело запроса:
4276 4276  
4277 -(((
4278 4278  {
4279 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4280 - "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4281 - "PermissibleBalance": 0, ~/~/ Допустимый баланс
4282 - "DefermentDays": 0, ~/~/ Отсрочка (дни).
4283 - "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4284 - "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4108 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4109 + "CalculationType": 0,
4110 + "PermissibleBalance": 0,
4111 + "DefermentDays": 0,
4112 + "SendUiNotifications": true,
4113 + "SendEmailNotifications": true,
4114 + "IsPrivate": true,
4285 4285  }
4286 -)))
4287 4287  
4288 -(((
4289 -
4290 -)))
4291 -
4292 4292  Ответ: Success
4293 4293  
4294 -(((
4295 -{
4296 - "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4297 - "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4298 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4299 - "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4300 - "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4301 - "DefermentDays": 0, ~/~/ Отсрочка (дни)
4302 - "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4303 - "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4304 -}
4119 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4120 +|ClientId|Идентификатор клиента
4121 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4122 +|PermissibleBalance|Допустимый баланс
4123 +|DefermentDays|(((
4124 +Отсрочка, количество дней
4305 4305  )))
4126 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4127 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4128 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4306 4306  
4307 4307  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4308 4308  
... ... @@ -4314,68 +4314,35 @@
4314 4314  Тело запроса:
4315 4315  
4316 4316  {
4317 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4318 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4319 - "Features": [ ~/~/ Набор услуг по тарифу клиента.
4140 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4141 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4142 + "Features": [
4320 4320   {
4321 - "Feature": "string", ~/~/ Код услуги.
4322 - "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4323 - "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4324 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4325 - "Price": 0, ~/~/ Цена за единицу.
4326 - "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4327 - "PeriodValue": 0, ~/~/ Значение периода.
4328 - "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4144 + "Feature": "string",
4145 + "IsEnabled": true,
4146 + "IsFactual": true,
4147 + "Limit": 0,
4148 + "Price": 0,
4149 + "DebitDate": "2023-10-18T13:26:58.987Z",
4150 + "PeriodValue": 0,
4151 + "PeriodType": 0
4329 4329   }
4330 4330   ]
4331 4331  }
4332 4332  
4333 -
4334 4334  Ответ: Success
4335 4335  
4336 -(((
4337 -{
4338 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4339 - "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4340 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4341 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4342 - "Name": "string", ~/~/ Наименование.
4343 - "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4344 - "Constraint": { ~/~/ Ограничения по тарифу 
4345 - "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4346 - "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4347 - "DefermentDays": 0 ~/~/ Отсрочка (дни)
4348 - },
4349 - "Features": [ ~/~/ Набор услуг по тарифному плану.
4350 - {
4351 - "Feature": "string", ~/~/Код услуги.
4352 - "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4353 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4354 - "Price": 0, ~/~/ Цена за единицу.
4355 - "PeriodValue": 0, ~/~/ Значение периода.
4356 - "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4357 - }
4358 - ],
4359 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4360 - "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4361 - "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4362 - },
4363 - "Features": [ ~/~/ Набор услуг по тарифу клиента.
4364 - {
4365 - "Feature": "string", ~/~/ Код услуги.
4366 - "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4367 - "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4368 - "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4369 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4370 - "Price": 0, ~/~/ Цена за единицу.
4371 - "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4372 - "PeriodValue": 0, ~/~/ Значение периода.
4373 - "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4374 - "Quantity": 0 ~/~/ Количество использования услуги.
4375 - }
4376 - ]
4377 -}
4378 -)))
4158 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4159 +|ClientId|Идентификатор клиента
4160 +|PlanId|Идентификатор тарифного плана
4161 +|Feature|Код услуги
4162 +|IsEnabled|Признак, определяющий активирована ли услуга
4163 +|IsFactual|Признак, определяющий расчёт по факту
4164 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4165 +|Price|Цена за единицу.
4166 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4167 +|PeriodValue|Значение периода.
4168 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4379 4379  
4380 4380  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4381 4381  
... ... @@ -4480,43 +4480,6 @@
4480 4480  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4481 4481  |msgCount|Кол-во обработанных сообщений всего
4482 4482  
4483 -== **Импортировать историю ТС (Асинхронный запрос)** ==
4484 -
4485 -(% class="box successmessage" %)
4486 -(((
4487 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4488 -)))
4489 -
4490 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4491 -
4492 -Метод запроса: **POST**
4493 -
4494 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4495 -
4496 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4497 -
4498 -
4499 -Ответ:
4500 -
4501 -{
4502 -
4503 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4504 -
4505 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4506 -
4507 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4508 -
4509 - "Message": "string", ~/~/ Информация о выполнении запроса
4510 -
4511 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4512 -
4513 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4514 -
4515 - "Data": "string" ~/~/ Данные
4516 -
4517 -}
4518 -
4519 -
4520 4520  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4521 4521  
4522 4522  (% class="box infomessage" %)
... ... @@ -4534,59 +4534,10 @@
4534 4534   "message": "string"
4535 4535  }
4536 4536  
4537 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4538 -**Параметр**
4539 -)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4540 -**Описание**
4541 -)))
4542 -|(((
4543 -activity
4544 -)))|(((
4545 -Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4546 -)))
4547 -|(((
4548 -progress
4549 -)))|(((
4550 -Guid ТС
4551 -)))
4290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4291 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4292 +|progress|Guid ТС
4552 4552  
4553 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4554 -
4555 -(% class="box infomessage" %)
4556 -(((
4557 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4558 -)))
4559 -
4560 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4561 -
4562 -Метод запроса: **GET**
4563 -
4564 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4565 -
4566 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4567 -
4568 -
4569 -Ответ:
4570 -
4571 -{
4572 -
4573 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4574 -
4575 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
4576 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4577 -
4578 - "Message": "string", ~/~/ Информация о выполнении запроса
4579 -
4580 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4581 -
4582 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4583 -
4584 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4585 -
4586 - "Data": "string" ~/~/ Данные
4587 -
4588 -}
4589 -
4590 4590  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4591 4591  
4592 4592  (% class="box infomessage" %)
... ... @@ -5059,90 +5059,6 @@
5059 5059  ]
5060 5060  
5061 5061  
5062 -== **Отчет трек-датчики** ==
5063 -
5064 -(% class="box infomessage" %)
5065 -(((
5066 -**POST /api/v3/Reports/sensorsWorks**
5067 -)))
5068 -
5069 -**Пример запроса:**
5070 -
5071 -{
5072 - "vehicleIds": [ ~/~/ Список ID объектов
5073 - 0
5074 - ],
5075 - "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
5076 - "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
5077 - "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5078 -}
5079 -
5080 -**Пример ответа:**
5081 -
5082 -(((
5083 -{
5084 - "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5085 - {
5086 - "vehicleId": 0, ~/~/ Идентификатор ТС
5087 - "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5088 - {
5089 - "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5090 - "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5091 - "duration": 0, ~/~/  Продолжительность интервала в секундах.
5092 - "name": "string", ~/~/ Наименование оборудования.
5093 - "mileage": 0, ~/~/ Пробег за время работы оборудования.
5094 - "totalMileage": 0, ~/~/ Общий пробег.
5095 - "avgSpeed": 0 ~/~/ Средняя скорость.
5096 - }
5097 - ]
5098 - }
5099 - ]
5100 -}
5101 -
5102 -
5103 -== **Превышение скорости** ==
5104 -
5105 -(% class="box infomessage" %)
5106 -(((
5107 -**POST /api/v3/Reports/overSpeedDuration**
5108 -)))
5109 -
5110 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5111 -
5112 -Пример запроса:
5113 -
5114 -(((
5115 -{
5116 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5117 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5118 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5119 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5120 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5121 -}
5122 -)))
5123 -
5124 -(((
5125 -
5126 -)))
5127 -
5128 -(((
5129 -Пример ответа:
5130 -)))
5131 -
5132 -(((
5133 -(((
5134 -[
5135 - {
5136 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5137 - "duration": 0, ~/~/ Продолжительность события в секундах 
5138 - "maxSpeed": 0, ~/~/ Максимальная скорость 
5139 - "speedLimit": 0 ~/~/ Ограничение скорости 
5140 - }
5141 -]
5142 -)))
5143 -)))
5144 -)))
5145 -
5146 5146  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5147 5147  
5148 5148  
... ... @@ -5217,16 +5217,13 @@
5217 5217  **POST /api/v3/agroLands**
5218 5218  )))
5219 5219  
5220 -Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5221 -X-agent  - ID клиента
5222 -
5223 5223  Пример запроса:
5224 5224  
5225 5225  (((
5226 5226  {
5227 5227   "extId": "string", 
5228 - "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5229 - "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4845 + "shape": "string", ~/~/ Форма поля
4846 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5230 5230   "display": "string", ~/~/ Настройки отображения
5231 5231   "year": 0, ~/~/ Год поля
5232 5232   "name": "string", ~/~/ Наименование
... ... @@ -5723,7 +5723,7 @@
5723 5723  )))
5724 5724  
5725 5725  
5726 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5343 +== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
5727 5727  )))
5728 5728  )))
5729 5729  )))
... ... @@ -5768,7 +5768,7 @@
5768 5768  ]
5769 5769  
5770 5770  
5771 -== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5388 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
5772 5772  
5773 5773  (% class="box infomessage" %)
5774 5774  (((
... ... @@ -5866,754 +5866,7 @@
5866 5866  ]
5867 5867  
5868 5868  
5869 -= **Раздел: Журнал заданий ** =
5870 5870  
5871 -
5872 -== **Создание задания в Журнале заданий** ==
5873 -
5874 -(% class="box infomessage" %)
5875 -(((
5876 -**POST /api/v3/vehicletasks**
5877 -)))
5878 -
5879 -Пример запроса:
5880 -
5881 -(((
5882 -{
5883 - "vehicleId": 0, ~/~/ Идентификатор ТС
5884 - "description": "string", ~/~/ Описание
5885 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5886 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5887 - "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5888 - "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5889 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5890 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5891 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5892 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5893 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5894 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5895 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5896 - "cost": { 
5897 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5898 - "Name": "string", ~/~/ Наименование
5899 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5900 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5901 - "Norm": 0 ~/~/ Норма внесения
5902 - },
5903 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5904 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5905 - "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5906 - "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5907 - "deleted": true, ~/~/ Признак удаления
5908 - "extId": "string", 
5909 - "GeoIds": [ ~/~/ Cвязанные поля
5910 - 0
5911 - ]
5912 -}
5913 -)))
5914 -
5915 -
5916 -Пример ответа:
5917 -
5918 -{
5919 - "vehicleId": 0, ~/~/ Идентификатор ТС
5920 - "description": "string", ~/~/ Описание
5921 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5922 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5923 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5924 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5925 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5926 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5927 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5928 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5929 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5930 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5931 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5932 - "cost": { 
5933 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5934 - "Name": "string", ~/~/ Наименование
5935 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5936 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5937 - "Norm": 0 ~/~/ Норма внесения
5938 - },
5939 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5940 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5941 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5942 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5943 - "deleted": true, ~/~/ Признак удаления
5944 - "extId": "string", ~/~/ ExtId
5945 - "GeoIds": [ ~/~/ Связанные поля
5946 - 0
5947 - ]
5948 -}
5949 -
5950 -
5951 -== **Редактирование задания в Журнале заданий** ==
5952 -
5953 -(% class="box successmessage" %)
5954 -(((
5955 -**PUT /api/v3/vehicletasks**
5956 -)))
5957 -
5958 -Пример запроса:
5959 -
5960 -(((
5961 -{
5962 - "vehicleId": 0, ~/~/ Идентификатор ТС
5963 - "description": "string", ~/~/ Описание
5964 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5965 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5966 - "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5967 - "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5968 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5969 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5970 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5971 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5972 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5973 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5974 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5975 - "cost": { 
5976 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5977 - "Name": "string", ~/~/ Наименование
5978 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5979 - "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5980 - "Norm": 0 ~/~/ Норма внесения
5981 - },
5982 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5983 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5984 - "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5985 - "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5986 - "deleted": true, ~/~/ Признак удаления
5987 - "extId": "string", ~/~/ ExtId
5988 - "GeoIds": [ ~/~/ Связанные поля
5989 - 0
5990 - ]
5991 -}
5992 -)))
5993 -
5994 -
5995 -Пример ответа:
5996 -
5997 -{
5998 - "vehicleId": 0, ~/~/ Идентификатор ТС
5999 - "description": "string", ~/~/ Описание
6000 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6001 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6002 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6003 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6004 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6005 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6006 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6007 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6008 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6009 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6010 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6011 - "cost": { 
6012 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6013 - "Name": "string", ~/~/ Наименование
6014 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6015 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6016 - "Norm": 0 ~/~/ Норма внесения
6017 - },
6018 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6019 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6020 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6021 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6022 - "deleted": true, ~/~/ Признак удаления
6023 - "extId": "string", ~/~/ ExtId
6024 - "GeoIds": [ ~/~/ Связанные поля
6025 - 0
6026 - ]
6027 -}
6028 -
6029 -
6030 -== **Удаление задания в Журнале заданий** ==
6031 -
6032 -(% class="box warningmessage" %)
6033 -(((
6034 -**DELETE /api/v3/vehicletasks**
6035 -)))
6036 -
6037 -Пример запроса:
6038 -
6039 -(((
6040 -[
6041 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
6042 -]
6043 -)))
6044 -
6045 -(((
6046 -
6047 -)))
6048 -
6049 -Пример ответа:
6050 -
6051 -{
6052 - "vehicleId": 0, ~/~/ Идентификатор ТС
6053 - "description": "string", ~/~/ Описание
6054 - "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6055 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6056 - "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6057 - "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6058 - "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6059 - "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6060 - "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6061 - "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6062 - "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6063 - "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6064 - "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6065 - "cost": { 
6066 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6067 - "Name": "string", ~/~/ Наименование
6068 - "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6069 - "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6070 - "Norm": 0 ~/~/ Норма внесения
6071 - },
6072 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6073 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6074 - "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6075 - "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6076 - "deleted": true, ~/~/ Признак удаления
6077 - "extId": "string", ~/~/ ExtId
6078 - "GeoIds": [ ~/~/ Связанные поля
6079 - 0
6080 - ]
6081 -}
6082 -
6083 -
6084 -== **Получение списка Журнала заданий** ==
6085 -
6086 -(% class="box infomessage" %)
6087 -(((
6088 -**POST /api/v3/vehicletasks/getbyperiod**
6089 -)))
6090 -
6091 -Пример запроса:
6092 -
6093 -(((
6094 -{
6095 - "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6096 - "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6097 - "TimeZone": 0, ~/~/ Часовой пояс.
6098 - "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6099 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6100 - ],
6101 - "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6102 - 0
6103 - ],
6104 - "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6105 - 0
6106 - ],
6107 - "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6108 - "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6109 -}
6110 -)))
6111 -
6112 -
6113 -Пример ответа:
6114 -
6115 -(((
6116 -{
6117 - "total": 0,  ~/~/ Общее количество записей
6118 - "pages": 0,  ~/~/ Общее количество страниц
6119 - "currentPage": 0, ~/~/ Текущая страница
6120 - "items": [  ~/~/ Записи 
6121 - {
6122 - "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6123 - "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6124 - "name": "string", ~/~/ Название задания.
6125 - "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6126 - "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6127 - "workKind": "string", ~/~/ Вид работ
6128 - "techOp": "string", ~/~/ Тех. операция
6129 - "trailerModel": "string", ~/~/ Модель агрегата
6130 - "width": "string", ~/~/ Ширина, м
6131 - "speed": "string", ~/~/ Тех. скорость
6132 - "fields": "string", ~/~/ Поля
6133 - "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6134 - "vehicles": "string", ~/~/ Объект-модель
6135 - "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6136 - "drivers": "string", ~/~/ Водители
6137 - "tmc": "string", ~/~/ ТМЦ
6138 - "client": "string", ~/~/  Клиент
6139 - "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6140 - "dep": "string", ~/~/ Подразделение
6141 - "geoIds": [ ~/~/  Связанные поля
6142 - 0
6143 - ]
6144 - }
6145 - ]
6146 -}
6147 -)))
6148 -
6149 -
6150 -= **Раздел: Роли** =
6151 -
6152 -== **Получение списка клиентских и системных ролей пользователя ** ==
6153 -
6154 -(% class="box successmessage" %)
6155 -(((
6156 -**POST /api/v3/groups/find**
6157 -)))
6158 -
6159 -Пример запроса:
6160 -
6161 -(((
6162 -{
6163 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6164 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6165 -}
6166 -)))
6167 -
6168 -(((
6169 -
6170 -)))
6171 -
6172 -(((
6173 -Пример ответа:
6174 -)))
6175 -
6176 -(((
6177 -(((
6178 -{
6179 - "groups": [  ~/~/ Системные роли пользователя
6180 - {
6181 - "code": "string", ~/~/ Код роли.
6182 - "name": "string", ~/~/ Имя  
6183 - "shortName": "string" ~/~/ Короткое имя 
6184 - }
6185 - ],
6186 - "customGroups": [ ~/~/ Системные роли пользователя
6187 - {
6188 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6189 - "name": "string", ~/~/ Наименование 
6190 - "shortName": "string", ~/~/ Короткое наименование 
6191 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6192 - }
6193 - ]
6194 -}
6195 -)))
6196 -)))
6197 -
6198 -(((
6199 -
6200 -)))
6201 -
6202 -(((
6203 -
6204 -)))
6205 -
6206 -= **Раздел: Локатор ** =
6207 -
6208 -
6209 -== **Получение списка локаторов, доступных пользователю ** ==
6210 -
6211 -(% class="box infomessage" %)
6212 -(((
6213 -**GET /api/v3/locators **
6214 -)))
6215 -
6216 -В заголовках запроса: X-Auth: Токен авторизации
6217 -
6218 -
6219 -Пример ответа:
6220 -
6221 -(((
6222 -(((
6223 -{
6224 - "vehiclesIds": [ ~/~/ Объекты
6225 - 0
6226 - ],
6227 - "geoIds": [ ~/~/ Геозоны
6228 - 0
6229 - ],
6230 - "fieldsIds": [ ~/~/ Поля
6231 - 0
6232 - ],
6233 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6234 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6235 - "agentName": "string", ~/~/ Наименование агента.
6236 - "isEnabled": true, ~/~/ Активность 
6237 - "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6238 - "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6239 - "name": "string", ~/~/ Наименование.
6240 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6241 - "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6242 - "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6243 - "validity": 0, ~/~/ Значение срока действия
6244 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6245 - "autoProlongation": true, ~/~/ Автопродление срока действия.
6246 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6247 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6248 - "url": "string", ~/~/ Ссылка
6249 - "language": 0, ~/~/ Язык
6250 - "showVehicleName": true, ~/~/ Наименование объекта
6251 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6252 - "allowTrackReport": true, ~/~/ Трек
6253 - "showTrackTracing": true, ~/~/ Трассировка трека
6254 - "showSensors": true, ~/~/ Датчик
6255 - "availableMapLayers": [ ~/~/  Слои на карте
6256 - 0
6257 - ]
6258 -}
6259 -)))
6260 -)))
6261 -
6262 -
6263 -== **Получение перечня моделей ** ==
6264 -
6265 -(% class="box successmessage" %)
6266 -(((
6267 -**POST /api/v3/models/find**
6268 -)))
6269 -
6270 -Пример запроса:
6271 -
6272 -(((
6273 -(((
6274 -{
6275 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6276 - "name": "string", ~/~/ Наименование локатора
6277 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6278 -)))
6279 -
6280 -
6281 -
6282 - Пример ответа: 
6283 -
6284 -
6285 -(((
6286 -[
6287 - {
6288 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6289 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6290 - "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6291 - "name": "string", ~/~/ Наименование локатора
6292 - "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
6293 - }
6294 -]
6295 -)))
6296 -)))
6297 -
6298 -
6299 -== **Создание локатора** ==
6300 -
6301 -(% class="box successmessage" %)
6302 -(((
6303 -**POST /api/v3/locators**
6304 -)))
6305 -
6306 -Пример запроса:
6307 -
6308 -(((
6309 -{
6310 - "isEnabled": true, ~/~/ Активность
6311 - "name": "string", ~/~/ Наименование локатора
6312 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6313 - "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6314 - "validity": 0, ~/~/ Срок действия в днях (1-90)
6315 - "autoProlongation": true, ~/~/ Автопродление срока действия.
6316 - "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6317 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6318 - "vehiclesIds": [ ~/~/ Oбъекты
6319 - 0
6320 - ],
6321 - "geoIds": [ ~/~/ Геозоны
6322 - 0
6323 - ],
6324 - "fieldsIds": [ ~/~/ Поля
6325 - 0
6326 - ],
6327 - "showVehicleName": true, ~/~/ Наименование объекта
6328 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6329 - "allowTrackReport": true, ~/~/ Трек
6330 - "showTrackTracing": true, ~/~/ Трассировка трека
6331 - "showSensors": true, ~/~/ Датчик
6332 - "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ГИС) 
6333 - ]
6334 -}
6335 -)))
6336 -
6337 -
6338 -Пример ответа:
6339 -
6340 -(((
6341 -3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6342 -)))
6343 -
6344 -
6345 -
6346 -== **Изменение локатора** ==
6347 -
6348 -(% class="box infomessage" %)
6349 -(((
6350 -**PUT /api/v3/locators**
6351 -)))
6352 -
6353 -Пример запроса:
6354 -
6355 -(((
6356 -{
6357 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6358 - "isEnabled": true, ~/~/ Активность 
6359 - "name": "string", ~/~/ Наименование
6360 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6361 - "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6362 - "validity": 0, ~/~/ Срок действия в днях (1-90)
6363 - "autoProlongation": true, ~/~/ Автопродление срока действия
6364 - "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6365 - "vehiclesIds": [ ~/~/ Oбъекты
6366 - 0
6367 - ],
6368 - "geoIds": [ ~/~/ Геозоны
6369 - 0
6370 - ],
6371 - "fieldsIds": [ ~/~/ Поля
6372 - 0
6373 - ],
6374 - "showVehicleName": true, ~/~/ Наименование объекта
6375 - "showVehicleDirection": true, ~/~/ Направление движения на треке
6376 - "allowTrackReport": true, ~/~/ Трек
6377 - "showTrackTracing": true, ~/~/ Трассировка трека
6378 - "showSensors": true, ~/~/ Датчик
6379 - "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ГИС) 
6380 - ]
6381 -}
6382 -
6383 -
6384 -)))
6385 -
6386 -Пример ответа:
6387 -
6388 -200 ~/~/ Success
6389 -
6390 -
6391 -== **Удалить локатор** ==
6392 -
6393 -(% class="box warningmessage" %)
6394 -(((
6395 -**DELETE /api/v3/locators**
6396 -)))
6397 -
6398 -Пример запроса:
6399 -
6400 -(((
6401 -[
6402 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6403 -]
6404 -)))
6405 -
6406 -
6407 -
6408 -= **Раздел: Яндекс Маршруты** =
6409 -
6410 -
6411 -== **Возвращение списка маршрутов** ==
6412 -
6413 -(% class="box infomessage" %)
6414 -(((
6415 -**GET /api/v3/TransportRoutes**
6416 -)))
6417 -
6418 -Пример запроса:
6419 -Id  ~/~/ Идентификатор поля
6420 -
6421 -
6422 -Пример ответа:
6423 -
6424 -(((
6425 -[
6426 - {
6427 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6428 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6429 - "name": "string", ~/~/ Наименование маршрута.
6430 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6431 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
6432 - 0
6433 - ]
6434 - }
6435 -]
6436 -)))
6437 -
6438 -
6439 -
6440 -== **Добавить маршрут** ==
6441 -
6442 -(% class="box infomessage" %)
6443 -(((
6444 -**POST /api/v3/TransportRoutes**
6445 -)))
6446 -
6447 -Пример запроса: 
6448 -{
6449 - "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6450 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6451 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6452 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
6453 - 0
6454 - ]
6455 -}
6456 -
6457 -
6458 -Пример ответа:
6459 -
6460 -(((
6461 -{
6462 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6463 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6464 - "name": "string", ~/~/ Определяет наименование маршрута 
6465 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6466 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6467 - 0
6468 - ]
6469 -}
6470 -)))
6471 -
6472 -
6473 -== **Обновление маршрута** ==
6474 -
6475 -(% class="box successmessage" %)
6476 -(((
6477 -**PUT /api/v3/TransportRoutes**
6478 -)))
6479 -
6480 -Пример запроса:
6481 -
6482 -(((
6483 -{
6484 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6485 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6486 - "name": "string", ~/~/ Опредлеляет наименование маршрута.
6487 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6488 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6489 - 0
6490 - ]
6491 -}
6492 -)))
6493 -
6494 -
6495 -Пример ответа:
6496 -
6497 -(((
6498 -{
6499 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6500 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6501 - "name": "string", ~/~/ Определяет наименование маршрута 
6502 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6503 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6504 - 0
6505 - ]
6506 -}
6507 -)))
6508 -
6509 -
6510 -== **Получить связки маршрутов ТС** ==
6511 -
6512 -(% class="box infomessage" %)
6513 -(((
6514 -**POST /api/v3/TransportRoutes/getroutesvehicles**
6515 -)))
6516 -
6517 -Пример запроса:
6518 -
6519 -(((
6520 -[
6521 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6522 -]
6523 -)))
6524 -
6525 -
6526 -Пример ответа:
6527 -
6528 -(((
6529 -[
6530 - {
6531 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6532 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6533 - }
6534 -]
6535 -)))
6536 -
6537 -
6538 -== **Удалить маршрут** ==
6539 -
6540 -(% class="box warningmessage" %)
6541 -(((
6542 -**DELETE /api/v3/TransportRoutes/{id}**
6543 -)))
6544 -
6545 -Пример запроса:
6546 -Id  ~/~/ Идентификатор поля
6547 -
6548 -
6549 -
6550 -= **Раздел: Управление доступа к машинам** =
6551 -
6552 -
6553 -== Получение списка транспортных средств видимых пользователю ==
6554 -
6555 -(% class="box infomessage" %)
6556 -(((
6557 -**GET /api/v3/UserVisibleVehicles/{userId}**
6558 -)))
6559 -
6560 -Пример ответа:
6561 -
6562 -(((
6563 -{
6564 - "vehicleIds": [  ~/~/ Идентификаторы ТС
6565 - 0
6566 - ]
6567 -}
6568 -)))
6569 -
6570 -
6571 -
6572 -== Задает видимость транспортных средств пользователю ==
6573 -
6574 -(% class="box infomessage" %)
6575 -(((
6576 -**POST /api/v3/UserVisibleVehicles**
6577 -)))
6578 -
6579 -Пример запроса:
6580 -
6581 -(((
6582 -(((
6583 -{
6584 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6585 - "vehicleIds": [ ~/~/ Идентификаторы ТС
6586 - 0
6587 - ]
6588 -}
6589 -)))
6590 -
6591 -(((
6592 -
6593 -)))
6594 -
6595 -(((
6596 -
6597 -)))
6598 -
6599 -(((
6600 -Пример ответа :
6601 -)))
6602 -
6603 -(((
6604 -
6605 -)))
6606 -
6607 -(((
6608 -200 ~/~/ Success
6609 -)))
6610 -)))
6611 -
6612 -
6613 -
6614 -
6615 -
6616 -
6617 6617  (% class="box" lang="en-US" style="text-align: center;" %)
6618 6618  (((
6619 6619  (% 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 г.