Last modified by Андрей Калиновский on 2025/06/27 16:12
<
From version < 212.6 >
edited by Андрей Калиновский
on 2025/03/17 16:44
To version < 237.1 >
edited by Андрей Калиновский
on 2025/05/26 15:33
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -11,6 +11,11 @@
11 11  
12 12  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 13  
14 +(% class="box infomessage" %)
15 +(((
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 +)))
14 14  
15 15  **Содержание страницы:**
16 16  )))
... ... @@ -118,29 +118,41 @@
118 118  Запрос должен содержать данные параметра "**agentId**"
119 119  
120 120  (% style="color:#000000" %)Ответ:
126 +
127 +(((
121 121  {
122 - "agentId": "",  (%%)
123 - "parentId": "",
124 - "parentName": "string",
125 - "name": "string",
126 - "fullName": "string",
127 - "agentInfoType": 0,
128 - "isForeign": true/false,
129 - "district": "string", 
130 - "region": "string",
131 - "city": "string",
132 - "inn": "string",
133 - "kpp": "string",
134 - "address": "string",
135 - "addressFact": "string",
136 - "email": "string",
137 - "director": "string",
138 - "bankName": "string",
139 - "bankBIK": "string",
140 - "bankRS": "string",
141 - "bankKS": "string"
142 - }
129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 + "parentName": "string", ~/~/ Наименование агента
132 + "name": "string", ~/~/ Имя клиента
133 + "fullName": "string", ~/~/ ФИО клиента
134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 + "district": "string", ~/~/ Район
137 + "region": "string", ~/~/ Область
138 + "city": "string", ~/~/ Город
139 + "email": "string", ~/~/ Email
140 + "director": "string", ~/~/ Руководитель
141 + "RegionalData": [ ~/~/ Определяет региональные сведения.
142 + {
143 + "Country": 0, ~/~/ Страна
144 + "groups": [ ~/~/ Список групп
145 + {
146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 + "fields": [ ~/~/ Список значений полей
148 + {
149 + "name": "string", ~/~/ Имя поля формы
150 + "value": "string" ~/~/ Значение поля формы
151 + }
152 + ]
153 + }
154 + ]
155 + }
156 + ]
157 +}
158 +)))
143 143  
160 +
144 144  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 145  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 146  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -860,7 +860,7 @@
860 860  {
861 861   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 862   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 - "deleted": true,
880 + "deleted": false,
864 864   "extId": "string",
865 865   "name": "string",
866 866   "picture": "string",
... ... @@ -879,7 +879,7 @@
879 879  {
880 880   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 881   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 - "deleted": true,
899 + "deleted": false,
883 883   "extId": "string",
884 884   "name": "string",
885 885   "picture": "string",
... ... @@ -913,7 +913,7 @@
913 913  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 914  )))
915 915  
916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
917 917  
918 918  (% style="color:#000000" %)Метод запроса: **PUT**
919 919  
... ... @@ -980,7 +980,7 @@
980 980  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 981  )))
982 982  
983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
984 984  
985 985  (% style="color:#000000" %)Метод запроса: **DELETE**
986 986  
... ... @@ -1611,77 +1611,6 @@
1611 1611  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612 1612  
1613 1613  
1614 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1615 -
1616 -(% class="box successmessage" %)
1617 -(((
1618 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 -)))
1620 -
1621 -Метод запроса: **POST**
1622 -
1623 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 -
1625 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626 -
1627 -
1628 -Ответ:
1629 -
1630 -{
1631 -
1632 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 -
1634 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635 -
1636 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637 -
1638 - "Message": "string", ~/~/ Информация о выполнении запроса
1639 -
1640 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641 -
1642 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643 -
1644 - "Data": "string" ~/~/ Данные
1645 -
1646 -}
1647 -
1648 -
1649 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650 -
1651 -(% class="box infomessage" %)
1652 -(((
1653 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 -)))
1655 -
1656 -Метод запроса: **GET**
1657 -
1658 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 -
1660 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661 -
1662 -
1663 -Ответ:
1664 -
1665 -{
1666 -
1667 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668 -
1669 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671 -
1672 - "Message": "string", ~/~/ Информация о выполнении запроса
1673 -
1674 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675 -
1676 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677 -
1678 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679 -
1680 - "Data": "string" ~/~/ Данные
1681 -
1682 -}
1683 -
1684 -
1685 1685  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1686 1686  
1687 1687  (% class="box infomessage" %)
... ... @@ -1827,7 +1827,6 @@
1827 1827   "stage": "", ~/~/ Состояние
1828 1828  (% style="color:#000000" %) }
1829 1829  
1830 -== ==
1831 1831  
1832 1832  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1833 1833  
... ... @@ -2512,6 +2512,8 @@
2512 2512   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2513 2513   "fuelConsumption": 0, ~/~/ Расход топлива
2514 2514   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2460 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2461 +
2515 2515   }
2516 2516   ]
2517 2517   }
... ... @@ -2557,7 +2557,8 @@
2557 2557   "model": "string", ~/~/ Модель объекта
2558 2558   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2559 2559   {
2560 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
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 +
2561 2561   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2562 2562   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2563 2563   "valueFuel": 0, ~/~/ Количество
... ... @@ -2786,6 +2786,35 @@
2786 2786   }
2787 2787  ]
2788 2788  
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 +)))
2744 +
2745 +(% style="color:#000000" %)Метод запроса: **PUT**
2746 +
2747 +Пример запроса:
2748 +
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 +}
2759 +)))
2760 +
2761 +
2762 +Пример ответа:
2763 +
2764 +200 ~/~/ Success
2765 +
2789 2789  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2790 2790  
2791 2791  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -4270,6 +4270,43 @@
4270 4270  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4271 4271  |msgCount|Кол-во обработанных сообщений всего
4272 4272  
4250 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4251 +
4252 +(% class="box successmessage" %)
4253 +(((
4254 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4255 +)))
4256 +
4257 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4258 +
4259 +Метод запроса: **POST**
4260 +
4261 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4262 +
4263 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4264 +
4265 +
4266 +Ответ:
4267 +
4268 +{
4269 +
4270 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4271 +
4272 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4273 +
4274 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4275 +
4276 + "Message": "string", ~/~/ Информация о выполнении запроса
4277 +
4278 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4279 +
4280 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4281 +
4282 + "Data": "string" ~/~/ Данные
4283 +
4284 +}
4285 +
4286 +
4273 4273  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4274 4274  
4275 4275  (% class="box infomessage" %)
... ... @@ -4287,10 +4287,59 @@
4287 4287   "message": "string"
4288 4288  }
4289 4289  
4290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4291 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4292 -|progress|Guid ТС
4304 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4305 +**Параметр**
4306 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4307 +**Описание**
4308 +)))
4309 +|(((
4310 +activity
4311 +)))|(((
4312 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4313 +)))
4314 +|(((
4315 +progress
4316 +)))|(((
4317 +Guid ТС
4318 +)))
4293 4293  
4320 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4321 +
4322 +(% class="box infomessage" %)
4323 +(((
4324 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4325 +)))
4326 +
4327 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4328 +
4329 +Метод запроса: **GET**
4330 +
4331 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4332 +
4333 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4334 +
4335 +
4336 +Ответ:
4337 +
4338 +{
4339 +
4340 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4341 +
4342 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4343 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4344 +
4345 + "Message": "string", ~/~/ Информация о выполнении запроса
4346 +
4347 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4348 +
4349 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4350 +
4351 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4352 +
4353 + "Data": "string" ~/~/ Данные
4354 +
4355 +}
4356 +
4294 4294  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4295 4295  
4296 4296  (% class="box infomessage" %)
... ... @@ -4802,8 +4802,51 @@
4802 4802   }
4803 4803   ]
4804 4804  }
4868 +
4869 +
4870 +== **Превышение скорости** ==
4871 +
4872 +(% class="box infomessage" %)
4873 +(((
4874 +**POST /api/v3/Reports/overSpeedDuration**
4805 4805  )))
4806 4806  
4877 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4878 +
4879 +Пример запроса:
4880 +
4881 +(((
4882 +{
4883 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4884 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4885 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4886 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4887 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4888 +}
4889 +)))
4890 +
4891 +(((
4892 +
4893 +)))
4894 +
4895 +(((
4896 +Пример ответа:
4897 +)))
4898 +
4899 +(((
4900 +(((
4901 +[
4902 + {
4903 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4904 + "duration": 0, ~/~/ Продолжительность события в секундах 
4905 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4906 + "speedLimit": 0 ~/~/ Ограничение скорости 
4907 + }
4908 +]
4909 +)))
4910 +)))
4911 +)))
4912 +
4807 4807  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4808 4808  
4809 4809  
... ... @@ -5808,6 +5808,62 @@
5808 5808  )))
5809 5809  
5810 5810  
5917 += **Раздел: Роли** =
5918 +
5919 +== **Получение списка клиентских и системных ролей пользователя ** ==
5920 +
5921 +(% class="box successmessage" %)
5922 +(((
5923 +**POST /api/v3/groups/find**
5924 +)))
5925 +
5926 +Пример запроса:
5927 +
5928 +(((
5929 +{
5930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
5931 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
5932 +}
5933 +)))
5934 +
5935 +(((
5936 +
5937 +)))
5938 +
5939 +(((
5940 +Пример ответа:
5941 +)))
5942 +
5943 +(((
5944 +(((
5945 +{
5946 + "groups": [  ~/~/ Системные роли пользователя
5947 + {
5948 + "code": "string", ~/~/ Код роли.
5949 + "name": "string", ~/~/ Имя  
5950 + "shortName": "string" ~/~/ Короткое имя 
5951 + }
5952 + ],
5953 + "customGroups": [ ~/~/ Системные роли пользователя
5954 + {
5955 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
5956 + "name": "string", ~/~/ Наименование 
5957 + "shortName": "string", ~/~/ Короткое наименование 
5958 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
5959 + }
5960 + ]
5961 +}
5962 +)))
5963 +)))
5964 +
5965 +(((
5966 +
5967 +)))
5968 +
5969 +(((
5970 +
5971 +)))
5972 +
5811 5811  = **Раздел: Локатор ** =
5812 5812  
5813 5813  
... ... @@ -5815,7 +5815,7 @@
5815 5815  
5816 5816  (% class="box infomessage" %)
5817 5817  (((
5818 -**GET /api/v3/locators**
5980 +**GET /api/v3/locators **
5819 5819  )))
5820 5820  
5821 5821  В заголовках запроса: X-Auth: Токен авторизации
... ... @@ -5824,33 +5824,83 @@
5824 5824  Пример ответа:
5825 5825  
5826 5826  (((
5989 +(((
5990 +{
5991 + "vehiclesIds": [ ~/~/ Объекты
5992 + 0
5993 + ],
5994 + "geoIds": [ ~/~/ Геозоны
5995 + 0
5996 + ],
5997 + "fieldsIds": [ ~/~/ Поля
5998 + 0
5999 + ],
6000 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6001 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6002 + "agentName": "string", ~/~/ Наименование агента.
6003 + "isEnabled": true, ~/~/ Активность 
6004 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6005 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6006 + "name": "string", ~/~/ Наименование.
6007 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6008 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6009 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6010 + "validity": 0, ~/~/ Значение срока действия
6011 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6012 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6013 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6014 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6015 + "url": "string", ~/~/ Ссылка
6016 + "language": 0, ~/~/ Язык
6017 + "showVehicleName": true, ~/~/ Наименование объекта
6018 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6019 + "allowTrackReport": true, ~/~/ Трек
6020 + "showTrackTracing": true, ~/~/ Трассировка трека
6021 + "showSensors": true, ~/~/ Датчик
6022 + "availableMapLayers": [ ~/~/  Слои на карте
6023 + 0
6024 + ]
6025 +}
6026 +)))
6027 +)))
6028 +
6029 +
6030 +== **Получение перечня моделей ** ==
6031 +
6032 +(% class="box successmessage" %)
6033 +(((
6034 +**POST /api/v3/models/find**
6035 +)))
6036 +
6037 +Пример запроса:
6038 +
6039 +(((
6040 +(((
6041 +{
6042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6043 + "name": "string", ~/~/ Наименование локатора
6044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6045 +)))
6046 +
6047 +
6048 +
6049 + Пример ответа: 
6050 +
6051 +
6052 +(((
5827 5827  [
5828 5828   {
5829 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5830 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5831 - "agentName": "string", ~/~/ Наименование агента.
5832 - "isEnabled": true, ~/~/ Активен 
5833 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5834 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5835 - "name": "string", ~/~/ Наименование
5836 - "status": 0, ~/~/ 
5837 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5838 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5839 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5840 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5841 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5842 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5843 - "url": "string", ~/~/ Ссылка
5844 - "language": 0, ~/~/ Язык.
5845 - "vehiclesCount": 0, ~/~/ Количество объектов.
5846 - "geozonesCount": 0, ~/~/ Количество геозон.
5847 - "fieldsCount": 0 ~/~/ Количество полей.
6055 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6056 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6057 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6058 + "name": "string", ~/~/ Наименование локатора
6059 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
5848 5848   }
5849 5849  ]
5850 5850  )))
6063 +)))
5851 5851  
5852 5852  
5853 -
5854 5854  == **Создание локатора** ==
5855 5855  
5856 5856  (% class="box successmessage" %)
... ... @@ -5871,6 +5871,24 @@
5871 5871   "autoProlongation": true, ~/~/ Автопродление срока действия.
5872 5872   "url": "string", ~/~/ Ссылка
5873 5873   "language": 0 ~/~/ Язык
6086 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6087 + "vehiclesIds": [ ~/~/ Oбъекты
6088 + 0
6089 + ],
6090 + "geoIds": [ ~/~/ Геозоны
6091 + 0
6092 + ],
6093 + "fieldsIds": [ ~/~/ Поля
6094 + 0
6095 + ],
6096 + "showVehicleName": true, ~/~/ Наименование объекта
6097 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6098 + "allowTrackReport": true, ~/~/ Трек
6099 + "showTrackTracing": true, ~/~/ Трассировка трека
6100 + "showSensors": true, ~/~/ Датчик
6101 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6102 + 0
6103 + ]
5874 5874  }
5875 5875  )))
5876 5876  
... ... @@ -5903,10 +5903,29 @@
5903 5903   "autoProlongation": true, ~/~/ Автопродление срока действия
5904 5904   "url": "string", ~/~/ Ссылка
5905 5905   "language": 0 ~/~/ Язык
6136 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6137 + "vehiclesIds": [ ~/~/ Oбъекты
6138 + 0
6139 + ],
6140 + "geoIds": [ ~/~/ Геозоны
6141 + 0
6142 + ],
6143 + "fieldsIds": [ ~/~/ Поля
6144 + 0
6145 + ],
6146 + "showVehicleName": true, ~/~/ Наименование объекта
6147 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6148 + "allowTrackReport": true, ~/~/ Трек
6149 + "showTrackTracing": true, ~/~/ Трассировка трека
6150 + "showSensors": true, ~/~/ Датчик
6151 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6152 + 0
6153 + ]
5906 5906  }
6155 +
6156 +
5907 5907  )))
5908 5908  
5909 -
5910 5910  Пример ответа:
5911 5911  
5912 5912  200 ~/~/ Success
... ... @@ -5929,7 +5929,215 @@
5929 5929  
5930 5930  
5931 5931  
6181 += **Раздел: Яндекс Маршруты** =
5932 5932  
6183 +
6184 +== **Возвращение списка маршрутов** ==
6185 +
6186 +(% class="box infomessage" %)
6187 +(((
6188 +**GET /api/v3/TransportRoutes**
6189 +)))
6190 +
6191 +Пример запроса:
6192 +Id  ~/~/ Идентификатор поля
6193 +
6194 +
6195 +Пример ответа:
6196 +
6197 +(((
6198 +[
6199 + {
6200 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6201 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6202 + "name": "string", ~/~/ Наименование маршрута.
6203 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6204 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6205 + 0
6206 + ]
6207 + }
6208 +]
6209 +)))
6210 +
6211 +
6212 +
6213 +== **Добавить маршрут** ==
6214 +
6215 +(% class="box infomessage" %)
6216 +(((
6217 +**POST /api/v3/TransportRoutes**
6218 +)))
6219 +
6220 +Пример запроса: 
6221 +{
6222 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6223 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6224 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6225 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6226 + 0
6227 + ]
6228 +}
6229 +
6230 +
6231 +Пример ответа:
6232 +
6233 +(((
6234 +{
6235 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6236 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6237 + "name": "string", ~/~/ Определяет наименование маршрута 
6238 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6239 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6240 + 0
6241 + ]
6242 +}
6243 +)))
6244 +
6245 +
6246 +== **Обновление маршрута** ==
6247 +
6248 +(% class="box successmessage" %)
6249 +(((
6250 +**PUT /api/v3/TransportRoutes**
6251 +)))
6252 +
6253 +Пример запроса:
6254 +
6255 +(((
6256 +{
6257 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6258 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6259 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6260 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6261 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6262 + 0
6263 + ]
6264 +}
6265 +)))
6266 +
6267 +
6268 +Пример ответа:
6269 +
6270 +(((
6271 +{
6272 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6273 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6274 + "name": "string", ~/~/ Определяет наименование маршрута 
6275 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6276 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6277 + 0
6278 + ]
6279 +}
6280 +)))
6281 +
6282 +
6283 +== **Получить связки маршрутов ТС** ==
6284 +
6285 +(% class="box infomessage" %)
6286 +(((
6287 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6288 +)))
6289 +
6290 +Пример запроса:
6291 +
6292 +(((
6293 +[
6294 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6295 +]
6296 +)))
6297 +
6298 +
6299 +Пример ответа:
6300 +
6301 +(((
6302 +[
6303 + {
6304 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6305 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6306 + }
6307 +]
6308 +)))
6309 +
6310 +
6311 +== **Удалить маршрут** ==
6312 +
6313 +(% class="box warningmessage" %)
6314 +(((
6315 +**DELETE /api/v3/TransportRoutes/{id}**
6316 +)))
6317 +
6318 +Пример запроса:
6319 +Id  ~/~/ Идентификатор поля
6320 +
6321 +
6322 +
6323 += **Раздел: Управление доступа к машинам** =
6324 +
6325 +
6326 +== Получение списка транспортных средств видимых пользователю ==
6327 +
6328 +(% class="box infomessage" %)
6329 +(((
6330 +**GET /api/v3/UserVisibleVehicles/{userId}**
6331 +)))
6332 +
6333 +Пример ответа:
6334 +
6335 +(((
6336 +{
6337 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6338 + 0
6339 + ]
6340 +}
6341 +)))
6342 +
6343 +
6344 +
6345 +== Задает видимость транспортных средств пользователю ==
6346 +
6347 +(% class="box infomessage" %)
6348 +(((
6349 +**POST /api/v3/UserVisibleVehicles**
6350 +)))
6351 +
6352 +Пример запроса:
6353 +
6354 +(((
6355 +(((
6356 +{
6357 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6358 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6359 + 0
6360 + ]
6361 +}
6362 +)))
6363 +
6364 +(((
6365 +
6366 +)))
6367 +
6368 +(((
6369 +
6370 +)))
6371 +
6372 +(((
6373 +Пример ответа :
6374 +)))
6375 +
6376 +(((
6377 +
6378 +)))
6379 +
6380 +(((
6381 +200 ~/~/ Success
6382 +)))
6383 +)))
6384 +
6385 +
6386 +
6387 +
6388 +
6389 +
5933 5933  (% class="box" lang="en-US" style="text-align: center;" %)
5934 5934  (((
5935 5935  (% 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]] **

Меню

ГЛОНАССSoft wiki - 2024 г.