Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/07/29 15:51
<
>
edited by Андрей Калиновский
on 2025/07/29 15:51
on 2025/07/29 15:51
edited by Андрей Калиновский
on 2025/07/03 16:18
on 2025/07/03 16:18
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- 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,8 @@ 744 744 (% style="text-align:left" %) 745 745 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 746 746 747 -(% class="wikigeneratedid" id="H" %) 748 -((( 749 - 750 -))) 769 +(% class="wikigeneratedid" %) 770 += = 751 751 752 752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 753 ... ... @@ -2372,7 +2372,7 @@ 2372 2372 Тело запроса: 2373 2373 2374 2374 { 2375 - "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.2395 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2376 2376 "vehicleIds": [0], ~/~/ Список ID объектов 2377 2377 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2378 2378 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2419,7 +2419,7 @@ 2419 2419 Тело запроса: 2420 2420 2421 2421 { 2422 - "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.2442 + "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", ~/~/ Окончание периода ... ... @@ -5431,9 +5431,33 @@ 5431 5431 ))) 5432 5432 5433 5433 5454 +== **Удаление существующего поля** == 5455 + 5456 +(% class="box errormessage" %) 5434 5434 ((( 5458 +**DELETE /api/v3/agroLands/{id}** 5459 +))) 5460 + 5461 +Пример запроса: 5462 +id ~/~/ Идентификатор поля 5463 + 5464 +Пример ответа: 5465 + 5435 5435 ((( 5467 +200 ~/~/ Успех 5468 +))) 5469 + 5436 5436 ((( 5471 + 5472 +))) 5473 + 5474 +((( 5475 +((( 5476 +((( 5477 + 5478 +))) 5479 + 5480 +((( 5437 5437 == **Изменение поля** == 5438 5438 5439 5439 (% class="box infomessage" %) ... ... @@ -5679,102 +5679,9 @@ 5679 5679 "perimetr": 0, ~/~/ ериметр, м 5680 5680 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5681 5681 } 5682 - 5683 - 5684 -== **Какие поля посещал объект** == 5685 - 5686 -(% class="box successmessage" %) 5687 -((( 5688 -**POST /api/v3/agroLands/visitingByVehicle** 5689 5689 ))) 5690 5690 5691 -Пример запроса: 5692 5692 5693 -{ 5694 - "vehicleId": 0, ~/~/ id объекта 5695 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5696 - "byTime": 0, ~/~/ Объединение событий по времени 5697 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5698 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5699 - "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5700 - "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5701 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5702 -} 5703 - 5704 -Пример ответа: 5705 - 5706 -[ 5707 - { 5708 - "fieldId": 0, ~/~/ id объекта 5709 - "vehicleName": "string", ~/~/ Наименование объекта 5710 - "fieldName": "string", ~/~/ Наименование поля 5711 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5712 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5713 - "vehicleId": 0, ~/~/ Идентификатор ТС 5714 - "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5715 - "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5716 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5717 - "mileage": 0 ~/~/ Пробег 5718 - } 5719 -] 5720 -))) 5721 - 5722 - 5723 -== **Посещение поля объектами ** == 5724 - 5725 -(% class="box successmessage" %) 5726 -((( 5727 -**POST /api/v3/agroLands/visitingByField** 5728 -))) 5729 - 5730 -Пример запроса: 5731 -{ 5732 - "fieldId": 0, ~/~/ ID поля 5733 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5734 - "byTime": 0, ~/~/ Объединение событий по времени 5735 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5736 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5737 - "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5738 - "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5739 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5740 -} 5741 - 5742 -Пример ответа: 5743 - 5744 -[ 5745 - { 5746 - "fieldId": 0, ~/~/ ID поля 5747 - "vehicleName": "string", ~/~/ Наименование объекта 5748 - "fieldName": "string", ~/~/ Имя поля 5749 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5750 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5751 - "vehicleId": 0, ~/~/ Идентификатор ТС 5752 - "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5753 - "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5754 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5755 - "mileage": 0 ~/~/ Пробег 5756 - } 5757 -] 5758 - 5759 - 5760 -== **Удаление существующего поля** == 5761 - 5762 -(% class="box errormessage" %) 5763 -((( 5764 -**DELETE /api/v3/agroLands/{id}** 5765 -))) 5766 - 5767 -Пример запроса: 5768 -id ~/~/ Идентификатор поля 5769 - 5770 -Пример ответа: 5771 - 5772 -((( 5773 -200 ~/~/ Успех 5774 - 5775 - 5776 -))) 5777 - 5778 5778 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5779 5779 ))) 5780 5780 ))) ... ... @@ -6258,14 +6258,14 @@ 6258 6258 = **Раздел: Локатор ** = 6259 6259 6260 6260 6261 -== **Получение данных покатору** ==6212 +== **Получение списка локаторов, доступных пользователю ** == 6262 6262 6263 6263 (% class="box infomessage" %) 6264 6264 ((( 6265 -**GET /api/v3/locators /{locatorId}**6216 +**GET /api/v3/locators ** 6266 6266 ))) 6267 6267 6268 -В за просе указываетсяlocatorid- идентификаторлокатора6219 +В заголовках запроса: X-Auth: Токен авторизации 6269 6269 6270 6270 6271 6271 Пример ответа: ... ... @@ -6299,16 +6299,13 @@ 6299 6299 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6300 6300 "url": "string", ~/~/ Ссылка 6301 6301 "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6302 - 6303 - "showVehicleName": true, ~/~/ Наименование объекта 6304 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6305 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6306 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6307 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6308 - "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ГИС) 6309 - 6310 - 1 6311 - 6253 + "showVehicleName": true, ~/~/ Наименование объекта 6254 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6255 + "allowTrackReport": true, ~/~/ Трек 6256 + "showTrackTracing": true, ~/~/ Трассировка трека 6257 + "showSensors": true, ~/~/ Датчик 6258 + "availableMapLayers": [ ~/~/ Слои на карте 6259 + 0 6312 6312 ] 6313 6313 } 6314 6314 ))) ... ... @@ -6350,16 +6350,12 @@ 6350 6350 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6351 6351 0 6352 6352 ], 6353 - 6354 - "showVehicleName": true, ~/~/ Наименование объекта 6355 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6356 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6357 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6358 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6359 - "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ГИС) 6360 - 6361 - 1 6362 - 6301 + "showVehicleName": true, ~/~/ Наименование объекта 6302 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6303 + "allowTrackReport": true, ~/~/ Трек 6304 + "showTrackTracing": true, ~/~/ Трассировка трека 6305 + "showSensors": true, ~/~/ Датчик 6306 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6363 6363 ] 6364 6364 } 6365 6365 ))) ... ... @@ -6392,7 +6392,32 @@ 6392 6392 ))) 6393 6393 6394 6394 ((( 6395 - 6339 +{ 6340 + "isEnabled": true, ~/~/ Активность 6341 + "name": "string", ~/~/ Наименование локатора 6342 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6343 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6344 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6345 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6346 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6347 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6348 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6349 + 0 6350 + ], 6351 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6352 + 0 6353 + ], 6354 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6355 + 0 6356 + ], 6357 + "showVehicleName": true, ~/~/ Наименование объекта 6358 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6359 + "allowTrackReport": true, ~/~/ Трек 6360 + "showTrackTracing": true, ~/~/ Трассировка трека 6361 + "showSensors": true, ~/~/ Датчик 6362 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6363 + ] 6364 +} 6396 6396 ))) 6397 6397 6398 6398 ... ... @@ -6422,10 +6422,10 @@ 6422 6422 "url": "string", ~/~/ ссылка на локатор 6423 6423 "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6424 6424 "showVehicleName": true, ~/~/ Наименование объекта 6425 - "showVehicleDirection": true, ~/~/ Показывать направление движенияобъектанакарте6426 - "allowTrackReport": true, ~/~/ отображениеколонки и кнопок **Построить историю за сутки**6427 - "showTrackTracing": true, ~/~/ Отображение трассировкитрекана карте по ссылке.6428 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах6394 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6395 + "allowTrackReport": true, ~/~/ Трек 6396 + "showTrackTracing": true, ~/~/ Трассировка трека 6397 + "showSensors": true, ~/~/ Датчик 6429 6429 "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ГИС) 6430 6430 6431 6431 0 ... ... @@ -6435,6 +6435,7 @@ 6435 6435 ))) 6436 6436 6437 6437 6407 + 6438 6438 == **Изменение локатора** == 6439 6439 6440 6440 (% class="box infomessage" %) ... ... @@ -6464,14 +6464,11 @@ 6464 6464 0 6465 6465 ], 6466 6466 "showVehicleName": true, ~/~/ Наименование объекта 6467 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6468 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6469 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6470 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6471 - "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ГИС) 6472 - 6473 - 0 6474 - 6437 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6438 + "allowTrackReport": true, ~/~/ Трек 6439 + "showTrackTracing": true, ~/~/ Трассировка трека 6440 + "showSensors": true, ~/~/ Датчик 6441 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6475 6475 ] 6476 6476 } 6477 6477 ... ... @@ -6499,6 +6499,7 @@ 6499 6499 ))) 6500 6500 6501 6501 6469 + 6502 6502 = **Раздел: Яндекс Маршруты** = 6503 6503 6504 6504 ... ... @@ -6512,6 +6512,7 @@ 6512 6512 Пример запроса: 6513 6513 Id ~/~/ Идентификатор поля 6514 6514 6483 + 6515 6515 Пример ответа: 6516 6516 6517 6517 ((( ... ... @@ -6529,6 +6529,7 @@ 6529 6529 ))) 6530 6530 6531 6531 6501 + 6532 6532 == **Добавить маршрут** == 6533 6533 6534 6534 (% class="box infomessage" %) ... ... @@ -6583,6 +6583,7 @@ 6583 6583 } 6584 6584 ))) 6585 6585 6556 + 6586 6586 Пример ответа: 6587 6587 6588 6588 ((( ... ... @@ -6613,6 +6613,7 @@ 6613 6613 ] 6614 6614 ))) 6615 6615 6587 + 6616 6616 Пример ответа: 6617 6617 6618 6618 ((( ... ... @@ -6636,6 +6636,7 @@ 6636 6636 Id ~/~/ Идентификатор поля 6637 6637 6638 6638 6611 + 6639 6639 = **Раздел: Управление доступа к машинам** = 6640 6640 6641 6641 ... ... @@ -6657,6 +6657,7 @@ 6657 6657 ))) 6658 6658 6659 6659 6633 + 6660 6660 == Задает видимость транспортных средств пользователю == 6661 6661 6662 6662 (% class="box infomessage" %) ... ... @@ -6681,6 +6681,10 @@ 6681 6681 ))) 6682 6682 6683 6683 ((( 6658 + 6659 +))) 6660 + 6661 +((( 6684 6684 Пример ответа : 6685 6685 ))) 6686 6686 ... ... @@ -6694,6 +6694,44 @@ 6694 6694 ))) 6695 6695 6696 6696 6675 +== **Получение перечня моделей ** == 6676 + 6677 +(% class="box successmessage" %) 6678 +((( 6679 +**POST /api/v3/models/find** 6680 +))) 6681 + 6682 +Пример запроса: 6683 + 6684 +((( 6685 +((( 6686 +{ 6687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6688 + "name": "string", ~/~/ Наименование локатора 6689 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6690 +))) 6691 + 6692 + 6693 + 6694 + Пример ответа: 6695 + 6696 + 6697 +((( 6698 +[ 6699 + { 6700 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6701 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6702 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6703 + "name": "string", ~/~/ Наименование локатора 6704 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6705 + } 6706 +] 6707 +))) 6708 +))) 6709 + 6710 + 6711 + 6712 + 6697 6697 (% class="box" lang="en-US" style="text-align: center;" %) 6698 6698 ((( 6699 6699 (% 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]] **