Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
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,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 47 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 53 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 54 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 55 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 56 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 57 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 58 + 59 +(% class="wikigeneratedid" %) 60 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 61 + 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" ~/~/ Корр. счет101 + "agentId": "", (%%) 102 + "parentId": "", 103 + "parentName": "string", 104 + "name": "string", 105 + "fullName": "string", 106 + "agentInfoType": 0, 107 + "isForeign": true/false, 108 + "district": "string", 109 + "region": "string", 110 + "city": "string", 111 + "inn": "string", 112 + "kpp": "string", 113 + "address": "string", 114 + "addressFact": "string", 115 + "email": "string", 116 + "director": "string", 117 + "bankName": "string", 118 + "bankBIK": "string", 119 + "bankRS": "string", 120 + "bankKS": "string" 118 118 } 119 119 123 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 124 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 125 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 126 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 127 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 128 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 129 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 130 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 131 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 132 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 133 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 134 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 135 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 136 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 137 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 138 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 139 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 140 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 141 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 142 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 143 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 144 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».158 +(% 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 - Отказ) 173 + "agentId": "",(% style="color:#000000" %) (%%) 174 + "parentId": "", 175 + "name": "string", 176 + "fullName": "string", 177 + "agentInfoType": 0, 178 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 181 + 182 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 183 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 184 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 185 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 186 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 187 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 188 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 189 + 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 - 208 + "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 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 253 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 254 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 255 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 256 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 257 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 258 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 259 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 260 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 261 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 262 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 263 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 264 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 265 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 266 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 267 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 268 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 269 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 270 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 271 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 272 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 273 + 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 355 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 356 + 357 +(% class="box warningmessage" %) 358 +((( 359 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 360 +))) 361 + 362 +Метод позволяет изменить статус клиента, указанного в запросе. 363 + 364 +В пути указывается GUID клиента и статус клиента. 365 + 366 +**status **- значение 0 - заблокирован, 1 - активен. 367 + 368 +Ответ: Code 204 369 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 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 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 434 +{ 435 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 474 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 593 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 600 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 643 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 668 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -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" %)Скорость выгрузки из бункера, л/сек 777 +|(% 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 874 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 875 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 876 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 877 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 878 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 879 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 880 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 881 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 882 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 883 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 884 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 885 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 886 +|(% 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 941 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 942 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 943 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 944 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 945 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 946 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 947 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 948 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 949 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 950 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 951 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 952 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 953 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 954 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,8 +1094,7 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1148 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1103,7 +1103,6 @@ 1103 1103 "additionalInfo": "string" 1104 1104 } 1105 1105 ] 1106 - 1107 1107 } 1108 1108 ))) 1109 1109 ... ... @@ -1113,6 +1113,56 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1165 + 1166 +== **Получить ответ на отправленную на ТС команду** == 1167 + 1168 +(% class="box infomessage" %) 1169 +((( 1170 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1171 +))) 1172 + 1173 +Идентификатор команды: cmdid 1174 + 1175 +Запрос от терминала на ответ команды 1176 + 1177 +Пример ответ от терминала: 1178 + 1179 +ID= "" ~/~/ идентификатор произвольного поля 1180 +Soft="" ~/~/ версия софта 1181 +GPS=4 ~/~/ тип трекера 1182 +Time=11:05:43 28.06.24 ~/~/ время запроса 1183 +Lat=45.056221 ~/~/ широта 1184 +Lon=39.035938 ~/~/ долгота 1185 +Speed=0.0 ~/~/ скорость 1186 +Course=181.4 ~/~/направление 1187 + 1188 +((( 1189 +== **Список отправленных объекту команд с ответами** == 1190 + 1191 +(% class="box infomessage" %) 1192 +((( 1193 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1194 +))) 1195 + 1196 +Идентификатор ТС: vehicleId 1197 + 1198 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1199 + 1200 +Пример ответа терминала 1201 + 1202 +[ 1203 +{ 1204 +"id": "", ~/~/ идентификатор пользователя 1205 +"commandText": "", ~/~/Текст команды. 1206 +"templateId": "", ~/~/Идентификатор шаблона 1207 +"updated": "", ~/~/ Время отправки 1208 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1209 +"answer": "", ~/~/ Ответ терминала. 1210 +"status": "" ~/~/ Статус отправки 1211 +} 1212 +] 1213 +))) 1214 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1130,8 +1130,7 @@ 1130 1130 1131 1131 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1132 1132 1133 -(% style="color:#000000" %){ 1134 - 1232 +(% style="color:#000000" %){(%%) 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1299 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1239,29 +1239,17 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 1266 "summaryMaxValue": 0 ~/~/ Макс. значение 1267 1267 } ... ... @@ -1280,8 +1280,7 @@ 1280 1280 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 - 1366 +(% style="color:#000000" %){(%%) 1285 1285 "vehicleId": "", ~/~/ID ТС 1286 1286 "parentId": "", ~/~/Guid владельца ТС 1287 1287 "name": "", ~/~/Имя объекта ... ... @@ -1319,8 +1319,6 @@ 1319 1319 "kind": "", ~/~/ Вид периодичности по времени 1320 1320 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1321 1321 } 1322 - 1323 -(% style="text-align:left" %) 1324 1324 (% style="color:#000000" %)} 1325 1325 1326 1326 **Валидация:** ... ... @@ -1335,7 +1335,7 @@ 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1418 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1379,8 +1379,7 @@ 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 1381 (% style="color:#000000" %){ 1382 - 1383 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1462 + "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта 1386 1386 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1525 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,26 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1534 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1535 +**Отправить команду на терминал** 1536 + 1537 +(% class="box successmessage" %) 1538 +((( 1539 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1540 +))) 1541 + 1542 +Команда для отправки на тс. 1543 + 1544 +{ 1545 +"id": "", ~/~/идентификатор произвольного поля 1546 +"command": "", ~/~/ Текст команды 1547 +"retries": "", ~/~/ Количество попыток 1548 +"idTemplate": "" ~/~/ ID шаблона команды 1549 +} 1550 + 1551 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1639 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1582,29 +1582,17 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1610 1610 } ... ... @@ -1624,9 +1624,7 @@ 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 1626 (% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1628 - 1629 -(% lang="en-US" style="text-align:left" %) 1707 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1630 1630 "vehicleId": "", ~/~/ ID ТС 1631 1631 "parentId": "", ~/~/ ID клиента 1632 1632 "name": "", ~/~/ имя ТС ... ... @@ -1667,8 +1667,6 @@ 1667 1667 "kind": "", ~/~/ Вид периодичности по времени 1668 1668 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1669 1669 } 1670 - 1671 -(% lang="en-US" style="text-align:left" %) 1672 1672 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1673 1673 1674 1674 **Валидация:** ... ... @@ -1709,18 +1709,15 @@ 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]]1788 +(% 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 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 1794 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 1818 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 1865 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1866 + 1867 +(% class="box infomessage" style="text-align: left;" %) 1868 +((( 1869 +**POST /api/v3/terminalMessages/mapping** 1870 +))) 1871 + 1872 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1873 + 1874 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1875 + 1876 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1877 + 1878 +{ 1879 + "protocolType": 0, 1880 + "params": ["string"] 1881 +} 1882 + 1883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1884 +|protocolType|ID типа протокола 1885 +|params|((( 1886 +Массив наименований параметров в сообщении 1887 +))) 1888 + 1889 +Ответ: 1890 + 1891 +{ 1892 + "protocolType": 0, 1893 + "mapping": { 1894 + "additionalProp1": { 1895 + "inputType": 0, 1896 + "inputNumber": 0 1897 + }, 1898 + "additionalProp2": { 1899 + "inputType": 0, 1900 + "inputNumber": 0 1901 + } 1902 + } 1903 +} 1904 + 1905 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1906 +|protocolType|Тип протокола 1907 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1908 +|inputNumber|((( 1909 +Номер входа 1910 +))) 1911 + 1912 +(% class="wikigeneratedid" %) 1913 +Перечень 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/]] 1914 + 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 1939 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1940 +|vehicleId|ID объекта 1941 +|from|Дата и время начала периода запроса 1942 +|to|Дата и время окончания периода запроса 1943 + 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": { ~/~/ список параметров датчиков передаваемых терминалом 1950 + "deviceTime": "2023-11-29T07:40:44.052Z", 1951 + "serverTime": "2023-11-29T07:40:44.052Z", 1952 + "speed": 0, 1953 + "altitude": 0, 1954 + "latitude": 0, 1955 + "longitude": 0, 1956 + "satellites": 0, 1957 + "course": 0, 1958 + "voltage": 0, 1959 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 1964 + "photoCount": 0, 1965 + "lbsCorrectedCoords": true, 1966 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1972 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1973 +|deviceTime|Время сообщения терминала 1974 +|serverTime|Время когда сообщение поступило на сервер 1975 +|speed|Скорость 1976 +|altitude|Высота над уровнем моря 1977 +|latitude|Широта 1978 +|longitude|Долгота 1979 +|satellites|Кол-во спутников 1980 +|course|Курс 1981 +|voltage|Бортовое напряжение 1982 +|parameters|Список параметров и их значений 1983 +|photoCount|Количество фото 1984 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1985 +|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,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2120 + 2121 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2122 + 2123 +(% class="box infomessage" %) 2124 +((( 2125 +**POST /api/v3/vehicles/moveStop** 2126 +))) 2127 + 2128 +Метод запроса: **POST** 2129 + 2130 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2131 + 2132 +В заголовках запроса: X-Auth: Токен авторизации 2133 + 2134 + 2135 +Тело запроса: 2136 + 2137 +{ 2138 + "vehicleIds": [ ], ~/~/ Список ID объектов 2139 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2140 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2141 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2142 +} 2143 + 2144 +Ответ: 2145 + 2146 +[ 2147 + { 2148 + "vehicleId": 0, ~/~/ ID объекта 2149 + "vehicleName": "string", ~/~/ Имя объекта 2150 + "moves": [ ~/~/ Событие движения 2151 + { 2152 + "mileage": 0, ~/~/ Пробег, км 2153 + "eventId": 0, ~/~/ Идентификатор события 2154 + "eventName": "string", ~/~/ Название события 2155 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2156 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2157 + "duration": 0 ~/~/ Продолжительность события, секунд 2158 + } 2159 + ], 2160 + "stops": [ ~/~/ События стоянок 2161 + { 2162 + "address": "string", ~/~/ Адрес события 2163 + "eventId": 0, ~/~/ Идентификатор события 2164 + "eventName": "string", ~/~/ Название события 2165 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2166 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2167 + "duration": 0 ~/~/ Продолжительность события, секунд 2168 + } 2169 + ] 2170 + } 2171 +] 2172 + 2173 + 2174 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2175 + 2176 +(% class="box infomessage" %) 2177 +((( 2178 +**POST /api/v3/vehicles/getlastdata** 2179 +))) 2180 + 2181 +Метод запроса: **POST** 2182 + 2183 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2184 + 2185 +В заголовках запроса: X-Auth: Токен авторизации 2186 + 2187 + 2188 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2189 + 2190 +Ответ: 2191 + { 2192 + "vehicleId": 0, ~/~/Идентификатор объекта. 2193 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2194 + "vehicleNumber": "string",~/~/Номер объекта. 2195 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2196 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2197 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2198 + "speed": 0,~/~/Скорость объекта. 2199 + "course": 0,~/~/Курс движения [0;360] 2200 + "latitude": 0,~/~/Широта [-90°;90°]. 2201 + "longitude": 0,~/~/Долгота [-180°;180°]. 2202 + "address": "string",~/~/Адрес. 2203 + "geozones": [ ~/~/Сведения по геозонам. 2204 + { 2205 + "id": 0, 2206 + "name": "string" 2207 + } 2208 + 2209 + 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 3108 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3109 + 3110 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3111 + 3112 +(% class="box infomessage" %) 3113 +((( 3114 +**POST /api/v3/Trailers** 3115 +))) 3116 + 3117 +Пример запроса: 3118 + 3119 +{ 3120 + "startDate": "2023-11-14T10:48:03.671Z", 3121 + "endDate": "2023-11-14T10:48:03.671Z", 3122 + "ids": [ 0 ], 3123 + "timezone": 0 3124 +} 3125 + 3126 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3127 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3128 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3129 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3130 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3131 + 3132 +Пример ответа: 3133 + 3134 +[ 3135 + { 3136 + "SD": "2023-11-14T10:48:03.717Z", 3137 + "ED": "2023-11-14T10:48:03.717Z", 3138 + "id": 0, 3139 + "SLat": 0, 3140 + "SLon": 0, 3141 + "ELat": 0, 3142 + "ELon": 0, 3143 + "mileage": 0 3144 + "Duration": 0 3145 + "Address": "string", 3146 + "Address2": "string", 3147 + "name": "string", 3148 + "rid": "string", 3149 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3150 + "trailer": { 3151 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3152 + "Number": "string", 3153 + "Description": "string", 3154 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3155 + "ExternalID": "string", 3156 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3157 + "CreateTime": "2023-11-14T10:48:03.717Z", 3158 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3159 + "IsDeleted": true 3160 + }, 3161 + "filesCount": 0, 3162 + } 3163 +] 3164 + 3165 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3166 +|SD|Дата и время начала события 3167 +|ED|Дата и время окончания события 3168 +|id|ID объекта 3169 +|SLat|Широта начальной координаты 3170 +|SLon|Долгота начальной координаты 3171 +|ELat|Широта конечной координаты 3172 +|ELon|Долгота конечной координаты 3173 +|mileage|Пробег 3174 +|Duration|Продолжительность 3175 +|Address|Адрес начального местоположения 3176 +|Address2|Адрес конечного местоположения 3177 +|name|Имя радиометки 3178 +|rid|Номер радиометки 3179 +|rguid|ID радиометки 3180 +|trailer|Информация об агрегате 3181 +|ModelGuid|ID агрегата 3182 +|Number|Название/номер агрегата 3183 +|Description|Текст примечания агрегата 3184 + 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, ~/~/ Частота трансляции радиометки3206 + "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 3212 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3213 +|parentId|ID клиента 3214 +|name|Название карты-метки 3215 +|number|Номер 3216 +|period|Период запросов в секундах (работает только для агрегатов) 3217 +|id|ID карты-метки 3218 + 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, ~/~/ Частота трансляции радиометки3234 + "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 3240 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3241 +|name|Название карты-метки 3242 +|number|Номер 3243 +|period|Период запросов в секундах (работает только для агрегатов) 3244 +|id|ID карты-метки 3245 +|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 3273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3274 +|name|Название карты-метки 3275 +|number|Номер 3276 +|period|Период запросов в секундах (работает только для агрегатов) 3277 +|id|ID карты-метки 3278 +|parentId|ID клиента 3279 + 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 3307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3308 +|name|Название карты-метки 3309 +|number|Номер 3310 +|period|Период запросов в секундах (работает только для агрегатов) 3311 +|id|ID карты-метки 3312 +|parentId|ID клиента 3313 + 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 - идентификатор карты-метки 3321 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 3562 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3563 + 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 3577 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3578 + 3579 +(% class="box warningmessage" %) 3580 +((( 3581 +**PUT /api/v3/billing/client/balance/deposit** 3582 +))) 3583 + 3584 +Создает операцию **Пополнение **с указанной суммой 3585 + 3586 +Тело запроса: 3587 + 3588 +{ 3589 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3590 + "Balance": 0 3591 +} 3592 + 3593 +Ответ: Success 3594 + 3595 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3596 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3597 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3598 + 3599 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3600 + 3601 +Создает операцию **Списание **с указанной суммой 3602 + 3603 +(% class="box warningmessage" %) 3604 +((( 3605 +**PUT /api/v3/billing/client/balance/withdraw** 3606 +))) 3607 + 3608 +Тело запроса: 3609 + 3610 +{ 3611 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3612 + "Balance": 0 3613 +} 3614 + 3615 +Ответ: Success 3616 + 3617 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3618 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3619 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3620 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3368,6 +3368,743 @@ 3368 3368 |PeriodValue|Значение периода. 3369 3369 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 3370 3693 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3694 + 3695 +(% class="box warningmessage" %) 3696 +((( 3697 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3698 +))) 3699 + 3700 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3701 + 3702 +(% class="box infomessage" %) 3703 +((( 3704 +**POST /api/v3/vehicles/import/{agentId}** 3705 +))) 3706 + 3707 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3708 + 3709 +В пути указывается **agentId** - id клиента. 3710 + 3711 +**Заголовок** 3712 + 3713 +**X-Auth: [токен авторизации]** 3714 + 3715 +**Параметры** 3716 + 3717 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3718 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3719 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3720 + 3721 +В теле использовать тип **form-data,** тип значения** file** 3722 + 3723 +**Ключи** 3724 + 3725 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3726 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3727 +|csv|В значении передаем файл датчиков, формат **csv** 3728 + 3729 +Ответ: 3730 + 3731 +{ 3732 + "vehicleId": 0, 3733 + "name": "string", 3734 + "errors": ["string"] 3735 +} 3736 + 3737 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3738 +|vehicleId|ID созданного объекта 3739 +|name|Имя созданного объекта 3740 +|errors|Ошибки и их описание 3741 + 3742 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3743 + 3744 +(% class="box infomessage" %) 3745 +((( 3746 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3747 +))) 3748 + 3749 +(% class="wikigeneratedid" %) 3750 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3751 + 3752 +(% class="wikigeneratedid" %) 3753 +В пути указывается **vehicleId **- id объекта. 3754 + 3755 +**Заголовок** 3756 + 3757 +**X-Auth: [токен авторизации]** 3758 + 3759 +В теле использовать тип **form-data.** 3760 + 3761 +Ключи: 3762 + 3763 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3764 +|**history**|В значении передавать файл с историей 3765 + 3766 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3767 + 3768 +Ответ: 3769 + 3770 +{ 3771 + "results": [ 3772 + { 3773 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3774 + "vehicleId": 0, 3775 + "errors": [ 3776 + "string" 3777 + ], 3778 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3779 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3780 + "producedCount": 0, 3781 + "msgCount": 0 3782 + } 3783 + ] 3784 +} 3785 + 3786 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3787 +|results|Результаты импорта в разрезе ТС 3788 +|vehicleGuid|Guid ТС 3789 +|vehicleId|ID ТС 3790 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3791 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3792 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3793 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3794 +|msgCount|Кол-во обработанных сообщений всего 3795 + 3796 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3797 + 3798 +(% class="box infomessage" %) 3799 +((( 3800 +**GET /api/v3/vehicles/import/history/status** 3801 +))) 3802 + 3803 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3804 + 3805 +Ответ: 3806 + 3807 +{ 3808 + "activity": true, 3809 + "progress": 0, 3810 + "message": "string" 3811 +} 3812 + 3813 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3814 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3815 +|progress|Guid ТС 3816 + 3817 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3818 + 3819 +(% class="box infomessage" %) 3820 +((( 3821 +**POST /api/v3/vehicles/export** 3822 +))) 3823 + 3824 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3825 + 3826 +Тело запроса: 3827 + 3828 +[ 3829 + id 3830 +] 3831 + 3832 +Ответ: Success 200, получаете файлы с настройками. 3833 + 3834 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3835 + 3836 +(% class="box infomessage" %) 3837 +((( 3838 +**POST /api/v3/vehicles/export/history** 3839 +))) 3840 + 3841 +Метод возвращает список сообщений терминала объекта за выбранный период. 3842 + 3843 +Тело запроса: 3844 + 3845 +{ 3846 + "vehicleId": 0, 3847 + "asArchive": true, 3848 + "from": "2023-09-27T12:17:45.973Z", 3849 + "to": "2023-09-27T12:17:45.973Z" 3850 +} 3851 + 3852 +Ответ: 3853 + 3854 +Получаете файл. Сообщение: Code 200/Success 3855 + 3856 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3857 +|vehicleId|ID объекта 3858 +|asArchive|true - Архивировать файл, False - не архивировать 3859 +|from|Дата и время начала запроса 3860 +|to|Дата и время окончания запроса 3861 + 3862 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3863 + 3864 +(% class="box infomessage" %) 3865 +((( 3866 +**GET /api/v3/vehicles/export/history/status** 3867 +))) 3868 + 3869 +Метод возвращает список сообщений терминала объекта за выбранный период. 3870 + 3871 +Ответ: 3872 + 3873 +{ 3874 + "activity": true, 3875 + "progress": 0, 3876 + "message": "string" 3877 +} 3878 + 3879 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3880 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3881 +|progress|Прогресс экспорта, от 0 до 100% 3882 +|message|Текст описывающий статус 3883 + 3884 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3885 + 3886 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3887 + 3888 +(% class="box infomessage" %) 3889 +((( 3890 +**POST /api/v3/EcoDriving/rating** 3891 +))) 3892 + 3893 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3894 + 3895 +Тело запроса: 3896 + 3897 +{ 3898 + "vehicleIds": [vehicleId], 3899 + "from": "2023-11-22T09:29:48.051Z", 3900 + "to": "2023-11-22T09:29:48.051Z" 3901 +} 3902 + 3903 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3904 +|vehicleIds|Массив ID объектов 3905 +|from|Дата начала запроса 3906 +|to|Дата окончания запроса 3907 + 3908 +Ответ: 3909 + 3910 +{ 3911 + "items": [ 3912 + { 3913 + "from": "2023-11-22T09:29:48.052Z", 3914 + "to": "2023-11-22T09:29:48.052Z", 3915 + "vehicleId": 0, 3916 + "vehicleName": "string", 3917 + "vehicleModel": "string", 3918 + "penalty": 0, 3919 + "score": 0, 3920 + "totalViolations": 0, 3921 + "violationsByType": { 3922 + "overspeedingViolations": 0, 3923 + "accelerationViolations": 0, 3924 + "brakingViolations": 0, 3925 + "turningViolations": 0, 3926 + "dangerousDrivingViolations": 0, 3927 + "sensorViolations": 0 3928 + }, 3929 + "moveTime": 0, 3930 + "mileage": 0, 3931 + "tripsCount": 0, 3932 + "trips": [ 3933 + { 3934 + "penalty": 0, 3935 + "score": 0, 3936 + "violationsCount": 0, 3937 + "violationsByType": { 3938 + "overspeedingViolations": 0, 3939 + "accelerationViolations": 0, 3940 + "brakingViolations": 0, 3941 + "turningViolations": 0, 3942 + "dangerousDrivingViolations": 0, 3943 + "sensorViolations": 0 3944 + }, 3945 + "moveTime": 0, 3946 + "mileage": 0, 3947 + "motohours": 0, 3948 + "maxSpeed": 0, 3949 + "startAddress": "string", 3950 + "endAddress": "string", 3951 + "drivers": [ 3952 + { 3953 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3954 + "driverName": "string", 3955 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3956 + } 3957 + ] 3958 + } 3959 + ] 3960 + } 3961 + ] 3962 +} 3963 + 3964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3965 +|from|Дата начала запроса 3966 +|to|Дата окончания 3967 +|vehicleId|ID объекта 3968 +|vehicleName|Имя объекта 3969 +|vehicleModel|Модель объекта 3970 +|penalty|Сумма штрафных баллов 3971 +|score|Оценка 3972 +|totalViolations|Суммарное количество нарушений 3973 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3974 +|overspeedingViolations|Превышение скорости 3975 +|accelerationViolations|Ускорение 3976 +|brakingViolations|Торможение 3977 +|turningViolations|Резкий поворот 3978 +|dangerousDrivingViolations|Резкое вождение 3979 +|sensorViolations|Нарушение по датчику 3980 +|moveTime|Время в движении 3981 +|mileage|Пробег 3982 +|tripsCount|Количество рейсов 3983 +|motohours|Моточасы 3984 +|maxSpeed|Максимальная скорость 3985 +|startAddress|Адрес начала рейса 3986 +|endAddress|Адрес окончания рейса 3987 +|drivers|Список водителей, которые были на объекте в течениии рейса 3988 +|driverGuid|Guid водителя 3989 +|driverName|Имя водителя 3990 +|driverRfid|Номер Карты-метки 3991 + 3992 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3993 + 3994 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 3995 + 3996 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 3997 + 3998 +(% class="box infomessage" %) 3999 +((( 4000 +POST /api/v3/fuelcards/transactions 4001 +))) 4002 + 4003 +Метод запроса: POST 4004 + 4005 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4006 +\\В заголовках запроса: X-Auth: Токен авторизации 4007 + 4008 +Параметры в теле запроса (JSON): 4009 + 4010 +{ 4011 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4012 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4013 + "ids": [ 4014 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4015 + ], 4016 + "timezone": 0 ~/~/Таймзона 4017 +} 4018 + 4019 + 4020 +Ответ: 4021 + { 4022 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4023 + "driver": "string", ~/~/Водители, привязанные к ТК 4024 + "object": "string", ~/~/Наименование ТС 4025 + "amount": 0, ~/~/Количество топлива 4026 + "amountDut": 0, ~/~/Количество по ДУТ 4027 + "amountDiff": 0, ~/~/Разница, л 4028 + "amountDiffPerc": 0, ~/~/Разница, % 4029 + "summa": 0, ~/~/Стоимость, руб 4030 + "serviceName": "string", ~/~/Тип топлива 4031 + "price": 0, ~/~/Цена за литр, руб 4032 + "cardName": "string", ~/~/Наименование ТК 4033 + "cardNum": "string", ~/~/Номер ТК 4034 + "operator": "string", ~/~/Оператор ТК 4035 + "address": "string" ~/~/Адрес АЗС 4036 + } 4037 + 4038 + 4039 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4040 + 4041 + 4042 +== **Получение полных данных о ретрансляторе** == 4043 + 4044 +(% class="box infomessage" %) 4045 +((( 4046 +**GET ** **/api/v3/retranslations/{id}** 4047 +))) 4048 + 4049 +Идентификатор запроса: ID 4050 + 4051 + 4052 +Пример ответа: 4053 + 4054 +{ 4055 +"description": "", ~/~/ Определяет описание 4056 +"subscriberId": "", ~/~/ Подписчик 4057 +"protocolType": 0, ~/~/ Тип протокола 4058 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4059 +"address": "string", ~/~/ Адрес события 4060 +"objects": [ ~/~/Объекты для ретрансляции 4061 +{ 4062 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4063 +"name": "", ~/~/ Наименование объекта ретрансляции 4064 +"imei": "", ~/~/ IMEI объекта 4065 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4066 +} 4067 + ], 4068 +"id": "", ~/~/ идентификатор пользователя 4069 +"parentId": "", ~/~/Guid родителя 4070 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4071 +} 4072 + 4073 + 4074 +== **Удаление данных ретранслятора** == 4075 + 4076 +(% class="box infomessage" %) 4077 +((( 4078 +**DELETE** **/api/v3/retranslations/{id}** 4079 +))) 4080 + 4081 +Параметр запроса: ID 4082 + 4083 + 4084 +== **Создание ретранслятора** == 4085 + 4086 +(% class="box infomessage" %) 4087 +((( 4088 +**POST ** **/api/v3/retranslations/{id}** 4089 +))) 4090 + 4091 +Запрос: 4092 + 4093 +{ 4094 +"description": "", ~/~/ Описание 4095 +"subscriberId": "", ~/~/ Подписчик 4096 +"protocolType": 0, ~/~/ Тип протокола 4097 +"address": "", ~/~/ Адрес ретрансляции 4098 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4099 +"objects": [ ~/~/Объекты для ретрансляции 4100 +{ 4101 +"id": "", ~/~/ идентификатор пользователя 4102 +"imei": "", ~/~/IMEI объекта 4103 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4104 +} 4105 + ] 4106 +} 4107 + 4108 + 4109 +Ответ: 4110 + 4111 +{ 4112 +"description": "string", ~/~/ Определяет описание 4113 +"subscriberId": "", ~/~/ идентификатор запроса 4114 +"protocolType": 0, ~/~/ Тип протокола 4115 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4116 +"address": "", ~/~/ Адрес события 4117 +"objects": [ ~/~/Объекты для ретрансляции 4118 +{ 4119 +"id": "", ~/~/ идентификатор пользователя 4120 +"name": "string", ~/~/ Название уведомления 4121 +"imei": "string", ~/~/IMEI объекта 4122 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4123 +} 4124 + ], 4125 +"id": "", ~/~/ идентификатор пользователя 4126 +"parentId": "", ~/~/ Guid идентификатор родителя 4127 +"deleted": true ~/~/ Признак удаления 4128 +} 4129 + 4130 + 4131 +== **Редактирование ретранслятора** == 4132 + 4133 +(% class="box infomessage" %) 4134 +((( 4135 +**PUT** **/api/v3/retranslations** 4136 +))) 4137 + 4138 +Пример запроса: 4139 + 4140 +{ 4141 +"id": "", ~/~/ идентификатор пользователя 4142 +"description": "string", ~/~/ Определяет описание 4143 +"subscriberId": "", ~/~/ идентификатор запроса 4144 +"protocolType": 0, ~/~/ Тип протокола 4145 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4146 +"address": "string", ~/~/ Адрес события 4147 +"objects": ~/~/Объекты для ретрансляции 4148 +[ 4149 +{ 4150 +"id": "", ~/~/ идентификатор пользователя 4151 +"imei": "", ~/~/IMEI объекта 4152 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4153 +} 4154 + ] 4155 +} 4156 + 4157 + 4158 +Пример ответа: 4159 + 4160 +{ 4161 +"description": "", ~/~/ Определяет описание 4162 +"subscriberId": "", ~/~/ идентификатор запроса 4163 +"protocolType": 0, ~/~/ Тип протокола 4164 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4165 +"address": "string", ~/~/ Адрес события 4166 +"objects": [ ~/~/Объекты для ретрансляции 4167 +{ 4168 +"id": "", ~/~/ идентификатор пользователя 4169 +"name": "string", ~/~/ Название уведомления 4170 +"imei": "", ~/~/IMEI объекта 4171 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4172 +} 4173 + ], 4174 +"id": "", ~/~/ идентификатор пользователя 4175 +"parentId": "", ~/~/ Guid идентификатор родителя 4176 +"deleted": true ~/~/ Признак удаления 4177 +} 4178 + 4179 + 4180 +== **Получение списка ретранслятора клиента** == 4181 + 4182 +(% class="box infomessage" %) 4183 +((( 4184 +**POST /api/v3/retranslations/find** 4185 +))) 4186 + 4187 +Пример запроса: 4188 + 4189 +{ 4190 +"id": "", ~/~/ идентификатор пользователя 4191 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4192 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4193 +} 4194 + 4195 +Ответ: 4196 + 4197 +[ 4198 +{ 4199 +"description": "", ~/~/ Определяет описание 4200 +"subscriberId": "", ~/~/ идентификатор запроса 4201 +"protocolType": 0, ~/~/ Тип протокола 4202 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4203 +"address": "string", ~/~/ Адрес события 4204 +"id": "", ~/~/ идентификатор пользователя 4205 +"parentId": "", ~/~/ Guid идентификатор родителя 4206 +"deleted": true ~/~/ Признак удаления 4207 +} 4208 +] 4209 + 4210 + 4211 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4212 + 4213 +== **API для отчета по выгрузке комбайнов** == 4214 + 4215 +(% class="box infomessage" %) 4216 +((( 4217 +POST **/api/v3/Reports/harvesterUnloading** 4218 +))) 4219 + 4220 +Пример запроса: 4221 + 4222 +{ 4223 + "byTime": 0, ~/~/ Объединение событий по времени 4224 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4225 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4226 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4227 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4228 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4229 + 0 4230 + ], 4231 + "from": "", ~/~/ Дата и время начало запроса 4232 + "to": "", ~/~/ Дата и время окончания запроса 4233 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4234 +} 4235 + 4236 +Пример ответа: 4237 + 4238 +[ 4239 + { 4240 + "harvesterName": "", ~/~/Комбайн, номер 4241 + "harvesterId": 0, ~/~/Комбайн, id 4242 +"harvesterModel": "", ~/~/ Модель комбайна 4243 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4244 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4245 + "events": [ ~/~/Список событий в разрезе комбайна 4246 + { 4247 + "driverId": "", ~/~/Идентификатор водителя 4248 + "driverName": "", ~/~/Водитель комбайна, ФИО 4249 + "RFID": "", ~/~/ идентификатор карты-метки 4250 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4251 + "vehicleId": 0, ~/~/идентификатор объекта 4252 + "vehicleName": "string", ~/~/ Имя объекта 4253 + "modelName": "string", ~/~/ Имя модели объекта 4254 + "nearestVehicles": [ ~/~/Объекты рядом 4255 + { 4256 + "vehicleId": 0, ~/~/идентификатор объекта 4257 + "vehicleName": "string" ~/~/ Имя объекта 4258 + } 4259 + ], 4260 + "fields": [ ~/~/Поля, где происходила выгрузка 4261 + { 4262 + "id": 0, ~/~/ идентификатор пользователя 4263 + "name": "string" ~/~/ имя пользователя 4264 + } 4265 + ], 4266 + "event": "string", ~/~/Событие 4267 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4268 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4269 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4270 + "cultureName": "string", ~/~/ название культуры 4271 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4272 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4273 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4274 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4275 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4276 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4277 + "issued": 0, ~/~/Выдано, бункеров 4278 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4279 + "latitude": 0, ~/~/Широта 4280 + "longitude": 0, ~/~/ Долгота 4281 + "litresAway": 0, ~/~/Отдано, л 4282 + "m3Away": 0 ~/~/Отдано, м3 4283 + } 4284 + ] 4285 + } 4286 +] 4287 + 4288 + 4289 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4290 + 4291 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4292 + 4293 + 4294 +(% class="box infomessage" %) 4295 +((( 4296 +GET api/v3/Vehicles/recyclebin/all 4297 +))) 4298 + 4299 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4300 + 4301 +Параметр запроса: {parentId} - идентификатор агента 4302 + 4303 +В заголовках запроса: X-Auth: Токен авторизации 4304 + 4305 +Ответ: 4306 + 4307 +[ 4308 + { 4309 + "recordTime": "", ~/~/Время записи 4310 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4311 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4312 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4313 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4314 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4315 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4316 + "items": [ ~/~/ 4317 +nullable: true ~/~/Детали 4318 + { 4319 + "name": "string", ~/~/наименование столбца 4320 + "value": "string" ~/~/содержание столбца 4321 + } 4322 + ] 4323 + }, 4324 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4325 + "string" 4326 + ] 4327 + } 4328 +] 4329 + 4330 + 4331 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4332 + 4333 +(% class="box infomessage" %) 4334 +((( 4335 +POST/api/v3/Vehicles/recyclebin/erase 4336 +))) 4337 + 4338 +В заголовках запроса: X-Auth: Токен авторизации 4339 + 4340 +Пример запроса: 4341 + 4342 +[ 4343 +0 4344 +] 4345 + 4346 + 4347 +Пример ответа: 4348 + 4349 +[ 4350 +{ 4351 + "recordTime": "", ~/~/Время записи 4352 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4353 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4354 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4355 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4356 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4357 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4358 + "items": [ ~/~/Детали 4359 + { 4360 + "name": "", ~/~/Имя свойства 4361 + "value": "" ~/~/Значение свойства 4362 + } 4363 + ] 4364 + }, 4365 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4366 + "" 4367 + ] 4368 + } 4369 +] 4370 + 4371 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4372 + 4373 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4374 + 4375 +(% class="box infomessage" %) 4376 +((( 4377 +POST/api/v3/Vehicles/recyclebin/restore 4378 +))) 4379 + 4380 +В заголовках запроса: X-Auth: Токен авторизации 4381 + 4382 +Параметры в теле запроса (JSON): 4383 + 4384 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4385 + 4386 +В заголовках запроса: X-Auth: Токен авторизации 4387 + 4388 + 4389 +Пример запроса: 4390 + 4391 +((( 4392 +[ 4393 +))) 4394 + 4395 +((( 4396 + 0 4397 +))) 4398 + 4399 +((( 4400 +] 4401 +))) 4402 + 4403 + 4404 +Пример ответа: 4405 + 4406 +[ 4407 +{ 4408 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4409 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4410 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4411 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4412 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4413 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4414 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4415 + "items": [ ~/~/Детали 4416 + { 4417 + "name": "string", ~/~/Имя свойства 4418 + "value": "string" ~/~/Значение свойства 4419 + } 4420 + ] 4421 + }, 4422 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4423 + "string" 4424 + ] 4425 + } 4426 +] 4427 + 4428 + 4429 + 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]] **