Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Михаил Жучков 2025/10/30 11:26
<
>
отредактировано Андрей Калиновский
на 2025/10/23 09:54
на 2025/10/23 09:54
отредактировано Андрей Калиновский
на 2025/07/29 15:41
на 2025/07/29 15:41
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -202,7 +202,7 @@ 202 202 (% style="color:#000000" %)Параметр запроса: 203 203 204 204 (% style="color:#000000" %){ 205 - "parentId": " (%%)string(% style="color:#000000" %)" ~/~/ для получение собственного parentId отправьте пустой запрос (пример "parentId": "" )205 + "parentId": "string" 206 206 } 207 207 208 208 (% style="color:#000000" %)Ответ: ... ... @@ -744,10 +744,7 @@ 744 744 (% style="text-align:left" %) 745 745 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 746 746 747 -(% class="wikigeneratedid" id="H" %) 748 -((( 749 - 750 -))) 747 += = 751 751 752 752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 753 ... ... @@ -1057,12 +1057,6 @@ 1057 1057 "forTooltip": true, ~/~/ Отображать в подсказке 1058 1058 "forReport": true ~/~/ Отображать в отчете 1059 1059 } 1060 - ], 1061 - "vehicleGroups": [ ~/~/ Группы ТС 1062 - { 1063 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1064 - "name": "string" ~/~/ Наименование группы ТС 1065 - } 1066 1066 1067 1067 ], ~/~/ Данные с вкладки нормы 1068 1068 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) ... ... @@ -1113,7 +1113,7 @@ 1113 1113 "type": 0, ~/~/ Тип датчика 1114 1114 "name": "string", ~/~/ Имя датчика 1115 1115 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1116 - "p arameterName":"string", ~/~/Имяпараметра(взамен связки Input type + port number)1107 + "inputNumber": 0, ~/~/ Номер входа 1117 1117 "pseudonym": "string", ~/~/ Псевдоним 1118 1118 "medianDegree": 0, ~/~/ Медианная фильтрация 1119 1119 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. ... ... @@ -1146,31 +1146,27 @@ 1146 1146 "additionalProp3": "string" 1147 1147 }, 1148 1148 1149 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1150 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1151 - { 1152 - "from": 0, ~/~/ С какого значения 1153 - "color": "string", ~/~/ Каким цветом 1154 - "text": "string" ~/~/ Текст подписи к этому интервалу 1155 - } 1156 - ], 1157 - "disableEmissionsValidation": true, ~/~/ Нужно ли валидировать выбросы значений. Применяется для датчиков с типом "Накопительный" 1158 - "unitOfMeasure": 0 ~/~/ Единица измерения значений датчика. (0 - по умолчанию, 1 - секунды, 2 - часы) 1159 - } 1160 - ], 1140 +~/~/ Характерные для произвольного: 1141 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1142 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1143 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1144 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1145 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1146 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1147 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1148 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1149 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1150 +~/~/ "ValueOn": "Вкл.", 1151 +~/~/ "ValueOff": "Выкл." 1152 + "summaryMaxValue": 0 ~/~/ Макс. значение 1153 + } 1161 1161 "drivers": [ ~/~/ Водители 1162 1162 { 1163 1163 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1164 1164 "name": "string", ~/~/ Наименование 1165 - "description": "string", ~/~/ Описание 1166 - "assignments": [ ~/~/ Информация по назначениям 1167 - { 1168 - "beginTime": "2025-10-21T12:28:41.021Z", ~/~/Момент времени начала назначения. 1169 - "endTime": "2025-10-21T12:28:41.021Z", ~/~/ Момент времени окончания назначения. 1170 - "createTime": "2025-10-21T12:28:41.021Z" ~/~/ Момент времени создания назначения. 1158 + "description": "string", 1159 + "isDefault": true ~/~/ По умолчанию 1171 1171 } 1172 - ] 1173 - } 1174 1174 ], 1175 1175 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1176 1176 { ... ... @@ -2429,6 +2429,7 @@ 2429 2429 Тело запроса: 2430 2430 2431 2431 { 2419 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2432 2432 "vehicleIds": [0], ~/~/ Список ID объектов 2433 2433 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2434 2434 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2461,6 +2461,7 @@ 2461 2461 (% class="box warningmessage" %) 2462 2462 ((( 2463 2463 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2452 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2464 2464 ))) 2465 2465 2466 2466 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == ... ... @@ -2499,19 +2499,11 @@ 2499 2499 { 2500 2500 "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 2501 2501 2502 -((( 2503 2503 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2504 2504 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2505 2505 "valueFuel": 0, ~/~/ Количество 2506 2506 "fuelStart": 0, ~/~/ Уровень топлива на начало события 2507 2507 "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2508 -))) 2509 - 2510 -((( 2511 - "latitude": 0, ~/~/ Широта. 2512 - "longitude": 0 ~/~/ Долгота. 2513 -))) 2514 - 2515 2515 } 2516 2516 ] 2517 2517 } ... ... @@ -2631,8 +2631,163 @@ 2631 2631 } 2632 2632 2633 2633 2634 -= = 2615 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2635 2635 2617 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2618 + 2619 +(% class="box infomessage" %) 2620 +((( 2621 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2622 +))) 2623 + 2624 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2625 + 2626 +(% style="color:#000000" %)Метод запроса: **POST** 2627 + 2628 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2629 + 2630 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2631 + 2632 +(% style="text-align:left" %) 2633 +Тело запроса: 2634 + 2635 +(% style="text-align:left" %) 2636 +{ 2637 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2638 +} 2639 + 2640 +(% style="text-align:left" %) 2641 +Ответ: 2642 + 2643 +[ 2644 + { 2645 + "id": 0, ~/~/ Идентификатор объекта геозоны 2646 + "name": "string", ~/~/ Название объекта геозоны 2647 + "type": 0, ~/~/ Тип объекта геозоны 2648 + "fname": "string", ~/~/ Имя файла 2649 + "parentId": "string", ~/~/ Идентификатор клиента 2650 + "radius": 0, ~/~/ Радиус геообъекта 2651 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2652 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2653 + "description": "string", ~/~/ Описание 2654 + "area": 0, ~/~/ Площадь, м^^2^^ 2655 + "perimetr": 0, ~/~/ Периметр, м 2656 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2657 + } 2658 +] 2659 + 2660 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2661 + 2662 +(% class="box infomessage" %) 2663 +((( 2664 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2665 +))) 2666 + 2667 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2668 + 2669 +(% style="color:#000000" %)Метод запроса: **POST** 2670 + 2671 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2672 + 2673 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2674 + 2675 +(% style="text-align:left" %) 2676 +Тело запроса: 2677 + 2678 +{ 2679 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2680 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2681 + "ids": [ ], ~/~/ Массив id объектов 2682 + "byTime": 0, ~/~/ Объединение событий по времени 2683 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2684 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2685 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2686 +} 2687 + 2688 +Ответ: 2689 +[ 2690 + { 2691 + "geozoneId": 0, ~/~/ ID геообъекта 2692 + "geozoneName": "string", ~/~/ Название геообъекта 2693 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2694 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2695 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2696 + "vehicleId": 0, ~/~/ ID объекта 2697 + "vehicleName": "string" ~/~/ Имя объекта 2698 + } 2699 +] 2700 + 2701 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2702 + 2703 +(% class="box infomessage" %) 2704 +((( 2705 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2706 +))) 2707 + 2708 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2709 + 2710 +(% style="color:#000000" %)Метод запроса: **POST** 2711 + 2712 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2713 + 2714 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2715 + 2716 +(% style="text-align:left" %) 2717 +Тело запроса: 2718 + 2719 +{ 2720 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2721 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2722 + "ids": [ ], ~/~/ Массив id геообъектов 2723 + "byTime": 0, ~/~/ Объединение событий по времени 2724 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2725 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2726 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2727 +} 2728 + 2729 +Ответ: 2730 + 2731 +[ 2732 + { 2733 + "geozoneId": 0, ~/~/ ID геообъекта 2734 + "geozoneName": "string", ~/~/ Название геообъекта 2735 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2736 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2737 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2738 + "vehicleId": 0, ~/~/ ID объекта 2739 + "vehicleName": "string" ~/~/ Имя объекта 2740 + } 2741 +] 2742 + 2743 + 2744 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2745 + 2746 +(% class="box successmessage" %) 2747 +((( 2748 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2749 +))) 2750 + 2751 +(% style="color:#000000" %)Метод запроса: **PUT** 2752 + 2753 +Пример запроса: 2754 + 2755 +((( 2756 +{ 2757 + "id": 0, ~/~/ Идентификатор объекта геозоны 2758 + "name": "string", ~/~/ Наименование объекта геозоны 2759 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2760 + "description": "string", ~/~/ Описание объекта геозоны 2761 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2762 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2763 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2764 +} 2765 +))) 2766 + 2767 + 2768 +Пример ответа: 2769 + 2770 +200 ~/~/ Success 2771 + 2636 2636 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2637 2637 2638 2638 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -5292,9 +5292,14 @@ 5292 5292 ))) 5293 5293 5294 5294 5431 + 5295 5295 ((( 5433 + 5434 +))) 5435 + 5296 5296 ((( 5297 5297 ((( 5438 +((( 5298 5298 == **Изменение поля** == 5299 5299 5300 5300 (% class="box infomessage" %) ... ... @@ -5559,7 +5559,7 @@ 5559 5559 "byDist": 0, ~/~/ Объединение событий по расстоянию 5560 5560 "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5561 5561 "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5562 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5703 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5563 5563 } 5564 5564 5565 5565 Пример ответа: ... ... @@ -5597,7 +5597,7 @@ 5597 5597 "byDist": 0, ~/~/ Объединение событий по расстоянию 5598 5598 "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5599 5599 "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5600 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5741 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5601 5601 } 5602 5602 5603 5603 Пример ответа: