Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/09/09 14:38
<
>
отредактировано Андрей Калиновский
на 2025/09/03 15:30
на 2025/09/03 15:30
отредактировано Михаил Жучков
на 2025/07/10 13:02
на 2025/07/10 13:02
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.SupportZhuchkov - Содержимое
-
... ... @@ -287,6 +287,28 @@ 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 + 290 290 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 291 291 292 292 (% class="box warningmessage" %) ... ... @@ -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 -))) 769 += = 751 751 752 752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 753 ... ... @@ -2419,7 +2419,7 @@ 2419 2419 Тело запроса: 2420 2420 2421 2421 { 2422 - "sampling": 86400, ~/~/ Частота дискретизации,секунд, минимум-60(если передано,то весь период бъётсяна подпериоды с указанной частотой)2441 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2423 2423 "vehicleIds": [0], ~/~/ Список ID объектов 2424 2424 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2425 2425 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2615,8 +2615,163 @@ 2615 2615 } 2616 2616 2617 2617 2618 -= = 2637 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2619 2619 2639 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2640 + 2641 +(% class="box infomessage" %) 2642 +((( 2643 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2644 +))) 2645 + 2646 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2647 + 2648 +(% style="color:#000000" %)Метод запроса: **POST** 2649 + 2650 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2651 + 2652 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2653 + 2654 +(% style="text-align:left" %) 2655 +Тело запроса: 2656 + 2657 +(% style="text-align:left" %) 2658 +{ 2659 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2660 +} 2661 + 2662 +(% style="text-align:left" %) 2663 +Ответ: 2664 + 2665 +[ 2666 + { 2667 + "id": 0, ~/~/ Идентификатор объекта геозоны 2668 + "name": "string", ~/~/ Название объекта геозоны 2669 + "type": 0, ~/~/ Тип объекта геозоны 2670 + "fname": "string", ~/~/ Имя файла 2671 + "parentId": "string", ~/~/ Идентификатор клиента 2672 + "radius": 0, ~/~/ Радиус геообъекта 2673 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2674 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2675 + "description": "string", ~/~/ Описание 2676 + "area": 0, ~/~/ Площадь, м^^2^^ 2677 + "perimetr": 0, ~/~/ Периметр, м 2678 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2679 + } 2680 +] 2681 + 2682 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2683 + 2684 +(% class="box infomessage" %) 2685 +((( 2686 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2687 +))) 2688 + 2689 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2690 + 2691 +(% style="color:#000000" %)Метод запроса: **POST** 2692 + 2693 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2694 + 2695 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2696 + 2697 +(% style="text-align:left" %) 2698 +Тело запроса: 2699 + 2700 +{ 2701 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2702 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2703 + "ids": [ ], ~/~/ Массив id объектов 2704 + "byTime": 0, ~/~/ Объединение событий по времени 2705 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2706 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2707 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2708 +} 2709 + 2710 +Ответ: 2711 +[ 2712 + { 2713 + "geozoneId": 0, ~/~/ ID геообъекта 2714 + "geozoneName": "string", ~/~/ Название геообъекта 2715 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2716 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2717 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2718 + "vehicleId": 0, ~/~/ ID объекта 2719 + "vehicleName": "string" ~/~/ Имя объекта 2720 + } 2721 +] 2722 + 2723 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2724 + 2725 +(% class="box infomessage" %) 2726 +((( 2727 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2728 +))) 2729 + 2730 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2731 + 2732 +(% style="color:#000000" %)Метод запроса: **POST** 2733 + 2734 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2735 + 2736 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2737 + 2738 +(% style="text-align:left" %) 2739 +Тело запроса: 2740 + 2741 +{ 2742 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2743 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2744 + "ids": [ ], ~/~/ Массив id геообъектов 2745 + "byTime": 0, ~/~/ Объединение событий по времени 2746 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2747 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2748 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2749 +} 2750 + 2751 +Ответ: 2752 + 2753 +[ 2754 + { 2755 + "geozoneId": 0, ~/~/ ID геообъекта 2756 + "geozoneName": "string", ~/~/ Название геообъекта 2757 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2758 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2759 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2760 + "vehicleId": 0, ~/~/ ID объекта 2761 + "vehicleName": "string" ~/~/ Имя объекта 2762 + } 2763 +] 2764 + 2765 + 2766 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2767 + 2768 +(% class="box successmessage" %) 2769 +((( 2770 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2771 +))) 2772 + 2773 +(% style="color:#000000" %)Метод запроса: **PUT** 2774 + 2775 +Пример запроса: 2776 + 2777 +((( 2778 +{ 2779 + "id": 0, ~/~/ Идентификатор объекта геозоны 2780 + "name": "string", ~/~/ Наименование объекта геозоны 2781 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2782 + "description": "string", ~/~/ Описание объекта геозоны 2783 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2784 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2785 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2786 +} 2787 +))) 2788 + 2789 + 2790 +Пример ответа: 2791 + 2792 +200 ~/~/ Success 2793 + 2620 2620 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2621 2621 2622 2622 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -5276,9 +5276,33 @@ 5276 5276 ))) 5277 5277 5278 5278 5453 +== **Удаление существующего поля** == 5454 + 5455 +(% class="box errormessage" %) 5279 5279 ((( 5457 +**DELETE /api/v3/agroLands/{id}** 5458 +))) 5459 + 5460 +Пример запроса: 5461 +id ~/~/ Идентификатор поля 5462 + 5463 +Пример ответа: 5464 + 5280 5280 ((( 5466 +200 ~/~/ Успех 5467 +))) 5468 + 5281 5281 ((( 5470 + 5471 +))) 5472 + 5473 +((( 5474 +((( 5475 +((( 5476 + 5477 +))) 5478 + 5479 +((( 5282 5282 == **Изменение поля** == 5283 5283 5284 5284 (% class="box infomessage" %) ... ... @@ -5524,102 +5524,9 @@ 5524 5524 "perimetr": 0, ~/~/ ериметр, м 5525 5525 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5526 5526 } 5527 - 5528 - 5529 -== **Какие поля посещал объект** == 5530 - 5531 -(% class="box successmessage" %) 5532 -((( 5533 -**POST /api/v3/agroLands/visitingByVehicle** 5534 5534 ))) 5535 5535 5536 -Пример запроса: 5537 5537 5538 -{ 5539 - "vehicleId": 0, ~/~/ id объекта 5540 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5541 - "byTime": 0, ~/~/ Объединение событий по времени 5542 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5543 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5544 - "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5545 - "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5546 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5547 -} 5548 - 5549 -Пример ответа: 5550 - 5551 -[ 5552 - { 5553 - "fieldId": 0, ~/~/ id объекта 5554 - "vehicleName": "string", ~/~/ Наименование объекта 5555 - "fieldName": "string", ~/~/ Наименование поля 5556 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5557 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5558 - "vehicleId": 0, ~/~/ Идентификатор ТС 5559 - "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5560 - "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5561 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5562 - "mileage": 0 ~/~/ Пробег 5563 - } 5564 -] 5565 -))) 5566 - 5567 - 5568 -== **Посещение поля объектами ** == 5569 - 5570 -(% class="box successmessage" %) 5571 -((( 5572 -**POST /api/v3/agroLands/visitingByField** 5573 -))) 5574 - 5575 -Пример запроса: 5576 -{ 5577 - "fieldId": 0, ~/~/ ID поля 5578 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5579 - "byTime": 0, ~/~/ Объединение событий по времени 5580 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5581 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5582 - "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5583 - "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5584 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5585 -} 5586 - 5587 -Пример ответа: 5588 - 5589 -[ 5590 - { 5591 - "fieldId": 0, ~/~/ ID поля 5592 - "vehicleName": "string", ~/~/ Наименование объекта 5593 - "fieldName": "string", ~/~/ Имя поля 5594 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5595 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5596 - "vehicleId": 0, ~/~/ Идентификатор ТС 5597 - "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5598 - "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5599 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5600 - "mileage": 0 ~/~/ Пробег 5601 - } 5602 -] 5603 - 5604 - 5605 -== **Удаление существующего поля** == 5606 - 5607 -(% class="box errormessage" %) 5608 -((( 5609 -**DELETE /api/v3/agroLands/{id}** 5610 -))) 5611 - 5612 -Пример запроса: 5613 -id ~/~/ Идентификатор поля 5614 - 5615 -Пример ответа: 5616 - 5617 -((( 5618 -200 ~/~/ Успех 5619 - 5620 - 5621 -))) 5622 - 5623 5623 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5624 5624 ))) 5625 5625 ))) ... ... @@ -6280,6 +6280,7 @@ 6280 6280 ))) 6281 6281 6282 6282 6388 + 6283 6283 == **Изменение локатора** == 6284 6284 6285 6285 (% class="box infomessage" %) ... ... @@ -6344,6 +6344,7 @@ 6344 6344 ))) 6345 6345 6346 6346 6453 + 6347 6347 = **Раздел: Яндекс Маршруты** = 6348 6348 6349 6349 ... ... @@ -6357,6 +6357,7 @@ 6357 6357 Пример запроса: 6358 6358 Id ~/~/ Идентификатор поля 6359 6359 6467 + 6360 6360 Пример ответа: 6361 6361 6362 6362 ((( ... ... @@ -6374,6 +6374,7 @@ 6374 6374 ))) 6375 6375 6376 6376 6485 + 6377 6377 == **Добавить маршрут** == 6378 6378 6379 6379 (% class="box infomessage" %) ... ... @@ -6428,6 +6428,7 @@ 6428 6428 } 6429 6429 ))) 6430 6430 6540 + 6431 6431 Пример ответа: 6432 6432 6433 6433 ((( ... ... @@ -6458,6 +6458,7 @@ 6458 6458 ] 6459 6459 ))) 6460 6460 6571 + 6461 6461 Пример ответа: 6462 6462 6463 6463 ((( ... ... @@ -6481,6 +6481,7 @@ 6481 6481 Id ~/~/ Идентификатор поля 6482 6482 6483 6483 6595 + 6484 6484 = **Раздел: Управление доступа к машинам** = 6485 6485 6486 6486 ... ... @@ -6502,6 +6502,7 @@ 6502 6502 ))) 6503 6503 6504 6504 6617 + 6505 6505 == Задает видимость транспортных средств пользователю == 6506 6506 6507 6507 (% class="box infomessage" %) ... ... @@ -6526,6 +6526,10 @@ 6526 6526 ))) 6527 6527 6528 6528 ((( 6642 + 6643 +))) 6644 + 6645 +((( 6529 6529 Пример ответа : 6530 6530 ))) 6531 6531 ... ... @@ -6539,6 +6539,11 @@ 6539 6539 ))) 6540 6540 6541 6541 6659 +== == 6660 + 6661 + 6662 + 6663 + 6542 6542 (% class="box" lang="en-US" style="text-align: center;" %) 6543 6543 ((( 6544 6544 (% 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]] **