Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -14,13 +14,13 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box infomessage" %)23 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,7 +40,6 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,6 +55,15 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 + 63 +(% class="wikigeneratedid" %) 64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 65 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 98 - "agentId": "", ~/~/идентификатор клиента(%%)99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)104 - "isForeign": true/false, ~/~/ Иностранный контрагент105 - "district": "string", ~/~/ округ106 - "region": "string", ~/~/ регион107 - "city": "string", ~/~/ город108 - "inn": "string", ~/~/ ИНН клиента109 - "kpp": "string", ~/~/ КПП клиента110 - "address": "string", ~/~/ юридический адрес111 - "addressFact": "string", ~/~/ фактический адрес112 - "email": "string", ~/~/ почта113 - "director": "string", ~/~/ ФИО руководителя114 - "bankName": "string", ~/~/ Банк115 - "bankBIK": "string", ~/~/ БИК116 - "bankRS": "string", ~/~/ Номер счета117 - "bankKS": "string" ~/~/ Корр. счет105 + "agentId": "", (%%) 106 + "parentId": "", 107 + "parentName": "string", 108 + "name": "string", 109 + "fullName": "string", 110 + "agentInfoType": 0, 111 + "isForeign": true/false, 112 + "district": "string", 113 + "region": "string", 114 + "city": "string", 115 + "inn": "string", 116 + "kpp": "string", 117 + "address": "string", 118 + "addressFact": "string", 119 + "email": "string", 120 + "director": "string", 121 + "bankName": "string", 122 + "bankBIK": "string", 123 + "bankRS": "string", 124 + "bankKS": "string" 118 118 } 119 119 127 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 128 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 129 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 130 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 131 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 132 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 133 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 134 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 135 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 136 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 137 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 138 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 139 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 140 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 141 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 142 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 143 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 144 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 145 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 146 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 147 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 148 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».162 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 177 + "agentId": "",(% style="color:#000000" %) (%%) 178 + "parentId": "", 179 + "name": "string", 180 + "fullName": "string", 181 + "agentInfoType": 0, 182 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 185 + 186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 187 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 188 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 189 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 190 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 191 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 192 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 193 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 258 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 259 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 260 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 261 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 262 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 263 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 264 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 265 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 266 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 267 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 268 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 269 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 270 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 271 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 272 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 273 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 274 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 275 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 276 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 277 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 278 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 361 + 362 +(% class="box warningmessage" %) 363 +((( 364 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 365 +))) 366 + 367 +Метод позволяет изменить статус клиента, указанного в запросе. 368 + 369 +В пути указывается GUID клиента и статус клиента. 370 + 371 +**status **- значение 0 - заблокирован, 1 - активен. 372 + 373 +Ответ: Code 204 374 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -363,7 +363,6 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -392,6 +392,7 @@ 392 392 (% style="text-align:left" %) 393 393 (% style="color:#000000; font-weight:normal" %)} 394 394 466 + 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 397 (% class="box infomessage" %) ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 980 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -1113,6 +1113,87 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1212 +(% class="wikigeneratedid" %) 1213 +===== ===== 1214 + 1215 +(% class="wikigeneratedid" %) 1216 +===== **Получить ответ на отправленную на ТС команду** ===== 1217 + 1218 +(% class="box infomessage" %) 1219 +((( 1220 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1221 +))) 1222 + 1223 +Идентификатор команды: cmdid 1224 + 1225 + 1226 +Запрос от терминала на ответ команды 1227 + 1228 + 1229 +Пример ответ от терминала: 1230 + 1231 + 1232 +ID= "" ~/~/ идентификатор произвольного поля 1233 + 1234 +Soft="" ~/~/ версия софта 1235 + 1236 +GPS=4 ~/~/ тип трекера 1237 + 1238 +Time=11:05:43 28.06.24 ~/~/ время запроса 1239 + 1240 +Lat=45.056221 ~/~/ широта 1241 + 1242 +Lon=39.035938 ~/~/ долгота 1243 + 1244 +Speed=0.0 ~/~/ скорость 1245 + 1246 +Course=181.4 ~/~/направление 1247 + 1248 + 1249 + 1250 +((( 1251 +(% class="wikigeneratedid" %) 1252 +===== **Список отправленных объекту команд с ответами** ===== 1253 + 1254 +(% class="box infomessage" %) 1255 +((( 1256 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1257 +))) 1258 + 1259 +Идентификатор ТС: vehicleId 1260 + 1261 + 1262 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1263 + 1264 + 1265 +Пример ответа терминала 1266 + 1267 + 1268 +[ 1269 + 1270 +{ 1271 + 1272 +"id": "", ~/~/ идентификатор пользователя 1273 + 1274 +"commandText": "", ~/~/Текст команды. 1275 + 1276 +"templateId": "", ~/~/Идентификатор шаблона 1277 + 1278 +"updated": "", ~/~/ Время отправки 1279 + 1280 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1281 + 1282 +"answer": "", ~/~/ Ответ терминала. 1283 + 1284 +"status": "" ~/~/ Статус отправки 1285 + 1286 +} 1287 + 1288 +] 1289 + 1290 + 1291 +))) 1292 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1335,7 +1335,7 @@ 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1515 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1456,6 +1456,30 @@ 1456 1456 (% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1636 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1637 +**Отправить команду на терминал** 1638 + 1639 +(% class="box successmessage" %) 1640 +((( 1641 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1642 +))) 1643 + 1644 +Команда для отправки на тс. 1645 + 1646 + 1647 +{ 1648 + 1649 +"id": "", ~/~/идентификатор произвольного поля 1650 + 1651 +"command": "", ~/~/ Текст команды 1652 + 1653 +"retries": "", ~/~/ Количество попыток 1654 + 1655 +"idTemplate": "" ~/~/ ID шаблона команды 1656 + 1657 +} 1658 + 1659 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1709,7 +1709,7 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]1913 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 1996 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1997 + 1998 +(% class="box infomessage" style="text-align: left;" %) 1999 +((( 2000 +**POST /api/v3/terminalMessages/mapping** 2001 +))) 2002 + 2003 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2004 + 2005 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2006 + 2007 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2008 + 2009 +{ 2010 + "protocolType": 0, 2011 + "params": ["string"] 2012 +} 2013 + 2014 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2015 +|protocolType|ID типа протокола 2016 +|params|((( 2017 +Массив наименований параметров в сообщении 2018 +))) 2019 + 2020 +Ответ: 2021 + 2022 +{ 2023 + "protocolType": 0, 2024 + "mapping": { 2025 + "additionalProp1": { 2026 + "inputType": 0, 2027 + "inputNumber": 0 2028 + }, 2029 + "additionalProp2": { 2030 + "inputType": 0, 2031 + "inputNumber": 0 2032 + } 2033 + } 2034 +} 2035 + 2036 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2037 +|protocolType|Тип протокола 2038 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2039 +|inputNumber|((( 2040 +Номер входа 2041 +))) 2042 + 2043 +(% class="wikigeneratedid" %) 2044 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2045 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2071 +|vehicleId|ID объекта 2072 +|from|Дата и время начала периода запроса 2073 +|to|Дата и время окончания периода запроса 2074 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2081 + "deviceTime": "2023-11-29T07:40:44.052Z", 2082 + "serverTime": "2023-11-29T07:40:44.052Z", 2083 + "speed": 0, 2084 + "altitude": 0, 2085 + "latitude": 0, 2086 + "longitude": 0, 2087 + "satellites": 0, 2088 + "course": 0, 2089 + "voltage": 0, 2090 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2095 + "photoCount": 0, 2096 + "lbsCorrectedCoords": true, 2097 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2103 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2104 +|deviceTime|Время сообщения терминала 2105 +|serverTime|Время когда сообщение поступило на сервер 2106 +|speed|Скорость 2107 +|altitude|Высота над уровнем моря 2108 +|latitude|Широта 2109 +|longitude|Долгота 2110 +|satellites|Кол-во спутников 2111 +|course|Курс 2112 +|voltage|Бортовое напряжение 2113 +|parameters|Список параметров и их значений 2114 +|photoCount|Количество фото 2115 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2116 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2029,6 +2029,129 @@ 2029 2029 } 2030 2030 ] 2031 2031 2251 + 2252 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2253 + 2254 +(% class="box infomessage" %) 2255 +((( 2256 +**POST /api/v3/vehicles/moveStop** 2257 +))) 2258 + 2259 +Метод запроса: **POST** 2260 + 2261 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2262 + 2263 +В заголовках запроса: X-Auth: Токен авторизации 2264 + 2265 + 2266 +Тело запроса: 2267 + 2268 +{ 2269 + 2270 + "vehicleIds": [ ], ~/~/ Список ID объектов 2271 + 2272 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2273 + 2274 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2275 + 2276 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2277 + 2278 +} 2279 + 2280 +Ответ: 2281 + 2282 +[ 2283 + 2284 + { 2285 + 2286 + "vehicleId": 0, ~/~/ ID объекта 2287 + 2288 + "vehicleName": "string", ~/~/ Имя объекта 2289 + 2290 + "moves": [ ~/~/ Событие движения 2291 + 2292 + { 2293 + 2294 + "mileage": 0, ~/~/ Пробег, км 2295 + 2296 + "eventId": 0, ~/~/ Идентификатор события 2297 + 2298 + "eventName": "string", ~/~/ Название события 2299 + 2300 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2301 + 2302 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2303 + 2304 + "duration": 0 ~/~/ Продолжительность события, секунд 2305 + 2306 + } 2307 + 2308 + ], 2309 + 2310 + "stops": [ ~/~/ События стоянок 2311 + 2312 + { 2313 + 2314 + "address": "string", ~/~/ Адрес события 2315 + 2316 + "eventId": 0, ~/~/ Идентификатор события 2317 + 2318 + "eventName": "string", ~/~/ Название события 2319 + 2320 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2321 + 2322 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2323 + 2324 + "duration": 0 ~/~/ Продолжительность события, секунд 2325 + 2326 + 2327 + } 2328 + 2329 + ] 2330 + 2331 + } 2332 + 2333 +] 2334 + 2335 + 2336 + 2337 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2338 + 2339 +(% class="box infomessage" %) 2340 +((( 2341 +**POST /api/v3/vehicles/getlastdata** 2342 +))) 2343 + 2344 +Метод запроса: **POST** 2345 + 2346 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2347 + 2348 +В заголовках запроса: X-Auth: Токен авторизации 2349 + 2350 + 2351 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2352 + 2353 +Ответ: 2354 + { 2355 + "vehicleId": 0, ~/~/Идентификатор объекта. 2356 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2357 + "vehicleNumber": "string",~/~/Номер объекта. 2358 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2359 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2360 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2361 + "speed": 0,~/~/Скорость объекта. 2362 + "course": 0,~/~/Курс движения [0;360] 2363 + "latitude": 0,~/~/Широта [-90°;90°]. 2364 + "longitude": 0,~/~/Долгота [-180°;180°]. 2365 + "address": "string",~/~/Адрес. 2366 + "geozones": [ ~/~/Сведения по геозонам. 2367 + { 2368 + "id": 0, 2369 + "name": "string" 2370 + } 2371 + 2372 + 2373 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3272 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3273 + 3274 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3275 + 3276 +(% class="box infomessage" %) 3277 +((( 3278 +**POST /api/v3/Trailers** 3279 +))) 3280 + 3281 +Пример запроса: 3282 + 3283 +{ 3284 + "startDate": "2023-11-14T10:48:03.671Z", 3285 + "endDate": "2023-11-14T10:48:03.671Z", 3286 + "ids": [ 0 ], 3287 + "timezone": 0 3288 +} 3289 + 3290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3291 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3292 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3293 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3294 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3295 + 3296 +Пример ответа: 3297 + 3298 +[ 3299 + { 3300 + "SD": "2023-11-14T10:48:03.717Z", 3301 + "ED": "2023-11-14T10:48:03.717Z", 3302 + "id": 0, 3303 + "SLat": 0, 3304 + "SLon": 0, 3305 + "ELat": 0, 3306 + "ELon": 0, 3307 + "mileage": 0 3308 + "Duration": 0 3309 + "Address": "string", 3310 + "Address2": "string", 3311 + "name": "string", 3312 + "rid": "string", 3313 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3314 + "trailer": { 3315 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3316 + "Number": "string", 3317 + "Description": "string", 3318 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3319 + "ExternalID": "string", 3320 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3321 + "CreateTime": "2023-11-14T10:48:03.717Z", 3322 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3323 + "IsDeleted": true 3324 + }, 3325 + "filesCount": 0, 3326 + } 3327 +] 3328 + 3329 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3330 +|SD|Дата и время начала события 3331 +|ED|Дата и время окончания события 3332 +|id|ID объекта 3333 +|SLat|Широта начальной координаты 3334 +|SLon|Долгота начальной координаты 3335 +|ELat|Широта конечной координаты 3336 +|ELon|Долгота конечной координаты 3337 +|mileage|Пробег 3338 +|Duration|Продолжительность 3339 +|Address|Адрес начального местоположения 3340 +|Address2|Адрес конечного местоположения 3341 +|name|Имя радиометки 3342 +|rid|Номер радиометки 3343 +|rguid|ID радиометки 3344 +|trailer|Информация об агрегате 3345 +|ModelGuid|ID агрегата 3346 +|Number|Название/номер агрегата 3347 +|Description|Текст примечания агрегата 3348 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3370 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3376 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3377 +|parentId|ID клиента 3378 +|name|Название карты-метки 3379 +|number|Номер 3380 +|period|Период запросов в секундах (работает только для агрегатов) 3381 +|id|ID карты-метки 3382 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3398 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3404 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3405 +|name|Название карты-метки 3406 +|number|Номер 3407 +|period|Период запросов в секундах (работает только для агрегатов) 3408 +|id|ID карты-метки 3409 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3437 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3438 +|name|Название карты-метки 3439 +|number|Номер 3440 +|period|Период запросов в секундах (работает только для агрегатов) 3441 +|id|ID карты-метки 3442 +|parentId|ID клиента 3443 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3471 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3472 +|name|Название карты-метки 3473 +|number|Номер 3474 +|period|Период запросов в секундах (работает только для агрегатов) 3475 +|id|ID карты-метки 3476 +|parentId|ID клиента 3477 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3485 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 3726 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3727 + 3286 3286 Тело запроса: 3287 3287 3288 3288 { ... ... @@ -3296,6 +3296,50 @@ 3296 3296 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 3297 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 3298 3741 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3742 + 3743 +(% class="box warningmessage" %) 3744 +((( 3745 +**PUT /api/v3/billing/client/balance/deposit** 3746 +))) 3747 + 3748 +Создает операцию **Пополнение **с указанной суммой 3749 + 3750 +Тело запроса: 3751 + 3752 +{ 3753 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3754 + "Balance": 0 3755 +} 3756 + 3757 +Ответ: Success 3758 + 3759 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3760 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3761 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3762 + 3763 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3764 + 3765 +Создает операцию **Списание **с указанной суммой 3766 + 3767 +(% class="box warningmessage" %) 3768 +((( 3769 +**PUT /api/v3/billing/client/balance/withdraw** 3770 +))) 3771 + 3772 +Тело запроса: 3773 + 3774 +{ 3775 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3776 + "Balance": 0 3777 +} 3778 + 3779 +Ответ: Success 3780 + 3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3782 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3783 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3784 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3368,6 +3368,990 @@ 3368 3368 |PeriodValue|Значение периода. 3369 3369 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 3370 3857 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3858 + 3859 +(% class="box warningmessage" %) 3860 +((( 3861 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3862 +))) 3863 + 3864 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3865 + 3866 +(% class="box infomessage" %) 3867 +((( 3868 +**POST /api/v3/vehicles/import/{agentId}** 3869 +))) 3870 + 3871 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3872 + 3873 +В пути указывается **agentId** - id клиента. 3874 + 3875 +**Заголовок** 3876 + 3877 +**X-Auth: [токен авторизации]** 3878 + 3879 +**Параметры** 3880 + 3881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3882 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3883 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3884 + 3885 +В теле использовать тип **form-data,** тип значения** file** 3886 + 3887 +**Ключи** 3888 + 3889 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3890 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3891 +|csv|В значении передаем файл датчиков, формат **csv** 3892 + 3893 +Ответ: 3894 + 3895 +{ 3896 + "vehicleId": 0, 3897 + "name": "string", 3898 + "errors": ["string"] 3899 +} 3900 + 3901 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3902 +|vehicleId|ID созданного объекта 3903 +|name|Имя созданного объекта 3904 +|errors|Ошибки и их описание 3905 + 3906 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3907 + 3908 +(% class="box infomessage" %) 3909 +((( 3910 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3911 +))) 3912 + 3913 +(% class="wikigeneratedid" %) 3914 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3915 + 3916 +(% class="wikigeneratedid" %) 3917 +В пути указывается **vehicleId **- id объекта. 3918 + 3919 +**Заголовок** 3920 + 3921 +**X-Auth: [токен авторизации]** 3922 + 3923 +В теле использовать тип **form-data.** 3924 + 3925 +Ключи: 3926 + 3927 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3928 +|**history**|В значении передавать файл с историей 3929 + 3930 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3931 + 3932 +Ответ: 3933 + 3934 +{ 3935 + "results": [ 3936 + { 3937 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3938 + "vehicleId": 0, 3939 + "errors": [ 3940 + "string" 3941 + ], 3942 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3943 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3944 + "producedCount": 0, 3945 + "msgCount": 0 3946 + } 3947 + ] 3948 +} 3949 + 3950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3951 +|results|Результаты импорта в разрезе ТС 3952 +|vehicleGuid|Guid ТС 3953 +|vehicleId|ID ТС 3954 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3955 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3956 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3957 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3958 +|msgCount|Кол-во обработанных сообщений всего 3959 + 3960 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3961 + 3962 +(% class="box infomessage" %) 3963 +((( 3964 +**GET /api/v3/vehicles/import/history/status** 3965 +))) 3966 + 3967 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3968 + 3969 +Ответ: 3970 + 3971 +{ 3972 + "activity": true, 3973 + "progress": 0, 3974 + "message": "string" 3975 +} 3976 + 3977 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3978 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3979 +|progress|Guid ТС 3980 + 3981 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3982 + 3983 +(% class="box infomessage" %) 3984 +((( 3985 +**POST /api/v3/vehicles/export** 3986 +))) 3987 + 3988 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3989 + 3990 +Тело запроса: 3991 + 3992 +[ 3993 + id 3994 +] 3995 + 3996 +Ответ: Success 200, получаете файлы с настройками. 3997 + 3998 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3999 + 4000 +(% class="box infomessage" %) 4001 +((( 4002 +**POST /api/v3/vehicles/export/history** 4003 +))) 4004 + 4005 +Метод возвращает список сообщений терминала объекта за выбранный период. 4006 + 4007 +Тело запроса: 4008 + 4009 +{ 4010 + "vehicleId": 0, 4011 + "asArchive": true, 4012 + "from": "2023-09-27T12:17:45.973Z", 4013 + "to": "2023-09-27T12:17:45.973Z" 4014 +} 4015 + 4016 +Ответ: 4017 + 4018 +Получаете файл. Сообщение: Code 200/Success 4019 + 4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4021 +|vehicleId|ID объекта 4022 +|asArchive|true - Архивировать файл, False - не архивировать 4023 +|from|Дата и время начала запроса 4024 +|to|Дата и время окончания запроса 4025 + 4026 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4027 + 4028 +(% class="box infomessage" %) 4029 +((( 4030 +**GET /api/v3/vehicles/export/history/status** 4031 +))) 4032 + 4033 +Метод возвращает список сообщений терминала объекта за выбранный период. 4034 + 4035 +Ответ: 4036 + 4037 +{ 4038 + "activity": true, 4039 + "progress": 0, 4040 + "message": "string" 4041 +} 4042 + 4043 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4044 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4045 +|progress|Прогресс экспорта, от 0 до 100% 4046 +|message|Текст описывающий статус 4047 + 4048 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4049 + 4050 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4051 + 4052 +(% class="box infomessage" %) 4053 +((( 4054 +**POST /api/v3/EcoDriving/rating** 4055 +))) 4056 + 4057 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4058 + 4059 +Тело запроса: 4060 + 4061 +{ 4062 + "vehicleIds": [vehicleId], 4063 + "from": "2023-11-22T09:29:48.051Z", 4064 + "to": "2023-11-22T09:29:48.051Z" 4065 +} 4066 + 4067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4068 +|vehicleIds|Массив ID объектов 4069 +|from|Дата начала запроса 4070 +|to|Дата окончания запроса 4071 + 4072 +Ответ: 4073 + 4074 +{ 4075 + "items": [ 4076 + { 4077 + "from": "2023-11-22T09:29:48.052Z", 4078 + "to": "2023-11-22T09:29:48.052Z", 4079 + "vehicleId": 0, 4080 + "vehicleName": "string", 4081 + "vehicleModel": "string", 4082 + "penalty": 0, 4083 + "score": 0, 4084 + "totalViolations": 0, 4085 + "violationsByType": { 4086 + "overspeedingViolations": 0, 4087 + "accelerationViolations": 0, 4088 + "brakingViolations": 0, 4089 + "turningViolations": 0, 4090 + "dangerousDrivingViolations": 0, 4091 + "sensorViolations": 0 4092 + }, 4093 + "moveTime": 0, 4094 + "mileage": 0, 4095 + "tripsCount": 0, 4096 + "trips": [ 4097 + { 4098 + "penalty": 0, 4099 + "score": 0, 4100 + "violationsCount": 0, 4101 + "violationsByType": { 4102 + "overspeedingViolations": 0, 4103 + "accelerationViolations": 0, 4104 + "brakingViolations": 0, 4105 + "turningViolations": 0, 4106 + "dangerousDrivingViolations": 0, 4107 + "sensorViolations": 0 4108 + }, 4109 + "moveTime": 0, 4110 + "mileage": 0, 4111 + "motohours": 0, 4112 + "maxSpeed": 0, 4113 + "startAddress": "string", 4114 + "endAddress": "string", 4115 + "drivers": [ 4116 + { 4117 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4118 + "driverName": "string", 4119 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4120 + } 4121 + ] 4122 + } 4123 + ] 4124 + } 4125 + ] 4126 +} 4127 + 4128 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4129 +|from|Дата начала запроса 4130 +|to|Дата окончания 4131 +|vehicleId|ID объекта 4132 +|vehicleName|Имя объекта 4133 +|vehicleModel|Модель объекта 4134 +|penalty|Сумма штрафных баллов 4135 +|score|Оценка 4136 +|totalViolations|Суммарное количество нарушений 4137 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4138 +|overspeedingViolations|Превышение скорости 4139 +|accelerationViolations|Ускорение 4140 +|brakingViolations|Торможение 4141 +|turningViolations|Резкий поворот 4142 +|dangerousDrivingViolations|Резкое вождение 4143 +|sensorViolations|Нарушение по датчику 4144 +|moveTime|Время в движении 4145 +|mileage|Пробег 4146 +|tripsCount|Количество рейсов 4147 +|motohours|Моточасы 4148 +|maxSpeed|Максимальная скорость 4149 +|startAddress|Адрес начала рейса 4150 +|endAddress|Адрес окончания рейса 4151 +|drivers|Список водителей, которые были на объекте в течениии рейса 4152 +|driverGuid|Guid водителя 4153 +|driverName|Имя водителя 4154 +|driverRfid|Номер Карты-метки 4155 + 4156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4157 + 4158 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4159 + 4160 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4161 + 4162 +(% class="box infomessage" %) 4163 +((( 4164 +POST /api/v3/fuelcards/transactions 4165 +))) 4166 + 4167 +Метод запроса: POST 4168 + 4169 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4170 +\\В заголовках запроса: X-Auth: Токен авторизации 4171 + 4172 +Параметры в теле запроса (JSON): 4173 + 4174 +{ 4175 + 4176 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4177 + 4178 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4179 + 4180 + "ids": [ 4181 + 4182 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4183 + 4184 + ], 4185 + 4186 + "timezone": 0 ~/~/Таймзона 4187 + 4188 +} 4189 + 4190 +Ответ: 4191 + 4192 + { 4193 + 4194 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4195 + 4196 + "driver": "string", ~/~/Водители, привязанные к ТК 4197 + 4198 + "object": "string", ~/~/Наименование ТС 4199 + 4200 + "amount": 0, ~/~/Количество топлива 4201 + 4202 + "amountDut": 0, ~/~/Количество по ДУТ 4203 + 4204 + "amountDiff": 0, ~/~/Разница, л 4205 + 4206 + "amountDiffPerc": 0, ~/~/Разница, % 4207 + 4208 + "summa": 0, ~/~/Стоимость, руб 4209 + 4210 + "serviceName": "string", ~/~/Тип топлива 4211 + 4212 + "price": 0, ~/~/Цена за литр, руб 4213 + 4214 + "cardName": "string", ~/~/Наименование ТК 4215 + 4216 + "cardNum": "string", ~/~/Номер ТК 4217 + 4218 + "operator": "string", ~/~/Оператор ТК 4219 + 4220 + "address": "string" ~/~/Адрес АЗС 4221 + 4222 + } 4223 + 4224 + 4225 +==== (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** ==== 4226 + 4227 + 4228 +==== **Получение полных данных о ретрансляторе** ==== 4229 + 4230 +(% class="box infomessage" %) 4231 +((( 4232 +**GET ** **/api/v3/retranslations/{id}** 4233 +))) 4234 + 4235 +Идентификатор запроса: ID 4236 + 4237 + 4238 +Пример ответа: 4239 + 4240 +{ 4241 + 4242 +"description": "", ~/~/ Определяет описание 4243 + 4244 +"subscriberId": "", ~/~/ Подписчик 4245 + 4246 +"protocolType": 0, ~/~/ Тип протокола 4247 + 4248 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4249 + 4250 +"address": "string", ~/~/ Адрес события 4251 + 4252 +"objects": [ ~/~/Объекты для ретрансляции 4253 + 4254 +{ 4255 + 4256 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4257 + 4258 +"name": "", ~/~/ Наименование объекта ретрансляции 4259 + 4260 +"imei": "", ~/~/ IMEI объекта 4261 + 4262 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4263 + 4264 +} 4265 + 4266 + ], 4267 + 4268 +"id": "", ~/~/ идентификатор пользователя 4269 + 4270 +"parentId": "", ~/~/Guid родителя 4271 + 4272 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4273 + 4274 +} 4275 + 4276 + 4277 +==== **Удаление данных ретранслятора** ==== 4278 + 4279 +(% class="box infomessage" %) 4280 +((( 4281 +**DELETE** **/api/v3/retranslations/{id}** 4282 +))) 4283 + 4284 +Параметр запроса: ID 4285 + 4286 + 4287 +==== **Создание ретранслятора** ==== 4288 + 4289 +(% class="box infomessage" %) 4290 +((( 4291 +**POST ** **/api/v3/retranslations/{id}** 4292 +))) 4293 + 4294 +Запрос: 4295 + 4296 + 4297 +{ 4298 + 4299 +"description": "", ~/~/ Описание 4300 + 4301 +"subscriberId": "", ~/~/ Подписчик 4302 + 4303 +"protocolType": 0, ~/~/ Тип протокола 4304 + 4305 +"address": "", ~/~/ Адрес ретрансляции 4306 + 4307 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4308 + 4309 +"objects": [ ~/~/Объекты для ретрансляции 4310 + 4311 +{ 4312 + 4313 +"id": "", ~/~/ идентификатор пользователя 4314 + 4315 +"imei": "", ~/~/IMEI объекта 4316 + 4317 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4318 + 4319 +} 4320 + 4321 + ] 4322 + 4323 +} 4324 + 4325 + 4326 + 4327 +Ответ 4328 + 4329 +{ 4330 + 4331 +"description": "string", ~/~/ Определяет описание 4332 + 4333 +"subscriberId": "", ~/~/ идентификатор запроса 4334 + 4335 +"protocolType": 0, ~/~/ Тип протокола 4336 + 4337 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4338 + 4339 +"address": "", ~/~/ Адрес события 4340 + 4341 +"objects": [ ~/~/Объекты для ретрансляции 4342 + 4343 +{ 4344 + 4345 +"id": "", ~/~/ идентификатор пользователя 4346 + 4347 +"name": "string", ~/~/ Название уведомления 4348 + 4349 +"imei": "string", ~/~/IMEI объекта 4350 + 4351 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4352 + 4353 +} 4354 + 4355 + ], 4356 + 4357 +"id": "", ~/~/ идентификатор пользователя 4358 + 4359 +"parentId": "", ~/~/ Guid идентификатор родителя 4360 + 4361 +"deleted": true ~/~/ Признак удаления 4362 + 4363 +} 4364 + 4365 + 4366 +==== **Редактирование ретранслятора** ==== 4367 + 4368 +(% class="box infomessage" %) 4369 +((( 4370 +**PUT** **/api/v3/retranslations** 4371 +))) 4372 + 4373 +Пример запроса: 4374 + 4375 +{ 4376 + 4377 +"id": "", ~/~/ идентификатор пользователя 4378 + 4379 +"description": "string", ~/~/ Определяет описание 4380 + 4381 +"subscriberId": "", ~/~/ идентификатор запроса 4382 + 4383 +"protocolType": 0, ~/~/ Тип протокола 4384 + 4385 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4386 + 4387 +"address": "string", ~/~/ Адрес события 4388 + 4389 +"objects": ~/~/Объекты для ретрансляции 4390 + 4391 +[ 4392 + 4393 +{ 4394 + 4395 +"id": "", ~/~/ идентификатор пользователя 4396 + 4397 +"imei": "", ~/~/IMEI объекта 4398 + 4399 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4400 + 4401 +} 4402 + 4403 + ] 4404 + 4405 +} 4406 + 4407 + 4408 +Пример ответа: 4409 + 4410 +{ 4411 + 4412 +"description": "", ~/~/ Определяет описание 4413 + 4414 +"subscriberId": "", ~/~/ идентификатор запроса 4415 + 4416 +"protocolType": 0, ~/~/ Тип протокола 4417 + 4418 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4419 + 4420 +"address": "string", ~/~/ Адрес события 4421 + 4422 +"objects": [ ~/~/Объекты для ретрансляции 4423 + 4424 +{ 4425 + 4426 +"id": "", ~/~/ идентификатор пользователя 4427 + 4428 +"name": "string", ~/~/ Название уведомления 4429 + 4430 +"imei": "", ~/~/IMEI объекта 4431 + 4432 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4433 + 4434 +} 4435 + 4436 + ], 4437 + 4438 +"id": "", ~/~/ идентификатор пользователя 4439 + 4440 +"parentId": "", ~/~/ Guid идентификатор родителя 4441 + 4442 +"deleted": true ~/~/ Признак удаления 4443 + 4444 +} 4445 + 4446 + 4447 + 4448 +==== **Получение списка ретранслятора клиента** ==== 4449 + 4450 +(% class="box infomessage" %) 4451 +((( 4452 +**POST /api/v3/retranslations/find** 4453 +))) 4454 + 4455 +Пример запроса: 4456 + 4457 + 4458 +{ 4459 + 4460 +"id": "", ~/~/ идентификатор пользователя 4461 + 4462 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4463 + 4464 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4465 + 4466 +} 4467 + 4468 + 4469 + 4470 +Ответ 4471 + 4472 + 4473 +[ 4474 + 4475 +{ 4476 + 4477 +"description": "", ~/~/ Определяет описание 4478 + 4479 +"subscriberId": "", ~/~/ идентификатор запроса 4480 + 4481 +"protocolType": 0, ~/~/ Тип протокола 4482 + 4483 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4484 + 4485 +"address": "string", ~/~/ Адрес события 4486 + 4487 +"id": "", ~/~/ идентификатор пользователя 4488 + 4489 +"parentId": "", ~/~/ Guid идентификатор родителя 4490 + 4491 +"deleted": true ~/~/ Признак удаления 4492 + 4493 +} 4494 + 4495 +] 4496 + 4497 + 4498 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) = 4499 + 4500 + 4501 +==== **API для отчета по выгрузке комбайнов** ==== 4502 + 4503 + 4504 +(% class="box infomessage" %) 4505 +((( 4506 +POST **/api/v3/Reports/harvesterUnloading** 4507 +))) 4508 + 4509 +Пример запроса: 4510 + 4511 + 4512 +{ 4513 + 4514 + "byTime": 0, ~/~/ Объединение событий по времени 4515 + 4516 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4517 + 4518 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4519 + 4520 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4521 + 4522 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4523 + 4524 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4525 + 4526 + 0 4527 + 4528 + ], 4529 + 4530 + "from": "", ~/~/ Дата и время начало запроса 4531 + 4532 + "to": "", ~/~/ Дата и время окончания запроса 4533 + 4534 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4535 + 4536 +} 4537 + 4538 + 4539 + 4540 +Пример ответа: 4541 + 4542 + 4543 +[ 4544 + 4545 + { 4546 + 4547 + "harvesterName": "", ~/~/Комбайн, номер 4548 + 4549 + "harvesterId": 0, ~/~/Комбайн, id 4550 + 4551 +"harvesterModel": "", ~/~/ Модель комбайна 4552 + 4553 + "hopperCapacity": 0, ~/~/ Объем бункера м3 4554 + 4555 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4556 + 4557 + "events": [ ~/~/Список событий в разрезе комбайна 4558 + 4559 + { 4560 + 4561 + "driverId": "", ~/~/Идентификатор водителя 4562 + 4563 + "driverName": "", ~/~/Водитель комбайна, ФИО 4564 + 4565 + "RFID": "", ~/~/ идентификатор карты-метки 4566 + 4567 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4568 + 4569 + "vehicleId": 0, ~/~/идентификатор объекта 4570 + 4571 + "vehicleName": "string", ~/~/ Имя объекта 4572 + 4573 + "modelName": "string", ~/~/ Имя модели объекта 4574 + 4575 + "nearestVehicles": [ ~/~/Объекты рядом 4576 + 4577 + { 4578 + 4579 + "vehicleId": 0, ~/~/идентификатор объекта 4580 + 4581 + "vehicleName": "string" ~/~/ Имя объекта 4582 + 4583 + } 4584 + 4585 + ], 4586 + 4587 + "fields": [ ~/~/Поля, где происходила выгрузка 4588 + 4589 + { 4590 + 4591 + "id": 0, ~/~/ идентификатор пользователя 4592 + 4593 + "name": "string" ~/~/ имя пользователя 4594 + 4595 + } 4596 + 4597 + ], 4598 + 4599 + "event": "string", ~/~/Событие 4600 + 4601 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4602 + 4603 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4604 + 4605 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4606 + 4607 + "cultureName": "string", ~/~/ название культуры 4608 + 4609 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4610 + 4611 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4612 + 4613 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4614 + 4615 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4616 + 4617 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4618 + 4619 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4620 + 4621 + "issued": 0, ~/~/Выдано, бункеров 4622 + 4623 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4624 + 4625 + "latitude": 0, ~/~/Широта 4626 + 4627 + "longitude": 0, ~/~/ Долгота 4628 + 4629 + "litresAway": 0, ~/~/Отдано, л 4630 + 4631 + "m3Away": 0 ~/~/Отдано, м3 4632 + 4633 + } 4634 + 4635 + ] 4636 + 4637 + } 4638 + 4639 +] 4640 + 4641 + 4642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4643 + 4644 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4645 + 4646 + 4647 +(% class="box infomessage" %) 4648 +((( 4649 +GET api/v3/Vehicles/recyclebin/all 4650 +))) 4651 + 4652 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4653 + 4654 +Параметр запроса: {parentId} - идентификатор агента 4655 + 4656 +В заголовках запроса: X-Auth: Токен авторизации 4657 + 4658 +Ответ: 4659 + 4660 +[ 4661 + 4662 + { 4663 + 4664 + "recordTime": "", ~/~/Время записи 4665 + 4666 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4667 + 4668 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4669 + 4670 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4671 + 4672 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4673 + 4674 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4675 + 4676 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4677 + 4678 + "items": [ ~/~/ [ 4679 + 4680 +nullable: true ~/~/Детали 4681 + 4682 + { 4683 + 4684 + "name": "string", ~/~/наименование столбца 4685 + 4686 + "value": "string" ~/~/содержание столбца 4687 + 4688 + } 4689 + 4690 + ] 4691 + 4692 + }, 4693 + 4694 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4695 + 4696 + "string" 4697 + 4698 + ] 4699 + 4700 + } 4701 + 4702 +] 4703 + 4704 + 4705 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4706 + 4707 +(% class="box infomessage" %) 4708 +((( 4709 +POST/api/v3/Vehicles/recyclebin/erase 4710 +))) 4711 + 4712 +В заголовках запроса: X-Auth: Токен авторизации 4713 + 4714 +Пример запроса: 4715 + 4716 + 4717 +[ 4718 + 4719 + 0 4720 + 4721 +] 4722 + 4723 + 4724 +Пример ответа: 4725 + 4726 +[ 4727 + 4728 + { 4729 + 4730 + "recordTime": "", ~/~/Время записи 4731 + 4732 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4733 + 4734 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4735 + 4736 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4737 + 4738 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4739 + 4740 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4741 + 4742 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4743 + 4744 + "items": [ ~/~/Детали 4745 + 4746 + { 4747 + 4748 + "name": "", ~/~/Имя свойства 4749 + 4750 + "value": "" ~/~/Значение свойства 4751 + 4752 + } 4753 + 4754 + ] 4755 + 4756 + }, 4757 + 4758 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4759 + 4760 + "" 4761 + 4762 + ] 4763 + 4764 + } 4765 + 4766 +] 4767 + 4768 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4769 + 4770 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4771 + 4772 +(% class="box infomessage" %) 4773 +((( 4774 +POST/api/v3/Vehicles/recyclebin/restore 4775 +))) 4776 + 4777 +В заголовках запроса: X-Auth: Токен авторизации 4778 + 4779 +Параметры в теле запроса (JSON): 4780 + 4781 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4782 + 4783 +В заголовках запроса: X-Auth: Токен авторизации 4784 + 4785 + 4786 +Пример запроса: 4787 + 4788 +[ 4789 + 4790 + 0 4791 + 4792 +] 4793 + 4794 + 4795 +Пример ответа: 4796 + 4797 +[ 4798 + 4799 + { 4800 + 4801 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4802 + 4803 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4804 + 4805 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4806 + 4807 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4808 + 4809 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4810 + 4811 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4812 + 4813 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4814 + 4815 + "items": [ ~/~/Детали 4816 + 4817 + { 4818 + 4819 + "name": "string", ~/~/Имя свойства 4820 + 4821 + "value": "string" ~/~/Значение свойства 4822 + 4823 + } 4824 + 4825 + ] 4826 + 4827 + }, 4828 + 4829 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4830 + 4831 + "string" 4832 + 4833 + ] 4834 + 4835 + } 4836 + 4837 +] 4838 + 4839 + 4840 + 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% 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]] **