Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Павел Субботин on 2025/12/11 11:25
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.subbotinpa - Content
-
... ... @@ -6,7 +6,7 @@ 6 6 просим вас соблюдать несколько простых правил при использовании API-команд:## 7 7 ))) 8 8 9 -* Формировать не более 3отчётоводновременно.9 +* Формировать не более 2 запроса в секунду с кратковременным разрешением до 3-х. 10 10 * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. ... ... @@ -287,28 +287,6 @@ 287 287 "bankKS": "string" ~/~/ корр. счёт 288 288 } 289 289 290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 - 312 312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 313 313 314 314 (% class="box warningmessage" %) ... ... @@ -454,7 +454,7 @@ 454 454 [ 455 455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 456 456 ], 457 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 458 458 } 459 459 { 460 460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -766,6 +766,11 @@ 766 766 (% style="text-align:left" %) 767 767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 768 768 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 751 + 769 769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 770 770 771 771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -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,7 +1628,7 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 1632 1633 1633 (% class="box infomessage" %) 1634 1634 ((( ... ... @@ -2389,7 +2389,7 @@ 2389 2389 Тело запроса: 2390 2390 2391 2391 { 2392 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2393 2393 "vehicleIds": [0], ~/~/ Список ID объектов 2394 2394 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2395 2395 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2436,7 +2436,7 @@ 2436 2436 Тело запроса: 2437 2437 2438 2438 { 2439 - "sampling": 0, ~/~/ Частота дискретизации всекундах, минимум 60 секунд.Весь периодразбивает на подпериоды с указанной частотой.2422 + "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой) 2440 2440 "vehicleIds": [0], ~/~/ Список ID объектов 2441 2441 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2442 2442 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2455,6 +2455,8 @@ 2455 2455 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2456 2456 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2457 2457 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2458 2458 "fuelConsumption": 0, ~/~/ Расход топлива 2459 2459 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2460 2460 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2584,185 +2584,415 @@ 2584 2584 В заголовках запроса: X-Auth: Токен авторизации 2585 2585 2586 2586 2587 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2572 +В массиве указываем id объектов через запятую 2588 2588 2589 2589 Ответ: 2575 + 2576 +[ 2590 2590 { 2591 - "vehicleId": 0, ~/~/Идентификатор объекта.2592 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2593 - "vehicleNumber": " string",~/~/Номер объекта.2594 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2595 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2596 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2597 - "speed": 0,~/~/Скорость объекта.2598 - "course": 0,~/~/Курс движения [0;360]2599 - "latitude": 0,~/~/Широта [-90°;90°].2600 - "longitude": 0,~/~/Долгота [-180°;180°]. 2601 - "address": " string",~/~/Адрес.2602 - "geozones": [ ~/~/Сведения по геозонам. 2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2584 + "speed": 31, ~/~/ Скорость объекта 2585 + "course": 116, ~/~/ Курс движения [0;360] 2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2589 + "geozones": [ ~/~/ Сведения по геозонам. 2603 2603 { 2604 - "id": 0, 2605 - "name": "string" 2591 + "id": 10225647, ~/~/ ID Геозоны 2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2593 + }, 2594 + { 2595 + "id": 10282875, ~/~/ ID Геозоны 2596 + "name": "Ё2" ~/~/ Наименование геозоны 2597 + }, 2598 + { 2599 + "id": 10226240, ~/~/ ID Геозоны 2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2601 + }, 2602 + { 2603 + "id": 9747869, ~/~/ ID Геозоны 2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2605 + }, 2606 + { 2607 + "id": 10221123, ~/~/ ID Геозоны 2608 + "name": "53r" ~/~/ Наименование геозоны 2609 + }, 2610 + { 2611 + "id": 10197638, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2606 2606 } 2614 + ] 2615 + } 2607 2607 2608 2608 2609 2609 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2610 2610 2611 -== (% style="color:#000000; font-size:16px" %)**Получение спискавсехгеообъектов**(%%) ==2620 +== (% style="color:#000000; font-size:16px" %)**Получение информации о геозоне по ID геозоны **(%%) == 2612 2612 2613 2613 (% class="box infomessage" %) 2614 2614 ((( 2615 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/find**2624 +**GET /api/v3/gis/{geozoneId}** 2616 2616 ))) 2617 2617 2618 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2627 +Пример запроса: 2628 +\\geozoneId ~/~/ id геозоны 2619 2619 2620 -(% style="color:#000000" %)Метод запроса: **POST** 2621 2621 2622 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2631 +(% style="text-align:left" %) 2632 +Ответ: 2623 2623 2624 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2634 +((( 2635 +{ 2636 + "id": 0, ~/~/ Идентификатор объекта геозоны 2637 + "name": "string", ~/~/ Наименование объекта геозоны 2638 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2639 + "description": "string", ~/~/ Описание объекта геозоны 2640 + "beginCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата начала расчетов для геозоны 2641 + "endCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата окончания расчетов для геозоны 2642 + "settingsData": "string", ~/~/ Параметры отображения в формате XML. 2643 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2644 + "radius": 0, ~/~/ Радиус геозоны 2645 + "shape": "string", ~/~/ Координаты геозоны 2646 + "shape_format": "string" ~/~/ Формат xml,json 2647 +} 2648 +))) 2625 2625 2626 -(% style="text-align:left" %) 2627 -Тело запроса: 2650 +((( 2651 + 2652 +))) 2628 2628 2629 -(% style="text-align:left" %) 2654 +== **Удаление геообъекта ** == 2655 + 2656 +((( 2657 + 2658 +))) 2659 + 2660 +(% class="box errormessage" %) 2661 +((( 2662 +**DELETE /api/v3/gis/{geozoneId}** 2663 +))) 2664 + 2665 +((( 2666 +Пример запроса: 2667 +))) 2668 + 2669 +((( 2670 + 2671 +))) 2672 + 2673 +((( 2674 +geozoneId ~/~/ Id геообъекта 2675 +))) 2676 + 2677 +((( 2678 + 2679 +))) 2680 + 2681 +((( 2682 +Пример ответа: 2683 +))) 2684 + 2685 +((( 2686 + 2687 +))) 2688 + 2689 +((( 2690 +200 ~/~/ Success 2691 +))) 2692 + 2693 +((( 2694 + 2695 +))) 2696 + 2697 +== **Возвращение данных по пересечению объектами геозон ** == 2698 + 2699 +((( 2700 + 2701 +))) 2702 + 2703 +(% class="box successmessage" %) 2704 +((( 2705 +**POST /api/v3/gis/intersections/geozones** 2706 +))) 2707 + 2708 +((( 2709 +Пример запроса: 2710 +))) 2711 + 2712 +((( 2713 +((( 2630 2630 { 2631 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2715 + "startDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время начала расчета 2716 + "endDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время конца расчета 2717 + "ids": [ ~/~/ Идентификаторы объектов 2718 + 0 2719 + ], 2720 + "byTime": 0, ~/~/ объединение геообъектов по времени (секунды) 2721 + "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры) 2722 + "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек. 2723 + "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта 2724 + "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет 2632 2632 } 2726 +))) 2727 +))) 2633 2633 2634 -(% style="text-align:left" %) 2635 -Ответ: 2729 +((( 2730 + 2731 +))) 2636 2636 2733 +((( 2734 +Пример ответа: 2735 +))) 2736 + 2737 +((( 2738 +((( 2637 2637 [ 2638 2638 { 2639 - "id": 0, ~/~/ Идентификатор объекта геозоны 2640 - "name": "string", ~/~/ Название объекта геозоны 2641 - "type": 0, ~/~/ Тип объекта геозоны 2642 - "fname": "string", ~/~/ Имя файла 2643 - "parentId": "string", ~/~/ Идентификатор клиента 2644 - "radius": 0, ~/~/ Радиус геообъекта 2645 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2646 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2647 - "description": "string", ~/~/ Описание 2648 - "area": 0, ~/~/ Площадь, м^^2^^ 2649 - "perimetr": 0, ~/~/ Периметр, м 2650 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2741 + "geozoneId": 0, ~/~/ ID геозоны 2742 + "geozoneName": "string", ~/~/ Наименование геозоны 2743 + "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны 2744 + "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны 2745 + "duration": 0, ~/~/ Продолжительность внутри геозоны 2746 + "vehicleId": 0, ~/~/ ID объекта 2747 + "vehicleName": "string", ~/~/ Имя объекта 2748 + "motoHours": 0 ~/~/ Моточасы 2651 2651 } 2652 2652 ] 2751 +))) 2752 +))) 2653 2653 2654 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2655 - 2656 -(% class="box infomessage" %) 2657 2657 ((( 2658 - (%style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**2755 + 2659 2659 ))) 2660 2660 2661 - (% style="color:#000000"%)Метод позволяет получитьсписокпересеченийвыбранныхобъектов совсеми геообъектамизавыбранный период.2758 +== **Возвращение данных по пересечению геозон для объектов с заданными ID ** == 2662 2662 2663 -(% style="color:#000000" %)Метод запроса: **POST** 2760 +((( 2761 + 2762 +))) 2664 2664 2665 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2764 +(% class="box successmessage" %) 2765 +((( 2766 +**POST /api/v3/gis/intersections/vehicles** 2767 +))) 2666 2666 2667 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2769 +((( 2770 +Пример запроса: 2771 +))) 2668 2668 2669 -(% style="text-align:left" %) 2670 -Тело запроса: 2773 +((( 2774 + 2775 +))) 2671 2671 2777 +((( 2778 +((( 2672 2672 { 2673 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2674 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2675 - "ids": [ ], ~/~/ Массив id объектов 2676 - "byTime": 0, ~/~/ Объединение событий по времени 2677 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2678 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2679 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2780 + "startDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время начала расчета 2781 + "endDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время конца расчета 2782 + "ids": [ ~/~/ Идентификаторы объектов 2783 + 0 2784 + ], 2785 + "byTime": 0, ~/~/ объединение геообъектов по времени (секунды) 2786 + "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры) 2787 + "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек. 2788 + "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта 2789 + "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет 2680 2680 } 2791 +))) 2792 +))) 2681 2681 2682 -Ответ: 2794 +((( 2795 + 2796 +))) 2797 + 2798 +((( 2799 +Пример ответа: 2800 +))) 2801 + 2802 +((( 2683 2683 [ 2684 2684 { 2685 - "geozoneId": 0, ~/~/ ID геоо бъекта2686 - "geozoneName": "string", ~/~/ Название геообъекта2687 - "startDate": "202 3-08-02T06:13:18.554Z", ~/~/Датавъезда2688 - "endDate": "202 3-08-02T06:13:18.554Z", ~/~/Датавыезда2689 - "duration": 0, ~/~/ Продолжительность нахождениявгеообъекте2805 + "geozoneId": 0, ~/~/ ID геозоны 2806 + "geozoneName": "string", ~/~/ Наименование геозоны 2807 + "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны 2808 + "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны 2809 + "duration": 0, ~/~/ Продолжительность внутри геозоны 2690 2690 "vehicleId": 0, ~/~/ ID объекта 2691 - "vehicleName": "string" ~/~/ Имя объекта 2811 + "vehicleName": "string", ~/~/ Имя объекта 2812 + "motoHours": 0 ~/~/ Моточасы 2692 2692 } 2693 2693 ] 2815 +))) 2694 2694 2695 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2696 - 2697 -(% class="box infomessage" %) 2698 2698 ((( 2699 - (%style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**2818 + 2700 2700 ))) 2701 2701 2702 - (% style="color:#000000"%)Метод позволяет получитьсписокпересечений выбранныхгеообъектов со всеми объектамиза выбранныйпериод.2821 +== **Получение списка геозон** == 2703 2703 2704 -(% style="color:#000000" %)Метод запроса: **POST** 2823 +((( 2824 + 2825 +))) 2705 2705 2706 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2827 +(% class="box successmessage" %) 2828 +((( 2829 +**POST /api/v3/gis/find** 2830 +))) 2707 2707 2708 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2832 +((( 2833 +((( 2834 +Пример запроса: 2835 +))) 2709 2709 2710 -(% style="text-align:left" %) 2711 -Тело запроса: 2837 +((( 2838 + 2839 +))) 2712 2712 2841 +((( 2713 2713 { 2714 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2715 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2716 - "ids": [ ], ~/~/ Массив id геообъектов 2717 - "byTime": 0, ~/~/ Объединение событий по времени 2718 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2719 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2720 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2843 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные. 2721 2721 } 2845 +))) 2846 +))) 2722 2722 2723 -Ответ: 2848 +((( 2849 + 2850 +))) 2724 2724 2852 +((( 2853 +Пример ответа: 2854 +))) 2855 + 2856 +((( 2857 +((( 2725 2725 [ 2726 2726 { 2727 - "geozoneId": 0, ~/~/ ID геообъекта 2728 - "geozoneName": "string", ~/~/ Название геообъекта 2729 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2730 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2731 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2732 - "vehicleId": 0, ~/~/ ID объекта 2733 - "vehicleName": "string" ~/~/ Имя объекта 2860 + "id": 0, ~/~/ Идентификатор объекта геозоны 2861 + "name": "string", ~/~/ Название объекта геозоны 2862 + "type": 0, ~/~/ Тип объекта геозоны 2863 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2864 + "fname": "string", ~/~/ Имя файла 2865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 2866 + "beginCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата начала расчетов для геозоны 2867 + "endCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата окончания расчетов для геозоны 2868 + "description": "string", ~/~/ Описание объекта геозоны 2869 + "area": 0, ~/~/ Площадь, м2 2870 + "perimetr": 0, ~/~/ Периметр, м 2871 + "createDate": "2025-12-04T07:31:23.082Z" ~/~/ Дата создания в бд 2734 2734 } 2735 2735 ] 2874 +))) 2875 +))) 2736 2736 2877 +((( 2878 + 2879 +))) 2737 2737 2738 -== (% style="color:#000000; font-size:16px" %)**Обновить информациюпогеозоне**(%%)==2881 +== **Создание геообъекта** == 2739 2739 2883 +((( 2884 + 2885 +))) 2886 + 2740 2740 (% class="box successmessage" %) 2741 2741 ((( 2742 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**PUT**(%%)**/api/v3/gis**2889 +**POST /api/v3/gis** 2743 2743 ))) 2744 2744 2745 -( % style="color:#000000" %)Метод запроса: **PUT**2746 - 2892 +((( 2893 +((( 2747 2747 Пример запроса: 2895 +\\{ 2896 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 2897 + "name": "string", ~/~/ Наименование объекта геозоны 2898 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2899 + "description": "string", ~/~/ Описание объекта геозоны 2900 + "beginCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата начала расчетов для геозоны 2901 + "endCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата окончания расчетов для геозоны 2902 + "settingsData": "string", ~/~/ Параметры отображения в формате XML 2903 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2904 + "radius": 0, ~/~/ Радиус геозоны 2905 + "shape": "string", ~/~/ Координаты геозоны 2906 + "shape_format": "string" ~/~/ Формат xml,json, 2907 +} 2908 +))) 2909 +))) 2748 2748 2749 2749 ((( 2912 + 2913 +))) 2914 + 2915 +((( 2916 +Пример ответа: 2917 +))) 2918 + 2919 +((( 2920 + 2921 +))) 2922 + 2923 +((( 2924 +200 ~/~/ Success 2925 +))) 2926 + 2927 +((( 2928 + 2929 +))) 2930 + 2931 +== **Редактирование геообъекта ** == 2932 + 2933 +((( 2934 + 2935 +))) 2936 + 2937 +(% class="box warningmessage" %) 2938 +((( 2939 +**PUT /api/v3/gis** 2940 +))) 2941 + 2942 +((( 2943 +((( 2944 +Пример запроса: 2750 2750 { 2751 - "id": 0, ~/~/ Идентификатор объекта геозоны 2752 - "name": "string", ~/~/ Наименование объекта геозоны 2753 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2754 - "description": "string", ~/~/ Описание объекта геозоны 2755 - "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2756 - "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2757 - "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2946 + "id": 0, ~/~/ Идентификатор объекта геозоны 2947 + "name": "string", ~/~/ Наименование объекта геозоны 2948 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2949 + "description": "string", ~/~/ Описание объекта геозоны 2950 + "beginCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата начала расчетов для геозоны 2951 + "endCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата окончания расчетов для геозоны 2952 + "settingsData": "string", ~/~/ Параметры отображения в формате XML. 2953 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2954 + "radius": 0, ~/~/ Радиус геозоны 2955 + "shape": "string", ~/~/ Координаты геозоны 2956 + "shape_format": "string" ~/~/Формат xml,json 2758 2758 } 2759 2759 ))) 2959 +))) 2760 2760 2961 +((( 2962 + 2963 +))) 2761 2761 2762 -Пример ответа: 2965 +((( 2966 +Пример ответа: 2967 +))) 2763 2763 2969 +((( 2970 + 2971 +))) 2972 + 2973 +((( 2764 2764 200 ~/~/ Success 2975 +))) 2765 2765 2977 +((( 2978 + 2979 +))) 2980 + 2766 2766 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2767 2767 2768 2768 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2794,7 +2794,7 @@ 2794 2794 "id": 0, ~/~/ ID уведомления 2795 2795 "name": "string", ~/~/ Название уведомления 2796 2796 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2797 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 3012 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2798 2798 "userId": "", ~/~/ Пользователь, создавший уведомление 2799 2799 "parentId": "", ~/~/ Идентификатор клиента 2800 2800 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2801,6 +2801,151 @@ 2801 2801 } 2802 2802 ] 2803 2803 3019 + 3020 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 3021 + 3022 +(% class="box infomessage" %) 3023 +((( 3024 +**POST /api/v3/notifications** 3025 +))) 3026 + 3027 +Метод запроса **POST** 3028 + 3029 +(% style="text-align: left;" %) 3030 +(% style="color:#000000" %)Пример запроса 3031 + 3032 +((( 3033 +{ 3034 + "id": 0, ~/~/ ID правила 3035 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 3036 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 3037 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 3038 + "name": "string", ~/~/ Имя правила 3039 + "active": true, ~/~/ Активность правила 3040 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 3041 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 3042 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 3043 + ], 3044 + "vehicleIds": [ ~/~/ Список объектов для анализа. 3045 + 0 3046 + ], 3047 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 3048 + 0 3049 + ], 3050 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 3051 + 0 3052 + ], 3053 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 3054 + "additionalProp1": "string", 3055 + "additionalProp2": "string", 3056 + "additionalProp3": "string" 3057 + }, 3058 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 3059 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 3060 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3061 + ], 3062 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 3063 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 3064 + "string" 3065 + ], 3066 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 3067 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 3068 + { 3069 + "id": 0, ~/~/ Идентификатор участника чата. 3070 + "info": "string" ~/~/ Дополнительные сведения. 3071 + } 3072 + ], 3073 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 3074 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 3075 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 3076 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 3077 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 3078 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 3079 + "timezone": 0, ~/~/ часовой пояс 3080 + "validity": 0, ~/~/ Срок действия в днях (1-90). 3081 + "autoProlongation": true, ~/~/ Автопродление срока действия. 3082 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 3083 + { 3084 + "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 - Срок действия правила истек 3085 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 3086 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 3087 + "additionalProp1": "string", 3088 + "additionalProp2": "string", 3089 + "additionalProp3": "string" 3090 + } 3091 + } 3092 + ] 3093 +} 3094 +))) 3095 + 3096 +((( 3097 + 3098 +))) 3099 + 3100 +Ответ: 3101 + 3102 +{ 3103 + "id": 0, ~/~/ ID правила 3104 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 3105 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 3106 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 3107 + "name": "string", ~/~/ Имя правила 3108 + "active": true, ~/~/ Активность правила 3109 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 3110 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 3111 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 3112 + ], 3113 + "vehicleIds": [ ~/~/ Список объектов для анализа. 3114 + 0 3115 + ], 3116 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 3117 + 0 3118 + ], 3119 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 3120 + 0 3121 + ], 3122 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 3123 + "additionalProp1": "string", 3124 + "additionalProp2": "string", 3125 + "additionalProp3": "string" 3126 + }, 3127 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 3128 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 3129 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3130 + ], 3131 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 3132 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 3133 + "string" 3134 + ], 3135 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 3136 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 3137 + { 3138 + "id": 0, ~/~/ Идентификатор участника чата. 3139 + "info": "string" ~/~/ Дополнительные сведения. 3140 + } 3141 + ], 3142 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 3143 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 3144 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 3145 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 3146 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 3147 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 3148 + "timezone": 0, ~/~/ часовой пояс 3149 + "validity": 0, ~/~/ Срок действия в днях (1-90). 3150 + "autoProlongation": true, ~/~/ Автопродление срока действия. 3151 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 3152 + { 3153 + "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 - Срок действия правила истек 3154 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 3155 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 3156 + "additionalProp1": "string", 3157 + "additionalProp2": "string", 3158 + "additionalProp3": "string" 3159 + } 3160 + } 3161 + ] 3162 +} 3163 + 2804 2804 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2805 2805 2806 2806 (% class="box infomessage" %) ... ... @@ -4018,16 +4018,12 @@ 4018 4018 Тело запроса: 4019 4019 4020 4020 { 4021 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4022 - "Balance": 0 4381 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4382 + "Balance": 0 ~/~/ Значение баланса. 4023 4023 } 4024 4024 4025 4025 Ответ: Success 4026 4026 4027 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4028 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4029 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4030 - 4031 4031 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4032 4032 4033 4033 (% class="box warningmessage" %) ... ... @@ -4039,16 +4039,29 @@ 4039 4039 4040 4040 Тело запроса: 4041 4041 4398 +((( 4042 4042 { 4043 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4044 - " Balance": 04400 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4401 + "amount": 0 ~/~/ Сумма пополнения баланса 4045 4045 } 4403 +))) 4046 4046 4405 +((( 4406 + 4407 +))) 4408 + 4047 4047 Ответ: Success 4048 4048 4049 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4050 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4051 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4411 +((( 4412 +{ 4413 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4414 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4415 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4416 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4417 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4418 + "Description": "string" ~/~/ Описание корректировки. 4419 +} 4420 +))) 4052 4052 4053 4053 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4054 4054 ... ... @@ -4061,16 +4061,25 @@ 4061 4061 4062 4062 Тело запроса: 4063 4063 4433 +((( 4064 4064 { 4065 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4066 - " Balance": 04435 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4436 + "amount": 0 ~/~/ Сумма списания с баланса 4067 4067 } 4438 +))) 4068 4068 4069 4069 Ответ: Success 4070 4070 4071 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4072 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4073 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4442 +((( 4443 +{ 4444 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4445 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4446 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4447 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4448 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4449 + "Description": "string" ~/~/ Описание корректировки 4450 +} 4451 +))) 4074 4074 4075 4075 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4076 4076 ... ... @@ -4081,28 +4081,35 @@ 4081 4081 4082 4082 Тело запроса: 4083 4083 4462 +((( 4084 4084 { 4085 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4086 - "CalculationType": 0, 4087 - "PermissibleBalance": 0, 4088 - "DefermentDays": 0, 4089 - "SendUiNotifications": true, 4090 - "SendEmailNotifications": true, 4091 - "IsPrivate": true, 4464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4465 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4466 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4467 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4468 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4469 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4092 4092 } 4471 +))) 4093 4093 4473 +((( 4474 + 4475 +))) 4476 + 4094 4094 Ответ: Success 4095 4095 4096 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4097 -|ClientId|Идентификатор клиента 4098 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4099 -|PermissibleBalance|Допустимый баланс 4100 -|DefermentDays|((( 4101 -Отсрочка, количество дней 4479 +((( 4480 +{ 4481 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4482 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4483 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4484 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4485 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4486 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4487 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4488 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4489 +} 4102 4102 ))) 4103 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4104 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4105 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4106 4106 4107 4107 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4108 4108 ... ... @@ -4114,35 +4114,68 @@ 4114 4114 Тело запроса: 4115 4115 4116 4116 { 4117 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4118 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4119 - "Features": [ 4502 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4503 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4504 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4120 4120 { 4121 - "Feature": "string", 4122 - "IsEnabled": true, 4123 - "IsFactual": true, 4124 - "Limit": 0, 4125 - "Price": 0, 4126 - "DebitDate": "2023-10-18T13:26:58.987Z", 4127 - "PeriodValue": 0, 4128 - "PeriodType": 0 4506 + "Feature": "string", ~/~/ Код услуги. 4507 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4508 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4509 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4510 + "Price": 0, ~/~/ Цена за единицу. 4511 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4512 + "PeriodValue": 0, ~/~/ Значение периода. 4513 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4129 4129 } 4130 4130 ] 4131 4131 } 4132 4132 4518 + 4133 4133 Ответ: Success 4134 4134 4135 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4136 -|ClientId|Идентификатор клиента 4137 -|PlanId|Идентификатор тарифного плана 4138 -|Feature|Код услуги 4139 -|IsEnabled|Признак, определяющий активирована ли услуга 4140 -|IsFactual|Признак, определяющий расчёт по факту 4141 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4142 -|Price|Цена за единицу. 4143 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4144 -|PeriodValue|Значение периода. 4145 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4521 +((( 4522 +{ 4523 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4524 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4525 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4526 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4527 + "Name": "string", ~/~/ Наименование. 4528 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4529 + "Constraint": { ~/~/ Ограничения по тарифу 4530 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4531 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4532 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4533 + }, 4534 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4535 + { 4536 + "Feature": "string", ~/~/Код услуги. 4537 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4538 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4539 + "Price": 0, ~/~/ Цена за единицу. 4540 + "PeriodValue": 0, ~/~/ Значение периода. 4541 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4542 + } 4543 + ], 4544 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4545 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4546 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4547 + }, 4548 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4549 + { 4550 + "Feature": "string", ~/~/ Код услуги. 4551 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4552 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4553 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4554 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4555 + "Price": 0, ~/~/ Цена за единицу. 4556 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4557 + "PeriodValue": 0, ~/~/ Значение периода. 4558 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4559 + "Quantity": 0 ~/~/ Количество использования услуги. 4560 + } 4561 + ] 4562 +} 4563 +))) 4146 4146 4147 4147 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4148 4148 ... ... @@ -5215,33 +5215,9 @@ 5215 5215 ))) 5216 5216 5217 5217 5218 -== **Удаление существующего поля** == 5219 - 5220 -(% class="box errormessage" %) 5221 5221 ((( 5222 -**DELETE /api/v3/agroLands/{id}** 5223 -))) 5224 - 5225 -Пример запроса: 5226 -id ~/~/ Идентификатор поля 5227 - 5228 -Пример ответа: 5229 - 5230 5230 ((( 5231 -200 ~/~/ Успех 5232 -))) 5233 - 5234 5234 ((( 5235 - 5236 -))) 5237 - 5238 -((( 5239 -((( 5240 -((( 5241 - 5242 -))) 5243 - 5244 -((( 5245 5245 == **Изменение поля** == 5246 5246 5247 5247 (% class="box infomessage" %) ... ... @@ -5487,9 +5487,102 @@ 5487 5487 "perimetr": 0, ~/~/ ериметр, м 5488 5488 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5489 5489 } 5884 + 5885 + 5886 +== **Какие поля посещал объект** == 5887 + 5888 +(% class="box successmessage" %) 5889 +((( 5890 +**POST /api/v3/agroLands/visitingByVehicle** 5490 5490 ))) 5491 5491 5893 +Пример запроса: 5492 5492 5895 +{ 5896 + "vehicleId": 0, ~/~/ id объекта 5897 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5898 + "byTime": 0, ~/~/ Объединение событий по времени 5899 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5900 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5901 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5902 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5903 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5904 +} 5905 + 5906 +Пример ответа: 5907 + 5908 +[ 5909 + { 5910 + "fieldId": 0, ~/~/ id объекта 5911 + "vehicleName": "string", ~/~/ Наименование объекта 5912 + "fieldName": "string", ~/~/ Наименование поля 5913 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5914 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5915 + "vehicleId": 0, ~/~/ Идентификатор ТС 5916 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5917 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5918 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5919 + "mileage": 0 ~/~/ Пробег 5920 + } 5921 +] 5922 +))) 5923 + 5924 + 5925 +== **Посещение поля объектами ** == 5926 + 5927 +(% class="box successmessage" %) 5928 +((( 5929 +**POST /api/v3/agroLands/visitingByField** 5930 +))) 5931 + 5932 +Пример запроса: 5933 +{ 5934 + "fieldId": 0, ~/~/ ID поля 5935 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5936 + "byTime": 0, ~/~/ Объединение событий по времени 5937 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5938 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5939 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5940 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5941 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5942 +} 5943 + 5944 +Пример ответа: 5945 + 5946 +[ 5947 + { 5948 + "fieldId": 0, ~/~/ ID поля 5949 + "vehicleName": "string", ~/~/ Наименование объекта 5950 + "fieldName": "string", ~/~/ Имя поля 5951 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5952 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5953 + "vehicleId": 0, ~/~/ Идентификатор ТС 5954 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5955 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5956 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5957 + "mileage": 0 ~/~/ Пробег 5958 + } 5959 +] 5960 + 5961 + 5962 +== **Удаление существующего поля** == 5963 + 5964 +(% class="box errormessage" %) 5965 +((( 5966 +**DELETE /api/v3/agroLands/{id}** 5967 +))) 5968 + 5969 +Пример запроса: 5970 +id ~/~/ Идентификатор поля 5971 + 5972 +Пример ответа: 5973 + 5974 +((( 5975 +200 ~/~/ Успех 5976 + 5977 + 5978 +))) 5979 + 5493 5493 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5494 5494 ))) 5495 5495 ))) ... ... @@ -5592,7 +5592,6 @@ 5592 5592 5593 5593 В заголовках запроса: X-Auth: Токен авторизации 5594 5594 5595 - 5596 5596 Пример запроса: 5597 5597 5598 5598 ((( ... ... @@ -5679,7 +5679,6 @@ 5679 5679 } 5680 5680 ))) 5681 5681 5682 - 5683 5683 Пример ответа: 5684 5684 5685 5685 { ... ... @@ -5810,11 +5810,9 @@ 5810 5810 ))) 5811 5811 5812 5812 ((( 5813 - 6298 +Пример ответа: 5814 5814 ))) 5815 5815 5816 -Пример ответа: 5817 - 5818 5818 { 5819 5819 "vehicleId": 0, ~/~/ Идентификатор ТС 5820 5820 "description": "string", ~/~/ Описание ... ... @@ -5914,54 +5914,13 @@ 5914 5914 ))) 5915 5915 5916 5916 5917 -= **Раздел: Локатор** =6400 += **Раздел: Роли** = 5918 5918 6402 +== **Получение списка клиентских и системных ролей пользователя ** == 5919 5919 5920 -== **Получение списка локаторов, доступных пользователю ** == 5921 - 5922 -(% class="box infomessage" %) 5923 -((( 5924 -**GET /api/v3/locators** 5925 -))) 5926 - 5927 -В заголовках запроса: X-Auth: Токен авторизации 5928 - 5929 - 5930 -Пример ответа: 5931 - 5932 -((( 5933 -[ 5934 - { 5935 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5936 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5937 - "agentName": "string", ~/~/ Наименование агента. 5938 - "isEnabled": true, ~/~/ Активен 5939 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5940 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5941 - "name": "string", ~/~/ Наименование 5942 - "status": 0, ~/~/ 5943 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5944 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5945 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5946 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5947 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5948 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5949 - "url": "string", ~/~/ Ссылка 5950 - "language": 0, ~/~/ Язык. 5951 - "vehiclesCount": 0, ~/~/ Количество объектов. 5952 - "geozonesCount": 0, ~/~/ Количество геозон. 5953 - "fieldsCount": 0 ~/~/ Количество полей. 5954 - } 5955 -] 5956 -))) 5957 - 5958 - 5959 - 5960 -== **Создание локатора** == 5961 - 5962 5962 (% class="box successmessage" %) 5963 5963 ((( 5964 -**POST /api/v3/locators**6406 +**POST /api/v3/groups/find** 5965 5965 ))) 5966 5966 5967 5967 Пример запроса: ... ... @@ -5968,282 +5968,284 @@ 5968 5968 5969 5969 ((( 5970 5970 { 5971 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5972 - "isEnabled": true, ~/~/ Активность 5973 - "name": "string", ~/~/ Наименование локатора 5974 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5975 - "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5976 - "validity": 0, ~/~/ Срок действия в днях (1-90) 5977 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5978 - "url": "string", ~/~/ Ссылка 5979 - "language": 0 ~/~/ Язык 6413 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6414 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 5980 5980 } 5981 5981 ))) 5982 5982 5983 - 5984 -Пример ответа: 5985 - 5986 5986 ((( 5987 - 3fa85f64-5717-4562-b3fc-2c963f66afa6~/~/ Идентификатор локатора6419 + 5988 5988 ))) 5989 5989 5990 - 5991 - 5992 -== **Изменение локатора** == 5993 - 5994 -(% class="box infomessage" %) 5995 5995 ((( 5996 - **PUT/api/v3/locators**6423 +Пример ответа: 5997 5997 ))) 5998 5998 5999 -Пример запроса: 6000 - 6001 6001 ((( 6427 +((( 6002 6002 { 6003 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6004 - "isEnabled": true, ~/~/ Активность 6005 - "name": "string", ~/~/ Наименование 6006 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6007 - "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6008 - "validity": 0, ~/~/ Срок действия в днях (1-90) 6009 - "autoProlongation": true, ~/~/ Автопродление срока действия 6010 - "url": "string", ~/~/ Ссылка 6011 - "language": 0 ~/~/ Язык 6429 + "groups": [ ~/~/ Системные роли пользователя 6430 + { 6431 + "code": "string", ~/~/ Код роли. 6432 + "name": "string", ~/~/ Имя 6433 + "shortName": "string" ~/~/ Короткое имя 6434 + } 6435 + ], 6436 + "customGroups": [ ~/~/ Системные роли пользователя 6437 + { 6438 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6439 + "name": "string", ~/~/ Наименование 6440 + "shortName": "string", ~/~/ Короткое наименование 6441 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6442 + } 6443 + ] 6012 6012 } 6013 6013 ))) 6014 - 6015 - 6016 -Пример ответа: 6017 - 6018 -200 ~/~/ Success 6019 - 6020 - 6021 -== **Удалить локатор** == 6022 - 6023 -(% class="box warningmessage" %) 6024 -((( 6025 -**DELETE /api/v3/locators** 6026 6026 ))) 6027 6027 6028 -Пример запроса: 6029 - 6030 6030 ((( 6031 -[ 6032 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6033 -] 6449 + 6034 6034 ))) 6035 6035 6452 += **Раздел: Локатор ** = 6036 6036 6037 6037 6038 -= ** Раздел: ЯндексМаршруты** =6455 +== **Получение данных по локатору** == 6039 6039 6040 - 6041 -== **Возвращение списка маршрутов** == 6042 - 6043 6043 (% class="box infomessage" %) 6044 6044 ((( 6045 -**GET /api/v3/ TransportRoutes**6459 +**GET /api/v3/locators/{locatorId}** 6046 6046 ))) 6047 6047 6048 -Пример запроса: 6049 -Id ~/~/ Идентификатор поля 6462 +В запросе указывается locatorid - идентификатор локатора 6050 6050 6051 - 6052 6052 Пример ответа: 6053 6053 6054 6054 ((( 6055 -[ 6056 - { 6057 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6058 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6059 - "name": "string", ~/~/ Наименование маршрута. 6060 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6061 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6062 - 0 6063 - ] 6064 - } 6065 -] 6066 -))) 6067 - 6068 - 6069 - 6070 -== **Добавить маршрут** == 6071 - 6072 -(% class="box infomessage" %) 6073 6073 ((( 6074 -**POST /api/v3/TransportRoutes** 6075 -))) 6076 - 6077 -Пример запроса: 6078 6078 { 6079 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6080 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6081 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6082 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6469 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6083 6083 0 6084 - ] 6085 -} 6471 + ], 6472 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6473 + 0 6474 + ], 6475 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6476 + 0 6477 + ], 6478 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6479 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6480 + "agentName": "string", ~/~/ Наименование агента. 6481 + "isEnabled": true, ~/~/ Активность 6482 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6483 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6484 + "name": "string", ~/~/ Наименование. 6485 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6486 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6487 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6488 + "validity": 0, ~/~/ Значение срока действия 6489 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6490 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6491 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6492 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6493 + "url": "string", ~/~/ Ссылка 6494 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6086 6086 6496 + "showVehicleName": true, ~/~/ Наименование объекта 6497 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6498 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6499 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6500 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6501 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6087 6087 6088 - Примерответа:6503 + 1 6089 6089 6090 -((( 6091 -{ 6092 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6093 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6094 - "name": "string", ~/~/ Определяет наименование маршрута 6095 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6096 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6097 - 0 6098 6098 ] 6099 6099 } 6100 6100 ))) 6508 +))) 6101 6101 6102 6102 6103 -== ** Обновлениемаршрута** ==6511 +== **Создание локатора** == 6104 6104 6105 6105 (% class="box successmessage" %) 6106 6106 ((( 6107 -**P UT/api/v3/TransportRoutes**6515 +**POST /api/v3/locators** 6108 6108 ))) 6109 6109 6110 -Пример запроса: 6518 +Пример запроса: 6111 6111 6112 6112 ((( 6113 6113 { 6114 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6115 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6116 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6117 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6118 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6522 + "isEnabled": true, ~/~/ Активность 6523 + "name": "string", ~/~/ Наименование локатора 6524 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6525 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6526 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6527 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6528 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6529 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6530 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6119 6119 0 6120 - ] 6532 + ], 6533 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6534 + 0 6535 + ], 6536 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6537 + 0 6538 + ], 6539 + 6540 + "showVehicleName": true, ~/~/ Наименование объекта 6541 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6542 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6543 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6544 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6545 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6546 + 6547 + 1 6548 + 6549 + ] 6121 6121 } 6122 6122 ))) 6123 6123 6553 +Пример ответа: 6124 6124 6125 -Пример ответа: 6126 - 6127 6127 ((( 6128 -{ 6129 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6130 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6131 - "name": "string", ~/~/ Определяет наименование маршрута 6132 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6133 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6134 - 0 6135 - ] 6136 -} 6556 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6137 6137 ))) 6138 6138 6139 6139 6140 -== ** ПолучитьсвязкимаршрутовТС** ==6560 +== **Выводит список локаторов ** == 6141 6141 6142 -(% class="box infomessage" %)6562 +(% class="box successmessage" %) 6143 6143 ((( 6144 -**POST /api/v3/TransportRoutes/getroutesvehicles**6564 +**POST /api/v3/locators/find** 6145 6145 ))) 6146 6146 6147 -Пример запроса: 6567 +Пример запроса: 6148 6148 6149 6149 ((( 6150 - [6151 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/идентификатормаршрута6152 - ]6570 +{ 6571 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6572 +} 6153 6153 ))) 6154 6154 6575 +((( 6576 + 6577 +))) 6155 6155 6156 -Пример ответа: 6579 +Пример ответа: 6157 6157 6158 6158 ((( 6159 6159 [ 6160 6160 { 6161 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6162 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6584 + "vehiclesCount": 0, ~/~/ Количество объектов. 6585 + "geozonesCount": 0, ~/~/ Количество геозон. 6586 + "fieldsCount": 0, ~/~/ Количество полей. 6587 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6588 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6589 + "agentName": "string", ~/~/ Наименование агента. 6590 + "isEnabled": true, ~/~/ Активность локатора 6591 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6592 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6593 + "name": "string", ~/~/ Наименование локатора 6594 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6595 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6596 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6597 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6598 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6599 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6600 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6601 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6602 + "url": "string", ~/~/ ссылка на локатор 6603 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6604 + "showVehicleName": true, ~/~/ Наименование объекта 6605 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6606 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6607 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6608 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6609 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6610 + 6611 + 0 6612 + ] 6163 6163 } 6164 6164 ] 6165 6165 ))) 6166 6166 6167 6167 6168 -== ** Удалитьмаршрут** ==6618 +== **Изменение локатора** == 6169 6169 6170 -(% class="box warningmessage" %)6620 +(% class="box infomessage" %) 6171 6171 ((( 6172 -** DELETE/api/v3/TransportRoutes/{id}**6622 +**PUT /api/v3/locators** 6173 6173 ))) 6174 6174 6175 6175 Пример запроса: 6176 -Id ~/~/ Идентификатор поля 6177 6177 6178 - 6179 - 6180 -= **Раздел: Управление доступа к машинам** = 6181 - 6182 - 6183 -== Получение списка транспортных средств видимых пользователю == 6184 - 6185 -(% class="box infomessage" %) 6186 6186 ((( 6187 -**GET /api/v3/UserVisibleVehicles/{userId}** 6188 -))) 6189 - 6190 -Пример ответа: 6191 - 6192 -((( 6193 6193 { 6194 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6630 + "isEnabled": true, ~/~/ Активность 6631 + "name": "string", ~/~/ Наименование 6632 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6633 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6634 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6635 + "autoProlongation": true, ~/~/ Автопродление срока действия 6636 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6637 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6195 6195 0 6639 + ], 6640 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6641 + 0 6642 + ], 6643 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6644 + 0 6645 + ], 6646 + "showVehicleName": true, ~/~/ Наименование объекта 6647 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6648 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6649 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6650 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6651 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6652 + 6653 + 0 6654 + 6196 6196 ] 6197 6197 } 6657 + 6658 + 6198 6198 ))) 6199 6199 6661 +Пример ответа: 6200 6200 6663 +200 ~/~/ Success 6201 6201 6202 -== Задает видимость транспортных средств пользователю == 6203 6203 6204 -(% class="box infomessage" %) 6666 +== **Удалить локатор** == 6667 + 6668 +(% class="box warningmessage" %) 6205 6205 ((( 6206 -** POST /api/v3/UserVisibleVehicles**6670 +**DELETE /api/v3/locators** 6207 6207 ))) 6208 6208 6209 -Пример запроса: 6673 +Пример запроса: 6210 6210 6211 6211 ((( 6212 -((( 6213 -{ 6214 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6215 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6216 - 0 6217 - ] 6218 -} 6676 +[ 6677 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6678 +] 6219 6219 ))) 6220 6220 6221 -((( 6222 - 6223 -))) 6224 6224 6225 -((( 6226 - 6227 -))) 6682 += = 6228 6228 6229 6229 ((( 6230 -Пример ответа : 6231 -))) 6232 - 6233 6233 ((( 6234 6234 6235 6235 ))) 6236 - 6237 -((( 6238 -200 ~/~/ Success 6239 6239 ))) 6240 -))) 6241 6241 6242 6242 6243 - 6244 - 6245 - 6246 - 6247 6247 (% class="box" lang="en-US" style="text-align: center;" %) 6248 6248 ((( 6249 6249 (% 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]] **