Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/09/16 11:13
<
отредактировано Андрей Калиновский
на 2025/05/14 16:54
на 2025/05/14 16:54
отредактировано Андрей Калиновский
на 2025/09/16 11:13
на 2025/09/16 11:13
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -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" %)**Получение информации о модели объекта**(%%) == ... ... @@ -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,6 @@ 2436 2436 Тело запроса: 2437 2437 2438 2438 { 2439 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 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, ~/~/ Уровень топлива на конец периода 2440 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2441 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2458 2458 "fuelConsumption": 0, ~/~/ Расход топлива 2459 2459 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2460 2460 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2467,7 +2467,6 @@ 2467 2467 (% class="box warningmessage" %) 2468 2468 ((( 2469 2469 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2470 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2471 2471 ))) 2472 2472 2473 2473 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == ... ... @@ -2506,11 +2506,19 @@ 2506 2506 { 2507 2507 "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 2508 2508 2492 +((( 2509 2509 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2510 2510 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2511 2511 "valueFuel": 0, ~/~/ Количество 2512 2512 "fuelStart": 0, ~/~/ Уровень топлива на начало события 2513 2513 "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2498 +))) 2499 + 2500 +((( 2501 + "latitude": 0, ~/~/ Широта. 2502 + "longitude": 0 ~/~/ Долгота. 2503 +))) 2504 + 2514 2514 } 2515 2515 ] 2516 2516 } ... ... @@ -2584,223 +2584,241 @@ 2584 2584 В заголовках запроса: X-Auth: Токен авторизации 2585 2585 2586 2586 2587 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2578 +В массиве указываем id объектов через запятую 2588 2588 2589 2589 Ответ: 2581 + 2582 +[ 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": [ ~/~/Сведения по геозонам. 2584 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2585 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2586 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2587 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2588 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2589 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2590 + "speed": 31, ~/~/ Скорость объекта 2591 + "course": 116, ~/~/ Курс движения [0;360] 2592 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2593 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2594 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2595 + "geozones": [ ~/~/ Сведения по геозонам. 2603 2603 { 2604 - "id": 0, 2605 - "name": "string" 2597 + "id": 10225647, ~/~/ ID Геозоны 2598 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2599 + }, 2600 + { 2601 + "id": 10282875, ~/~/ ID Геозоны 2602 + "name": "Ё2" ~/~/ Наименование геозоны 2603 + }, 2604 + { 2605 + "id": 10226240, ~/~/ ID Геозоны 2606 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2607 + }, 2608 + { 2609 + "id": 9747869, ~/~/ ID Геозоны 2610 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2611 + }, 2612 + { 2613 + "id": 10221123, ~/~/ ID Геозоны 2614 + "name": "53r" ~/~/ Наименование геозоны 2615 + }, 2616 + { 2617 + "id": 10197638, ~/~/ ID Геозоны 2618 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2606 2606 } 2620 + ] 2621 + } 2607 2607 2608 2608 2609 -= (%style="color:#000000;font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%)=2624 += = 2610 2610 2611 -= =(% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==2626 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2612 2612 2628 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2629 + 2613 2613 (% class="box infomessage" %) 2614 2614 ((( 2615 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/find**2632 +**POST /api/v3/notifications/find** 2616 2616 ))) 2617 2617 2618 - (% style="color:#000000" %)Методпозволяетполучитьсписокгеообъектовклиента.Возвращает массивгеообъектовсо всей информациейоних.2635 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2619 2619 2620 -(% style="color:#000000" %)Метод запроса: **POST** 2637 +(% style="text-align: left;" %) 2638 +Метод запроса **POST** 2621 2621 2622 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2640 +(% style="text-align: left;" %) 2641 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2623 2623 2643 +(% style="text-align: left;" %) 2624 2624 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2625 2625 2626 -(% style="text-align:left" %) 2627 -Тело запроса: 2628 - 2629 -(% style="text-align:left" %) 2630 2630 { 2631 - "parentId": " 3fa85f64-5717-4562-b3fc-2c963f66afa6"2647 + "parentId": "" ~/~/ id клиента 2632 2632 } 2633 2633 2634 -(% style="text-align:left" %) 2635 2635 Ответ: 2636 2636 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", ~/~/ Дата создания 2654 + "id": 0, ~/~/ ID уведомления 2655 + "name": "string", ~/~/ Название уведомления 2656 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2657 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2658 + "userId": "", ~/~/ Пользователь, создавший уведомление 2659 + "parentId": "", ~/~/ Идентификатор клиента 2660 + "parentName": "string" ~/~/ Имя клиента 2651 2651 } 2652 2652 ] 2653 2653 2654 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2655 2655 2656 -(% class="box infomessage" %) 2657 -((( 2658 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2659 -))) 2665 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2660 2660 2661 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2662 - 2663 -(% style="color:#000000" %)Метод запроса: **POST** 2664 - 2665 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2666 - 2667 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2668 - 2669 -(% style="text-align:left" %) 2670 -Тело запроса: 2671 - 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 ~/~/ Фильтрация событий по пробегу половины периметра 2680 -} 2681 - 2682 -Ответ: 2683 -[ 2684 - { 2685 - "geozoneId": 0, ~/~/ ID геообъекта 2686 - "geozoneName": "string", ~/~/ Название геообъекта 2687 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2688 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2689 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2690 - "vehicleId": 0, ~/~/ ID объекта 2691 - "vehicleName": "string" ~/~/ Имя объекта 2692 - } 2693 -] 2694 - 2695 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2696 - 2697 2697 (% class="box infomessage" %) 2698 2698 ((( 2699 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/geozones**2669 +**POST /api/v3/notifications** 2700 2700 ))) 2701 2701 2702 - (% style="color:#000000" %)Методпозволяетполучить список пересечений выбранных геообъектовсо всеми объектамиза выбранный период.2672 +Метод запроса **POST** 2703 2703 2704 -(% style="color:#000000" %)Метод запроса: **POST** 2674 +(% style="text-align: left;" %) 2675 +(% style="color:#000000" %)Пример запроса 2705 2705 2706 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2707 - 2708 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2709 - 2710 -(% style="text-align:left" %) 2711 -Тело запроса: 2712 - 2677 +((( 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 ~/~/ Фильтрация событий по пробегу половины периметра 2679 + "id": 0, ~/~/ ID правила 2680 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2681 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2682 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2683 + "name": "string", ~/~/ Имя правила 2684 + "active": true, ~/~/ Активность правила 2685 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2686 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2687 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2688 + ], 2689 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2690 + 0 2691 + ], 2692 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2693 + 0 2694 + ], 2695 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2696 + 0 2697 + ], 2698 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2699 + "additionalProp1": "string", 2700 + "additionalProp2": "string", 2701 + "additionalProp3": "string" 2702 + }, 2703 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2704 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2705 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2706 + ], 2707 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2708 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2709 + "string" 2710 + ], 2711 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2712 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2713 + { 2714 + "id": 0, ~/~/ Идентификатор участника чата. 2715 + "info": "string" ~/~/ Дополнительные сведения. 2716 + } 2717 + ], 2718 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2719 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2720 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2721 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2722 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2723 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2724 + "timezone": 0, ~/~/ часовой пояс 2725 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2726 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2727 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2728 + { 2729 + "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 - Срок действия правила истек 2730 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2731 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2732 + "additionalProp1": "string", 2733 + "additionalProp2": "string", 2734 + "additionalProp3": "string" 2735 + } 2736 + } 2737 + ] 2721 2721 } 2722 - 2723 -Ответ: 2724 - 2725 -[ 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" ~/~/ Имя объекта 2734 - } 2735 -] 2736 - 2737 - 2738 -== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2739 - 2740 -(% class="box successmessage" %) 2741 -((( 2742 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2743 2743 ))) 2744 2744 2745 -(% style="color:#000000" %)Метод запроса: **PUT** 2746 - 2747 -Пример запроса: 2748 - 2749 2749 ((( 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. 2758 -} 2742 + 2759 2759 ))) 2760 2760 2761 - 2762 -Пример ответа: 2763 - 2764 -200 ~/~/ Success 2765 - 2766 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2767 - 2768 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2769 - 2770 -(% class="box infomessage" %) 2771 2771 ((( 2772 - **POST/api/v3/notifications/find**2746 + 2773 2773 ))) 2774 2774 2775 - Методвозвращаетинформацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.2749 +Ответ: 2776 2776 2777 -(% style="text-align: left;" %) 2778 -Метод запроса **POST** 2779 - 2780 -(% style="text-align: left;" %) 2781 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2782 - 2783 -(% style="text-align: left;" %) 2784 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2785 - 2786 2786 { 2787 - "parentId": "" ~/~/ id клиента 2752 + "id": 0, ~/~/ ID правила 2753 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2754 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2755 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2756 + "name": "string", ~/~/ Имя правила 2757 + "active": true, ~/~/ Активность правила 2758 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2759 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2760 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2761 + ], 2762 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2763 + 0 2764 + ], 2765 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2766 + 0 2767 + ], 2768 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2769 + 0 2770 + ], 2771 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2772 + "additionalProp1": "string", 2773 + "additionalProp2": "string", 2774 + "additionalProp3": "string" 2775 + }, 2776 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2777 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2778 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2779 + ], 2780 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2781 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2782 + "string" 2783 + ], 2784 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2785 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2786 + { 2787 + "id": 0, ~/~/ Идентификатор участника чата. 2788 + "info": "string" ~/~/ Дополнительные сведения. 2789 + } 2790 + ], 2791 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2792 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2793 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2794 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2795 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2796 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2797 + "timezone": 0, ~/~/ часовой пояс 2798 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2799 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2800 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2801 + { 2802 + "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 - Срок действия правила истек 2803 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2804 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2805 + "additionalProp1": "string", 2806 + "additionalProp2": "string", 2807 + "additionalProp3": "string" 2808 + } 2809 + } 2810 + ] 2788 2788 } 2789 2789 2790 -Ответ: 2791 - 2792 -[ 2793 - { 2794 - "id": 0, ~/~/ ID уведомления 2795 - "name": "string", ~/~/ Название уведомления 2796 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2797 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2798 - "userId": "", ~/~/ Пользователь, создавший уведомление 2799 - "parentId": "", ~/~/ Идентификатор клиента 2800 - "parentName": "string" ~/~/ Имя клиента 2801 - } 2802 -] 2803 - 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 4030 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4031 + "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 4047 +((( 4042 4042 { 4043 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4044 - " Balance": 04049 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4050 + "amount": 0 ~/~/ Сумма пополнения баланса 4045 4045 } 4052 +))) 4046 4046 4054 +((( 4055 + 4056 +))) 4057 + 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" %)Значение баланса 4060 +((( 4061 +{ 4062 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4063 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4064 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4065 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4066 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4067 + "Description": "string" ~/~/ Описание корректировки. 4068 +} 4069 +))) 4052 4052 4053 4053 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4054 4054 ... ... @@ -4061,16 +4061,25 @@ 4061 4061 4062 4062 Тело запроса: 4063 4063 4082 +((( 4064 4064 { 4065 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4066 - " Balance": 04084 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4085 + "amount": 0 ~/~/ Сумма списания с баланса 4067 4067 } 4087 +))) 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" %)Значение баланса 4091 +((( 4092 +{ 4093 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4094 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4095 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4096 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4097 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4098 + "Description": "string" ~/~/ Описание корректировки 4099 +} 4100 +))) 4074 4074 4075 4075 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4076 4076 ... ... @@ -4081,28 +4081,35 @@ 4081 4081 4082 4082 Тело запроса: 4083 4083 4111 +((( 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, 4113 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4114 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4115 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4116 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4117 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4118 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4092 4092 } 4120 +))) 4093 4093 4122 +((( 4123 + 4124 +))) 4125 + 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 -Отсрочка, количество дней 4128 +((( 4129 +{ 4130 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4131 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4132 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4133 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4134 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4135 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4136 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4137 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4138 +} 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": [ 4151 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4152 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4153 + "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 4155 + "Feature": "string", ~/~/ Код услуги. 4156 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4157 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4158 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4159 + "Price": 0, ~/~/ Цена за единицу. 4160 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4161 + "PeriodValue": 0, ~/~/ Значение периода. 4162 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4129 4129 } 4130 4130 ] 4131 4131 } 4132 4132 4167 + 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 - Месяцы 4170 +((( 4171 +{ 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4174 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4175 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4176 + "Name": "string", ~/~/ Наименование. 4177 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4178 + "Constraint": { ~/~/ Ограничения по тарифу 4179 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4180 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4181 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4182 + }, 4183 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4184 + { 4185 + "Feature": "string", ~/~/Код услуги. 4186 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4187 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4188 + "Price": 0, ~/~/ Цена за единицу. 4189 + "PeriodValue": 0, ~/~/ Значение периода. 4190 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4191 + } 4192 + ], 4193 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4194 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4195 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4196 + }, 4197 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4198 + { 4199 + "Feature": "string", ~/~/ Код услуги. 4200 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4201 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4202 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4203 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4204 + "Price": 0, ~/~/ Цена за единицу. 4205 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4206 + "PeriodValue": 0, ~/~/ Значение периода. 4207 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4208 + "Quantity": 0 ~/~/ Количество использования услуги. 4209 + } 4210 + ] 4211 +} 4212 +))) 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 } 5533 + 5534 + 5535 +== **Какие поля посещал объект** == 5536 + 5537 +(% class="box successmessage" %) 5538 +((( 5539 +**POST /api/v3/agroLands/visitingByVehicle** 5490 5490 ))) 5491 5491 5542 +Пример запроса: 5492 5492 5544 +{ 5545 + "vehicleId": 0, ~/~/ id объекта 5546 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5547 + "byTime": 0, ~/~/ Объединение событий по времени 5548 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5549 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5550 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5551 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5552 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5553 +} 5554 + 5555 +Пример ответа: 5556 + 5557 +[ 5558 + { 5559 + "fieldId": 0, ~/~/ id объекта 5560 + "vehicleName": "string", ~/~/ Наименование объекта 5561 + "fieldName": "string", ~/~/ Наименование поля 5562 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5563 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5564 + "vehicleId": 0, ~/~/ Идентификатор ТС 5565 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5566 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5567 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5568 + "mileage": 0 ~/~/ Пробег 5569 + } 5570 +] 5571 +))) 5572 + 5573 + 5574 +== **Посещение поля объектами ** == 5575 + 5576 +(% class="box successmessage" %) 5577 +((( 5578 +**POST /api/v3/agroLands/visitingByField** 5579 +))) 5580 + 5581 +Пример запроса: 5582 +{ 5583 + "fieldId": 0, ~/~/ ID поля 5584 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5585 + "byTime": 0, ~/~/ Объединение событий по времени 5586 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5587 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5588 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5589 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5590 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5591 +} 5592 + 5593 +Пример ответа: 5594 + 5595 +[ 5596 + { 5597 + "fieldId": 0, ~/~/ ID поля 5598 + "vehicleName": "string", ~/~/ Наименование объекта 5599 + "fieldName": "string", ~/~/ Имя поля 5600 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5601 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5602 + "vehicleId": 0, ~/~/ Идентификатор ТС 5603 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5604 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5605 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5606 + "mileage": 0 ~/~/ Пробег 5607 + } 5608 +] 5609 + 5610 + 5611 +== **Удаление существующего поля** == 5612 + 5613 +(% class="box errormessage" %) 5614 +((( 5615 +**DELETE /api/v3/agroLands/{id}** 5616 +))) 5617 + 5618 +Пример запроса: 5619 +id ~/~/ Идентификатор поля 5620 + 5621 +Пример ответа: 5622 + 5623 +((( 5624 +200 ~/~/ Успех 5625 + 5626 + 5627 +))) 5628 + 5493 5493 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5494 5494 ))) 5495 5495 ))) ... ... @@ -5914,49 +5914,129 @@ 5914 5914 ))) 5915 5915 5916 5916 6053 += **Раздел: Роли** = 6054 + 6055 +== **Получение списка клиентских и системных ролей пользователя ** == 6056 + 6057 +(% class="box successmessage" %) 6058 +((( 6059 +**POST /api/v3/groups/find** 6060 +))) 6061 + 6062 +Пример запроса: 6063 + 6064 +((( 6065 +{ 6066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6067 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6068 +} 6069 +))) 6070 + 6071 +((( 6072 + 6073 +))) 6074 + 6075 +((( 6076 +Пример ответа: 6077 +))) 6078 + 6079 +((( 6080 +((( 6081 +{ 6082 + "groups": [ ~/~/ Системные роли пользователя 6083 + { 6084 + "code": "string", ~/~/ Код роли. 6085 + "name": "string", ~/~/ Имя 6086 + "shortName": "string" ~/~/ Короткое имя 6087 + } 6088 + ], 6089 + "customGroups": [ ~/~/ Системные роли пользователя 6090 + { 6091 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6092 + "name": "string", ~/~/ Наименование 6093 + "shortName": "string", ~/~/ Короткое наименование 6094 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6095 + } 6096 + ] 6097 +} 6098 +))) 6099 +))) 6100 + 6101 +((( 6102 + 6103 +))) 6104 + 6105 +((( 6106 + 6107 +))) 6108 + 5917 5917 = **Раздел: Локатор ** = 5918 5918 5919 5919 5920 -== **Получение списка локаторов,доступных пользователю** ==6112 +== **Получение данных по локатору** == 5921 5921 5922 5922 (% class="box infomessage" %) 5923 5923 ((( 5924 -**GET /api/v3/locators** 6116 +**GET /api/v3/locators/{locatorId}** 5925 5925 ))) 5926 5926 5927 -В за головкахзапроса:X-Auth:Токен авторизации6119 +В запросе указывается locatorid - идентификатор локатора 5928 5928 5929 5929 5930 5930 Пример ответа: 5931 5931 5932 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 -] 6125 +((( 6126 +{ 6127 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6128 + 0 6129 + ], 6130 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6131 + 0 6132 + ], 6133 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6134 + 0 6135 + ], 6136 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6137 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6138 + "agentName": "string", ~/~/ Наименование агента. 6139 + "isEnabled": true, ~/~/ Активность 6140 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6141 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6142 + "name": "string", ~/~/ Наименование. 6143 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6144 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6145 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6146 + "validity": 0, ~/~/ Значение срока действия 6147 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6148 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6149 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6150 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6151 + "url": "string", ~/~/ Ссылка 6152 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6153 + 6154 + "showVehicleName": true, ~/~/ Наименование объекта 6155 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6156 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6157 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6158 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6159 + "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ГИС) 6160 + 6161 + 1 6162 + 6163 + ] 6164 +} 5956 5956 ))) 6166 +))) 5957 5957 5958 5958 6169 +((( 6170 +((( 6171 + 6172 +))) 6173 +))) 5959 5959 6175 + 5960 5960 == **Создание локатора** == 5961 5961 5962 5962 (% class="box successmessage" %) ... ... @@ -5968,7 +5968,6 @@ 5968 5968 5969 5969 ((( 5970 5970 { 5971 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5972 5972 "isEnabled": true, ~/~/ Активность 5973 5973 "name": "string", ~/~/ Наименование локатора 5974 5974 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5975,8 +5975,28 @@ 5975 5975 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5976 5976 "validity": 0, ~/~/ Срок действия в днях (1-90) 5977 5977 "autoProlongation": true, ~/~/ Автопродление срока действия. 5978 - "url": "string", ~/~/ Ссылка 5979 - "language": 0 ~/~/ Язык 6193 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6195 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6196 + 0 6197 + ], 6198 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6199 + 0 6200 + ], 6201 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6202 + 0 6203 + ], 6204 + 6205 + "showVehicleName": true, ~/~/ Наименование объекта 6206 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6207 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6208 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6209 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6210 + "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ГИС) 6211 + 6212 + 1 6213 + 6214 + ] 5980 5980 } 5981 5981 ))) 5982 5982 ... ... @@ -5988,7 +5988,69 @@ 5988 5988 ))) 5989 5989 5990 5990 6226 +== **Выводит список локаторов ** == 5991 5991 6228 +(% class="box successmessage" %) 6229 +((( 6230 +**POST /api/v3/locators/find** 6231 +))) 6232 + 6233 +Пример запроса: 6234 + 6235 +((( 6236 +{ 6237 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6238 +} 6239 +))) 6240 + 6241 +((( 6242 + 6243 +))) 6244 + 6245 +((( 6246 + 6247 +))) 6248 + 6249 + 6250 +Пример ответа: 6251 + 6252 +((( 6253 +[ 6254 + { 6255 + "vehiclesCount": 0, ~/~/ Количество объектов. 6256 + "geozonesCount": 0, ~/~/ Количество геозон. 6257 + "fieldsCount": 0, ~/~/ Количество полей. 6258 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6259 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6260 + "agentName": "string", ~/~/ Наименование агента. 6261 + "isEnabled": true, ~/~/ Активность локатора 6262 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6263 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6264 + "name": "string", ~/~/ Наименование локатора 6265 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6266 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6267 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6268 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6269 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6270 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6271 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6272 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6273 + "url": "string", ~/~/ ссылка на локатор 6274 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6275 + "showVehicleName": true, ~/~/ Наименование объекта 6276 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6277 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6278 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6279 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6280 + "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ГИС) 6281 + 6282 + 0 6283 + ] 6284 + } 6285 +] 6286 +))) 6287 + 6288 + 5992 5992 == **Изменение локатора** == 5993 5993 5994 5994 (% class="box infomessage" %) ... ... @@ -6007,12 +6007,31 @@ 6007 6007 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6008 6008 "validity": 0, ~/~/ Срок действия в днях (1-90) 6009 6009 "autoProlongation": true, ~/~/ Автопродление срока действия 6010 - "url": "string", ~/~/ Ссылка 6011 - "language": 0 ~/~/ Язык 6307 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6308 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6309 + 0 6310 + ], 6311 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6312 + 0 6313 + ], 6314 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6315 + 0 6316 + ], 6317 + "showVehicleName": true, ~/~/ Наименование объекта 6318 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6319 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6320 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6321 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6322 + "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ГИС) 6323 + 6324 + 0 6325 + 6326 + ] 6012 6012 } 6328 + 6329 + 6013 6013 ))) 6014 6014 6015 - 6016 6016 Пример ответа: 6017 6017 6018 6018 200 ~/~/ Success ... ... @@ -6034,7 +6034,6 @@ 6034 6034 ))) 6035 6035 6036 6036 6037 - 6038 6038 = **Раздел: Яндекс Маршруты** = 6039 6039 6040 6040 ... ... @@ -6048,7 +6048,6 @@ 6048 6048 Пример запроса: 6049 6049 Id ~/~/ Идентификатор поля 6050 6050 6051 - 6052 6052 Пример ответа: 6053 6053 6054 6054 ((( ... ... @@ -6066,7 +6066,6 @@ 6066 6066 ))) 6067 6067 6068 6068 6069 - 6070 6070 == **Добавить маршрут** == 6071 6071 6072 6072 (% class="box infomessage" %) ... ... @@ -6121,7 +6121,6 @@ 6121 6121 } 6122 6122 ))) 6123 6123 6124 - 6125 6125 Пример ответа: 6126 6126 6127 6127 ((( ... ... @@ -6152,7 +6152,6 @@ 6152 6152 ] 6153 6153 ))) 6154 6154 6155 - 6156 6156 Пример ответа: 6157 6157 6158 6158 ((( ... ... @@ -6176,7 +6176,6 @@ 6176 6176 Id ~/~/ Идентификатор поля 6177 6177 6178 6178 6179 - 6180 6180 = **Раздел: Управление доступа к машинам** = 6181 6181 6182 6182 ... ... @@ -6198,7 +6198,6 @@ 6198 6198 ))) 6199 6199 6200 6200 6201 - 6202 6202 == Задает видимость транспортных средств пользователю == 6203 6203 6204 6204 (% class="box infomessage" %) ... ... @@ -6223,10 +6223,6 @@ 6223 6223 ))) 6224 6224 6225 6225 ((( 6226 - 6227 -))) 6228 - 6229 -((( 6230 6230 Пример ответа : 6231 6231 ))) 6232 6232 ... ... @@ -6240,10 +6240,6 @@ 6240 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]] **