Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/11 10:51
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.SupportZhuchkov - Content
-
... ... @@ -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", ~/~/ Окончание периода ... ... @@ -2491,19 +2491,11 @@ 2491 2491 { 2492 2492 "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 2493 2493 2494 -((( 2495 2495 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2496 2496 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2497 2497 "valueFuel": 0, ~/~/ Количество 2498 2498 "fuelStart": 0, ~/~/ Уровень топлива на начало события 2499 2499 "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2500 -))) 2501 - 2502 -((( 2503 - "latitude": 0, ~/~/ Широта. 2504 - "longitude": 0 ~/~/ Долгота. 2505 -))) 2506 - 2507 2507 } 2508 2508 ] 2509 2509 } ... ... @@ -2623,8 +2623,163 @@ 2623 2623 } 2624 2624 2625 2625 2626 -= = 2637 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2627 2627 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 + 2628 2628 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2629 2629 2630 2630 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -5284,9 +5284,33 @@ 5284 5284 ))) 5285 5285 5286 5286 5453 +== **Удаление существующего поля** == 5454 + 5455 +(% class="box errormessage" %) 5287 5287 ((( 5457 +**DELETE /api/v3/agroLands/{id}** 5458 +))) 5459 + 5460 +Пример запроса: 5461 +id ~/~/ Идентификатор поля 5462 + 5463 +Пример ответа: 5464 + 5288 5288 ((( 5466 +200 ~/~/ Успех 5467 +))) 5468 + 5289 5289 ((( 5470 + 5471 +))) 5472 + 5473 +((( 5474 +((( 5475 +((( 5476 + 5477 +))) 5478 + 5479 +((( 5290 5290 == **Изменение поля** == 5291 5291 5292 5292 (% class="box infomessage" %) ... ... @@ -5532,102 +5532,9 @@ 5532 5532 "perimetr": 0, ~/~/ ериметр, м 5533 5533 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5534 5534 } 5535 - 5536 - 5537 -== **Какие поля посещал объект** == 5538 - 5539 -(% class="box successmessage" %) 5540 -((( 5541 -**POST /api/v3/agroLands/visitingByVehicle** 5542 5542 ))) 5543 5543 5544 -Пример запроса: 5545 5545 5546 -{ 5547 - "vehicleId": 0, ~/~/ id объекта 5548 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5549 - "byTime": 0, ~/~/ Объединение событий по времени 5550 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5551 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5552 - "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5553 - "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5554 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5555 -} 5556 - 5557 -Пример ответа: 5558 - 5559 -[ 5560 - { 5561 - "fieldId": 0, ~/~/ id объекта 5562 - "vehicleName": "string", ~/~/ Наименование объекта 5563 - "fieldName": "string", ~/~/ Наименование поля 5564 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5565 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5566 - "vehicleId": 0, ~/~/ Идентификатор ТС 5567 - "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5568 - "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5569 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5570 - "mileage": 0 ~/~/ Пробег 5571 - } 5572 -] 5573 -))) 5574 - 5575 - 5576 -== **Посещение поля объектами ** == 5577 - 5578 -(% class="box successmessage" %) 5579 -((( 5580 -**POST /api/v3/agroLands/visitingByField** 5581 -))) 5582 - 5583 -Пример запроса: 5584 -{ 5585 - "fieldId": 0, ~/~/ ID поля 5586 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5587 - "byTime": 0, ~/~/ Объединение событий по времени 5588 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5589 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5590 - "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5591 - "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5592 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5593 -} 5594 - 5595 -Пример ответа: 5596 - 5597 -[ 5598 - { 5599 - "fieldId": 0, ~/~/ ID поля 5600 - "vehicleName": "string", ~/~/ Наименование объекта 5601 - "fieldName": "string", ~/~/ Имя поля 5602 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5603 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5604 - "vehicleId": 0, ~/~/ Идентификатор ТС 5605 - "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5606 - "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5607 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5608 - "mileage": 0 ~/~/ Пробег 5609 - } 5610 -] 5611 - 5612 - 5613 -== **Удаление существующего поля** == 5614 - 5615 -(% class="box errormessage" %) 5616 -((( 5617 -**DELETE /api/v3/agroLands/{id}** 5618 -))) 5619 - 5620 -Пример запроса: 5621 -id ~/~/ Идентификатор поля 5622 - 5623 -Пример ответа: 5624 - 5625 -((( 5626 -200 ~/~/ Успех 5627 - 5628 - 5629 -))) 5630 - 5631 5631 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5632 5632 ))) 5633 5633 ))) ... ... @@ -6288,6 +6288,7 @@ 6288 6288 ))) 6289 6289 6290 6290 6388 + 6291 6291 == **Изменение локатора** == 6292 6292 6293 6293 (% class="box infomessage" %) ... ... @@ -6352,6 +6352,7 @@ 6352 6352 ))) 6353 6353 6354 6354 6453 + 6355 6355 = **Раздел: Яндекс Маршруты** = 6356 6356 6357 6357 ... ... @@ -6365,6 +6365,7 @@ 6365 6365 Пример запроса: 6366 6366 Id ~/~/ Идентификатор поля 6367 6367 6467 + 6368 6368 Пример ответа: 6369 6369 6370 6370 ((( ... ... @@ -6382,6 +6382,7 @@ 6382 6382 ))) 6383 6383 6384 6384 6485 + 6385 6385 == **Добавить маршрут** == 6386 6386 6387 6387 (% class="box infomessage" %) ... ... @@ -6436,6 +6436,7 @@ 6436 6436 } 6437 6437 ))) 6438 6438 6540 + 6439 6439 Пример ответа: 6440 6440 6441 6441 ((( ... ... @@ -6466,6 +6466,7 @@ 6466 6466 ] 6467 6467 ))) 6468 6468 6571 + 6469 6469 Пример ответа: 6470 6470 6471 6471 ((( ... ... @@ -6489,6 +6489,7 @@ 6489 6489 Id ~/~/ Идентификатор поля 6490 6490 6491 6491 6595 + 6492 6492 = **Раздел: Управление доступа к машинам** = 6493 6493 6494 6494 ... ... @@ -6510,6 +6510,7 @@ 6510 6510 ))) 6511 6511 6512 6512 6617 + 6513 6513 == Задает видимость транспортных средств пользователю == 6514 6514 6515 6515 (% class="box infomessage" %) ... ... @@ -6534,6 +6534,10 @@ 6534 6534 ))) 6535 6535 6536 6536 ((( 6642 + 6643 +))) 6644 + 6645 +((( 6537 6537 Пример ответа : 6538 6538 ))) 6539 6539 ... ... @@ -6547,6 +6547,11 @@ 6547 6547 ))) 6548 6548 6549 6549 6659 +== == 6660 + 6661 + 6662 + 6663 + 6550 6550 (% class="box" lang="en-US" style="text-align: center;" %) 6551 6551 ((( 6552 6552 (% 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]] **