Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
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,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 + 20 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 + 22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 27 +((( 28 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 29 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 30 +))) 22 22 23 -(% class="box infomessage" %)32 +(% 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**__».43 +(% 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" %) 56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 62 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 63 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 64 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 65 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 66 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 67 + 68 +(% class="wikigeneratedid" %) 69 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 70 + 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" ~/~/ Корр. счет110 + "agentId": "", (%%) 111 + "parentId": "", 112 + "parentName": "string", 113 + "name": "string", 114 + "fullName": "string", 115 + "agentInfoType": 0, 116 + "isForeign": true/false, 117 + "district": "string", 118 + "region": "string", 119 + "city": "string", 120 + "inn": "string", 121 + "kpp": "string", 122 + "address": "string", 123 + "addressFact": "string", 124 + "email": "string", 125 + "director": "string", 126 + "bankName": "string", 127 + "bankBIK": "string", 128 + "bankRS": "string", 129 + "bankKS": "string" 118 118 } 119 119 132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 133 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 134 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 135 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 136 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 137 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 138 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 139 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 140 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 141 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 142 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 143 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 144 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 145 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 146 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 147 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 148 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 149 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 150 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 151 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 152 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 153 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».167 +(% 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 - Отказ) 182 + "agentId": "",(% style="color:#000000" %) (%%) 183 + "parentId": "", 184 + "name": "string", 185 + "fullName": "string", 186 + "agentInfoType": 0, 187 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 190 + 191 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 192 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 193 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 194 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 195 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 196 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 197 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 198 + 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 - 217 + "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 261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 262 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 263 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 264 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 265 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 266 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 267 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 268 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 269 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 270 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 271 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 272 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 273 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 274 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 275 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 276 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 277 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 278 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 279 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 280 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 281 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 282 + 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 364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 365 + 366 +(% class="box warningmessage" %) 367 +((( 368 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 369 +))) 370 + 371 +Метод позволяет изменить статус клиента, указанного в запросе. 372 + 373 +В пути указывается GUID клиента и статус клиента. 374 + 375 +**status **- значение 0 - заблокирован, 1 - активен. 376 + 377 +Ответ: Code 204 378 + 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 пользователя 443 +{ 444 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 +} 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 - 483 +(% 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 пользователя 579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 + "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" %) 602 + "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": "" , ~/~/ идентификатор пользователя 609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 + "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» названия группы пользователя 631 +} 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 - 652 +(% 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 - 677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,8 +682,251 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: ** Транспортныесредства**(%%) =740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 742 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 743 + 744 +(% class="box infomessage" %) 745 +((( 746 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 747 +))) 748 + 749 +Метод возвращает полную информацию о модели объекта. 750 + 751 +(% style="color:#000000" %)Метод запроса: **GET** 752 + 753 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 754 + 755 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 756 + 757 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 758 + 759 +(% style="color:#000000" %)Ответ: 760 + 761 +(% style="color:#000000" %){ 762 + "parentName": "string", 763 + "name": "string", 764 + "picture": "string", 765 + "minspeed": 0, 766 + "maxspeed": 0, 767 + "width": 0, 768 + "imbeddedtrailer": true, 769 + "hoppercapacity": 0, 770 + "hopperdischargespeed": 0, 771 + "modelType": 0, 772 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 773 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 774 + "deleted": true 775 +} 776 + 777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 778 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 779 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 780 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 781 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 782 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 783 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 784 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 785 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 786 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 787 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 788 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 789 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 790 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 791 + 792 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 793 + 794 +(% class="box successmessage" %) 795 +((( 796 +(% lang="en-US" %)**POST /api/v3/models/find** 797 +))) 798 + 799 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 800 + 801 +(% style="color:#000000" %)Метод запроса: **POST** 802 + 803 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 804 + 805 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 806 + 807 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 808 + 809 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 810 +} 811 + 812 +(% style="color:#000000" %)Ответ: 813 + 814 +(% style="color:#000000" %)[ 815 + { 816 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 817 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 818 + "parentName": "string", 819 + "name": "string", 820 + "modelType": 0 821 + } 822 +] 823 + 824 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 825 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 826 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 827 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 828 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 829 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 830 + 831 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 832 + 833 +(% class="box successmessage" %) 834 +((( 835 +(% lang="en-US" %)**POST /api/v3/models** 836 +))) 837 + 838 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 839 + 840 +(% style="color:#000000" %)Метод запроса: **POST** 841 + 842 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 843 + 844 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 845 + 846 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 847 + 848 +{ 849 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 + "deleted": true, 852 + "extId": "string", 853 + "name": "string", 854 + "picture": "string", 855 + "minspeed": 0, 856 + "maxspeed": 0, 857 + "width": 0, 858 + "imbeddedtrailer": true, 859 + "fueloutlay": 0, 860 + "hoppercapacity": 0, 861 + "hopperdischargespeed": 0, 862 + "modelType": 0 863 +} 864 + 865 +Ответ: 866 + 867 +{ 868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 869 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 + "deleted": true, 871 + "extId": "string", 872 + "name": "string", 873 + "picture": "string", 874 + "minspeed": 0, 875 + "maxspeed": 0, 876 + "width": 0, 877 + "imbeddedtrailer": true, 878 + "hoppercapacity": 0, 879 + "hopperdischargespeed": 0, 880 + "modelType": 0 881 +} 882 + 883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 884 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 885 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 887 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 888 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 889 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 890 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 891 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 892 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 893 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 894 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 895 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 896 + 897 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 898 + 899 +(% class="box warningmessage" %) 900 +((( 901 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 902 +))) 903 + 904 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 905 + 906 +(% style="color:#000000" %)Метод запроса: **PUT** 907 + 908 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 909 + 910 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 911 + 912 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 913 + 914 +{ 915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 916 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 917 + "deleted": true, 918 + "extId": "string", 919 + "name": "string", 920 + "picture": "string", 921 + "minspeed": 0, 922 + "maxspeed": 0, 923 + "width": 0, 924 + "imbeddedtrailer": true, 925 + "fueloutlay": 0, 926 + "hoppercapacity": 0, 927 + "hopperdischargespeed": 0, 928 + "modelType": 0 929 +} 930 + 931 +Ответ: 932 + 933 +{ 934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 935 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 936 + "deleted": true, 937 + "extId": "string", 938 + "name": "string", 939 + "picture": "string", 940 + "minspeed": 0, 941 + "maxspeed": 0, 942 + "width": 0, 943 + "imbeddedtrailer": true, 944 + "fueloutlay": 0, 945 + "hoppercapacity": 0, 946 + "hopperdischargespeed": 0, 947 + "modelType": 0 948 +} 949 + 950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 951 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 952 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 954 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 955 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 956 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 957 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 958 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 959 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 960 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 961 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 962 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 963 + 964 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 965 + 966 +(% class="box errormessage" %) 967 +((( 968 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 969 +))) 970 + 971 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 972 + 973 +(% style="color:#000000" %)Метод запроса: **DELETE** 974 + 975 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 976 + 977 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 978 + 979 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 980 + 981 +Ответ: В случае успеха **Success 200** 982 + 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 984 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -718,19 +718,15 @@ 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 720 "sim2": "", ~/~/ Номер SIM2 721 - 722 722 "parentId": "", ~/~/ ID клиента-родителя 723 723 "parentName": "", ~/~/ Наименование клиента-родителя 724 724 "modelId": "", ~/~/ ID модели объекта 725 725 "modelName": "", ~/~/ Имя модели объекта 726 - 727 727 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 728 "unitName": "string", ~/~/ Наименование подразделения 729 729 "status": 0, ~/~/ Статус объекта 730 - 731 731 "createdAt": "", ~/~/ Дата создания объекта 732 732 }, 733 - 734 734 "customFields": [ ~/~/ Произвольные поля 735 735 { 736 736 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -753,8 +753,7 @@ 753 753 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 754 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 755 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 758 758 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 759 "mileageCoeff": 0, ~/~/ коэффициент пробега 760 760 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -784,7 +784,6 @@ 784 784 "retries": 0 ~/~/ Количество попыток 785 785 } 786 786 ], 787 - 788 788 "sensors": [ ~/~/ Датчики 789 789 { 790 790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -825,31 +825,19 @@ 825 825 }, 826 826 827 827 ~/~/ Характерные для произвольного: 828 - 829 829 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 - 831 831 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 - 833 833 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 - 835 835 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 - 837 837 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 - 839 839 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 - 841 841 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 - 843 843 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 - 845 845 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 - 847 847 ~/~/ "ValueOn": "Вкл.", 848 - 849 849 ~/~/ "ValueOff": "Выкл." 850 850 "summaryMaxValue": 0 ~/~/ Макс. значение 851 851 } 852 - 853 853 "drivers": [ ~/~/ Водители 854 854 { 855 855 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -858,7 +858,6 @@ 858 858 "isDefault": true ~/~/ По умолчанию 859 859 } 860 860 ], 861 - 862 862 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 863 { 864 864 "id": "", ~/~/ ID задания ... ... @@ -875,8 +875,7 @@ 875 875 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 876 } 877 877 ], 878 - 879 - "statusHistory": [ ~/~/ История статусов 1157 +"statusHistory": [ ~/~/ История статусов 880 880 { 881 881 "status": 0, 882 882 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -884,7 +884,6 @@ 884 884 "additionalInfo": "string" 885 885 } 886 886 ] 887 - 888 888 } 889 889 ))) 890 890 ... ... @@ -894,6 +894,73 @@ 894 894 (% style="text-align:left" %) 895 895 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 896 896 1174 + 1175 +== **Отправить команду на терминал** == 1176 + 1177 +(% class="box successmessage" %) 1178 +((( 1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1180 +))) 1181 + 1182 +Команда для отправки на тс. 1183 + 1184 +{ 1185 +"id": "", ~/~/идентификатор произвольного поля 1186 +"command": "", ~/~/ Текст команды 1187 +"retries": "", ~/~/ Количество попыток 1188 +"idTemplate": "" ~/~/ ID шаблона команды 1189 +} 1190 + 1191 + 1192 +== **Получить ответ на отправленную на ТС команду** == 1193 + 1194 +(% class="box infomessage" %) 1195 +((( 1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 +))) 1198 + 1199 +Идентификатор команды: cmdid 1200 + 1201 +Запрос от терминала на ответ команды 1202 + 1203 +Пример ответ от терминала: 1204 + 1205 +ID= "" ~/~/ идентификатор произвольного поля 1206 +Soft="" ~/~/ версия софта 1207 +GPS=4 ~/~/ тип трекера 1208 +Time=11:05:43 28.06.24 ~/~/ время запроса 1209 +Lat=45.056221 ~/~/ широта 1210 +Lon=39.035938 ~/~/ долгота 1211 +Speed=0.0 ~/~/ скорость 1212 +Course=181.4 ~/~/направление 1213 + 1214 +((( 1215 +== **Список отправленных объекту команд с ответами** == 1216 + 1217 +(% class="box infomessage" %) 1218 +((( 1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1220 +))) 1221 + 1222 +Идентификатор ТС: vehicleId 1223 + 1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 + 1226 +Пример ответа терминала 1227 + 1228 +[ 1229 +{ 1230 +"id": "", ~/~/ идентификатор пользователя 1231 +"commandText": "", ~/~/Текст команды. 1232 +"templateId": "", ~/~/Идентификатор шаблона 1233 +"updated": "", ~/~/ Время отправки 1234 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1235 +"answer": "", ~/~/ Ответ терминала. 1236 +"status": "" ~/~/ Статус отправки 1237 +} 1238 +] 1239 +))) 1240 + 897 897 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 898 898 899 899 (% class="box successmessage" %) ... ... @@ -911,8 +911,7 @@ 911 911 912 912 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 913 913 914 -(% style="color:#000000" %){ 915 - 1258 +(% style="color:#000000" %){(%%) 916 916 "parentId": "" , ~/~/ ID клиента 917 917 "name": "" , ~/~/ имя ТС 918 918 "imei": "" , ~/~/ IMEI ... ... @@ -933,7 +933,6 @@ 933 933 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 934 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 935 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 - 937 937 "mileageCalcMethod": 0, 938 938 "mileageCoeff": 0, 939 939 "locationByCellId": true, ... ... @@ -966,7 +966,6 @@ 966 966 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 967 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 968 } 969 - 970 970 "drivers": [ ~/~/ Водители 971 971 { 972 972 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -981,8 +981,7 @@ 981 981 "retries": 0 982 982 } 983 983 ], 984 - 985 - "sensors": [ ~/~/ Датчики 1325 +"sensors": [ ~/~/ Датчики 986 986 { 987 987 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 988 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1020,33 +1020,25 @@ 1020 1020 "additionalProp2": "string", 1021 1021 "additionalProp3": "string" 1022 1022 }, 1023 - 1024 1024 ~/~/ Характерные для произвольного: 1025 - 1026 1026 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1027 - 1028 1028 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1029 - 1030 1030 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1031 - 1032 1032 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1033 - 1034 1034 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1035 - 1036 1036 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1037 - 1038 1038 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1039 - 1040 1040 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1041 - 1042 1042 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1043 - 1044 1044 ~/~/ "ValueOn": "Вкл.", 1045 - 1046 1046 ~/~/ "ValueOff": "Выкл." 1047 1047 "summaryMaxValue": 0 ~/~/ Макс. значение 1048 1048 } 1049 1049 ], 1378 + 1379 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1380 + 1381 + 1050 1050 "customFields": [ ~/~/ Произвольные поля 1051 1051 { 1052 1052 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1061,55 +1061,157 @@ 1061 1061 1062 1062 (% style="color:#000000" %)Ответ: 1063 1063 1064 -(% style="color:#000000" %){ 1065 1065 1066 - "vehicleId": "", ~/~/ID ТС 1067 - "parentId": "", ~/~/Guid владельца ТС 1068 - "name": "", ~/~/Имя объекта 1069 - "imei": "", ~/~/IMEI 1070 - "deviceTypeId": "", ~/~/ID типа устройства 1071 - "modelId": "", ~/~/ID модели 1072 - "unitId": "", ~/~/ID подразделения 1073 - "sim1": "", ~/~/SIM1 1074 - "sim2": "", ~/~/SIM2 1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1077 - "counters": { ~/~/Счётчики 1078 - "mileageEnabled": true, 1079 - "motohoursEnabled": true, 1080 - "mileage": "", 1081 - "motohours": 345.0 1082 - }, 1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1084 - "id": null, 1085 - "enabled": true, ~/~/флаг включения 1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1087 - "login": "", ~/~/ имя учетной записи 1088 - "password": "" ~/~/ пароль учетной записи 1089 - }, 1090 - "inspectionTasks": { ~/~/ задания на ТО 1091 - "id": "", ~/~/ ID задачи 1092 - "enabled": false, ~/~/ Признак включения 1093 - "name": "", ~/~/ Имя задания 1094 - "description": "", ~/~/ Описание задания 1095 - "mileageCondition": "", ~/~/ Условие по пробегу 1096 - "lastMileage": "", ~/~/ Пробег (в метрах) 1097 - "motohoursCondition": "", ~/~/ Условие по моточасам 1098 - "lastMotohours": "", ~/~/ Моточасы 1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1100 - "kind": "", ~/~/ Вид периодичности по времени 1101 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1397 +((( 1398 +((( 1399 +{ 1400 + "vehicleId": 0, ~/~/ ID ТС 1401 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1402 + "name": "string", ~/~/ Имя объекта 1403 + "imei": "string", ~/~/ IMEI 1404 + "deviceTypeId": 0, ~/~/ ID типа устройства 1405 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1406 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1407 + "sim1": "string", ~/~/ SIM1 1408 + "sim2": "string", ~/~/ SIM2 1409 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1410 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1411 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1412 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1413 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1414 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1415 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1416 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1417 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1418 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1419 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1420 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1421 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1422 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1423 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1424 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1425 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1426 + "counters": { ~/~/ Dto для состояний счётчиков 1427 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1428 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1429 + "mileage": 0, ~/~/ Пробег 1430 + "motohours": 0 ~/~/ Моточасы 1431 + }, 1432 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1433 + "id": "string", ~/~/ CMSV6 Идентификатор 1434 + "enabled": true, ~/~/ Признак включения 1435 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1436 + "login": "string", ~/~/ CMSV6 имя учетной записи 1437 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1438 + }, 1439 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1440 + { 1441 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1442 + "enabled": true, ~/~/ Признак включения 1443 + "name": "string", ~/~/ Имя задания 1444 + "description": "string", ~/~/ Описание задания 1445 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1446 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1447 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1448 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1449 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1450 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1451 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1452 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1102 1102 } 1454 + ], 1455 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1456 + { 1457 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1458 + "inputNumber": 0, ~/~/ № входа. 1459 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1460 + "comment": "string", ~/~/ Комментарий 1461 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1462 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1463 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1464 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1465 + } 1466 + ], 1467 + "commandTemplates": [ ~/~/ Список шаблонов команд 1468 + { 1469 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1470 + "name": "string", ~/~/ Название шаблона команд 1471 + "command": "string", ~/~/ Команда на выполнение 1472 + "retries": 0 ~/~/ Лимит попыток отправки 1473 + } 1474 + ], 1475 + "sensors": [ ~/~/ Список датчиков 1476 + { 1477 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1478 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1479 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1480 + "name": "string", ~/~/ Имя датчика 1481 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1482 + "inputNumber": 0, ~/~/ Номер входа 1483 + "pseudonym": "string", ~/~/ Псевдоним 1484 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1485 + "isInverted": true, ~/~/ Признак инверсии 1486 + "disabled": true, ~/~/ Датчик не участвует в обработке 1487 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1488 + "gradesTables": [ ~/~/ Тарировка 1489 + { 1490 + "grades": [ ~/~/ Таблицы тарировки 1491 + { 1492 + "input": 0, ~/~/ Вход 1493 + "output": 0 ~/~/ Выход 1494 + } 1495 + ], 1496 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1497 + } 1498 + ], 1499 + "showInTooltip": true, ~/~/ Отображение в подсказке 1500 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1501 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1502 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1503 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1504 + "expr": "string", ~/~/ Выражение 1505 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1506 + "string" 1507 + ], 1508 + "customParams": { 1509 + "additionalProp1": "string", 1510 + "additionalProp2": "string", 1511 + "additionalProp3": "string" 1512 + }, 1513 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1514 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1515 + { 1516 + "from": 0, ~/~/ С какого значения 1517 + "color": "string", ~/~/ Каким цветом 1518 + (% style="background-color:inherit; color:inherit; font-family:Menlo,Monaco,Consolas,~"Courier New~",monospace; font-size:inherit; white-space:pre" %)"text": "string" 1519 +))) 1103 1103 1104 -(% style="text-align:left" %) 1105 -(% style="color:#000000" %)} 1521 + } 1522 + ] 1523 + } 1524 + ], 1525 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1526 + "customFields": [ ~/~/ Список произвольных полей 1527 + { 1528 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1529 + "name": "string", ~/~/ Наименование произвольного поля 1530 + "value": "string", ~/~/ Значение произвольного поля 1531 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1532 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1533 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1534 + } 1535 + ], 1536 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1537 +} 1538 +))) 1106 1106 1540 + 1107 1107 **Валидация:** 1108 1108 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 1109 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 1110 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1111 1111 1112 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1546 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1113 1113 1114 1114 (% class="box infomessage" %) 1115 1115 ((( ... ... @@ -1116,7 +1116,7 @@ 1116 1116 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1117 1117 ))) 1118 1118 1119 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1553 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1120 1120 1121 1121 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1122 1122 ... ... @@ -1160,8 +1160,7 @@ 1160 1160 (% style="color:#000000" %)Ответ: 1161 1161 1162 1162 (% style="color:#000000" %){ 1163 - 1164 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1597 + "vehicleId": "" ~/~/ идентификатор объекта 1165 1165 "name": "" ~/~/ наименование объекта 1166 1166 "imei": "" ~/~/ IMEI объекта 1167 1167 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1220,13 +1220,11 @@ 1220 1220 "data": "", ~/~/ Данные 1221 1221 "overwrite": false, ~/~/ Флаг перезаписи 1222 1222 "stage": "", ~/~/ Состояние, может быть null 1223 - 1224 1224 (% style="color:#000000" %)} 1225 1225 1226 1226 (% style="color:#000000" %)Ответ: 1227 1227 1228 -(% style="color:#000000" %){ 1229 - 1660 +(% style="color:#000000" %){(%%) 1230 1230 "status": "", ~/~/ значение статуса 1231 1231 "date": "", ~/~/ Дата смены статуса 1232 1232 "description": "", ~/~/ Описание ... ... @@ -1233,10 +1233,10 @@ 1233 1233 "data": "", ~/~/ Данные 1234 1234 "overwrite": false, ~/~/ Флаг перезаписи 1235 1235 "stage": "", ~/~/ Состояние 1236 - 1237 -(% style="text-align:left" %) 1238 1238 (% style="color:#000000" %) } 1239 1239 1669 +== == 1670 + 1240 1240 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1241 1241 1242 1242 (% class="box warningmessage" %) ... ... @@ -1324,8 +1324,7 @@ 1324 1324 "retries": 0 1325 1325 } 1326 1326 ], 1327 - 1328 - "sensors": [ ~/~/ Датчики 1758 +"sensors": [ ~/~/ Датчики 1329 1329 { 1330 1330 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 1331 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1363,33 +1363,26 @@ 1363 1363 "additionalProp2": "string", 1364 1364 "additionalProp3": "string" 1365 1365 }, 1366 - 1367 1367 ~/~/ Характерные для произвольного: 1368 - 1369 1369 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1370 - 1371 1371 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1372 - 1373 1373 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1374 - 1375 1375 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1376 - 1377 1377 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1378 - 1379 1379 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1380 - 1381 1381 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1382 - 1383 1383 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 - 1385 1385 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1386 - 1387 1387 ~/~/ "ValueOn": "Вкл.", 1388 - 1389 1389 ~/~/ "ValueOff": "Выкл." 1390 1390 "summaryMaxValue": 0 ~/~/ Макс. значение 1391 1391 } 1392 1392 ], 1811 + 1812 +((( 1813 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1814 +))) 1815 + 1393 1393 "customFields": [ ~/~/ Произвольные поля 1394 1394 { 1395 1395 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1404,54 +1404,175 @@ 1404 1404 1405 1405 (% style="color:#000000" %)Ответ: 1406 1406 1407 -(% lang="en-US" style="text-align:left" %) 1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1830 +((( 1831 +{ 1832 + "vehicleId": 0, ~/~/ ID ТС 1833 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1834 + "name": "string", ~/~/ Имя объекта 1835 + "imei": "string", ~/~/ IMEI 1836 + "deviceTypeId": 0, ~/~/ ID типа устройства 1837 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1838 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1839 + "sim1": "string", ~/~/ SIM1 1840 + "sim2": "string", ~/~/ SIM2 1841 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1842 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1843 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1844 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1845 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1846 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1847 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1848 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1849 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1850 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1851 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1852 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1853 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1854 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1855 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1856 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1857 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1858 + "counters": { ~/~/ состояний счётчиков 1859 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1860 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1861 + "mileage": 0, ~/~/ Пробег 1862 + "motohours": 0 ~/~/ Моточасы 1863 + }, 1864 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1865 + "id": "string", ~/~/ CMSV6 Идентификатор 1866 + "enabled": true, ~/~/ Признак включения 1867 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1868 +))) 1409 1409 1410 -(% lang="en-US" style="text-align:left" %) 1411 - "vehicleId": "", ~/~/ ID ТС 1412 - "parentId": "", ~/~/ ID клиента 1413 - "name": "", ~/~/ имя ТС 1414 - "imei": "", ~/~/ IMEI 1415 - "deviceTypeId": "", ~/~/ типа устройства 1416 - "modelId": "", ~/~/ ID модели 1417 - "unitId": "", ~/~/ ID подразделения 1418 - "sim1": "", ~/~/ SIM 1 1419 - "sim2": "", ~/~/ SIM2 1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1422 - "counters": 1423 - { 1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1426 - "mileage": "", ~/~/ пробег 1427 - "motohours": "", ~/~/ моточасы 1428 - } 1429 - "cmsv6Parameters": ~/~/ параметры CMSv6 1870 + 1871 +((( 1872 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1873 + "login": "string", ~/~/ CMSV6 имя учетной записи 1874 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1875 + }, 1876 + "inspectionTasks": [ ~/~/ Задания на ТО 1877 + { 1878 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1879 + "enabled": true, ~/~/ Признак включения 1880 + "name": "string", ~/~/ Имя задания 1881 + "description": "string", ~/~/ Описание задания 1882 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1883 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1884 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1885 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1886 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1887 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1888 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1889 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1890 + } 1891 + ], 1892 + "drivers": [ ~/~/ Список водителей 1893 + { 1894 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1895 + "inputNumber": 0, ~/~/ № входа. 1896 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1897 + "comment": "string", ~/~/ Комментарий. 1898 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1899 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1900 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1901 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1902 + } 1903 + ], 1904 + "commandTemplates": [ ~/~/ Список шаблонов команд 1905 + { 1906 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1907 + "name": "string", ~/~/ Название шаблона команд 1908 + "command": "string", ~/~/ Команда на выполнение 1909 + "retries": 0 ~/~/ Лимит попыток отправки 1910 + } 1911 + ], 1912 + "sensors": [ ~/~/ Список датчиков 1913 + { 1914 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1915 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1916 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1917 +))) 1918 + 1919 +((( 1920 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1921 +))) 1922 + 1923 +((( 1924 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 1925 +))) 1926 + 1927 +((( 1928 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 1929 +))) 1930 + 1931 +((( 1932 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 1933 +))) 1934 + 1935 +((( 1936 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1937 + "name": "string", ~/~/ Имя датчика 1938 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 1939 +))) 1940 + 1941 +((( 1942 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1943 + "inputNumber": 0, ~/~/ Номер входа 1944 + "pseudonym": "string", ~/~/ Псевдоним 1945 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1946 + "isInverted": true, ~/~/ Признак инверсии 1947 + "disabled": true, ~/~/ Датчик не участвует в обработке 1948 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1949 + "gradesTables": [ ~/~/ Тарировка 1430 1430 { 1431 - "id": ~/~/ идентификатор 1432 - "enabled": true, ~/~/ флаг включения 1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 - "login": "", ~/~/ имя учетной записи 1435 - "password": "", ~/~/ пароль учетной записи 1436 - } 1437 - "inspectionTasks": ~/~/ задания на ТО 1951 + "grades": [ ~/~/ Таблицы тарировки 1952 + { 1953 + "input": 0, ~/~/ Вход 1954 + "output": 0 ~/~/ Выход 1955 + } 1956 + ], 1957 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1958 + } 1959 + ], 1960 + "showInTooltip": true, ~/~/ Отображение в подсказке 1961 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1962 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1963 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1964 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1965 + "expr": "string", ~/~/ Выражение 1966 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1967 + "string" 1968 + ], 1969 + "customParams": { ~/~/ Дополнительные настройки 1970 + "additionalProp1": "string", 1971 + "additionalProp2": "string", 1972 + "additionalProp3": "string" 1973 + }, 1974 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1975 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1438 1438 { 1439 - "id": "", ~/~/ ID задания 1440 - "enabled": false, ~/~/ Признак включения 1441 - "name": "", ~/~/ Имя задания 1442 - "description": "", ~/~/ Описание задания 1443 - "mileageCondition": "", ~/~/ Условие по пробегу 1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1445 - "motohoursCondition": "", ~/~/ Условие по моточасам 1446 - "lastMotohours": "", ~/~/ Моточасы 1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1448 - "kind": "", ~/~/ Вид периодичности по времени 1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1977 + "from": 0, ~/~/ С какого значения 1978 + "color": "string", ~/~/ Каким цветом 1979 + "text": "string" ~/~/ Текст подписи к этому интервалу 1450 1450 } 1981 + ] 1982 + } 1983 + ], 1984 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1985 + "customFields": [ ~/~/ Список произвольных полей 1986 + { 1987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1988 + "name": "string", ~/~/ Наименование произвольного поля 1989 + "value": "string", ~/~/ Значение произвольного поля 1990 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1991 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1992 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1993 + } 1994 + ], 1995 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1996 +} 1997 +))) 1451 1451 1452 -(% lang="en-US" style="text-align:left" %) 1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1454 - 1455 1455 **Валидация:** 1456 1456 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1457 1457 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1490,18 +1490,15 @@ 1490 1490 1491 1491 (% style="color:#000000" %)Метод запроса: **GET** 1492 1492 1493 -(% 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]]2037 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1494 1494 1495 1495 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 1496 1497 1497 (% style="color:#000000" %)Ответ: 1498 1498 1499 -(% style="color:#000000" %){ 1500 - 2043 +(% style="color:#000000" %){(%%) 1501 1501 "deviceTypeId" : "", ~/~/ ID типа устройства 1502 1502 "deviceTypeName" : "" ~/~/ Название типа устройства 1503 - 1504 -(% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 1507 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1523,13 +1523,10 @@ 1523 1523 1524 1524 (% style="color:#000000" %)Ответ: 1525 1525 1526 -(% style="color:#000000" %){ 1527 - 2067 +(% style="color:#000000" %){(%%) 1528 1528 "id": "", ~/~/ ID типа датчика 1529 1529 "name": "", ~/~/ Название 1530 1530 "description": "", ~/~/ Описание 1531 - 1532 -(% style="text-align:left" %) 1533 1533 (% style="color:#000000" %)} 1534 1534 1535 1535 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1573,6 +1573,56 @@ 1573 1573 } 1574 1574 ] 1575 1575 2114 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2115 + 2116 +(% class="box infomessage" style="text-align: left;" %) 2117 +((( 2118 +**POST /api/v3/terminalMessages/mapping** 2119 +))) 2120 + 2121 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2122 + 2123 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2124 + 2125 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2126 + 2127 +{ 2128 + "protocolType": 0, 2129 + "params": ["string"] 2130 +} 2131 + 2132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2133 +|protocolType|ID типа протокола 2134 +|params|((( 2135 +Массив наименований параметров в сообщении 2136 +))) 2137 + 2138 +Ответ: 2139 + 2140 +{ 2141 + "protocolType": 0, 2142 + "mapping": { 2143 + "additionalProp1": { 2144 + "inputType": 0, 2145 + "inputNumber": 0 2146 + }, 2147 + "additionalProp2": { 2148 + "inputType": 0, 2149 + "inputNumber": 0 2150 + } 2151 + } 2152 +} 2153 + 2154 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2155 +|protocolType|Тип протокола 2156 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2157 +|inputNumber|((( 2158 +Номер входа 2159 +))) 2160 + 2161 +(% class="wikigeneratedid" %) 2162 +Перечень 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/]] 2163 + 1576 1576 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 1577 1578 1578 (% class="box infomessage" %) ... ... @@ -1597,6 +1597,11 @@ 1597 1597 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 1598 } 1599 1599 2188 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2189 +|vehicleId|ID объекта 2190 +|from|Дата и время начала периода запроса 2191 +|to|Дата и время окончания периода запроса 2192 + 1600 1600 Ответ: 1601 1601 1602 1602 [ ... ... @@ -1603,80 +1603,43 @@ 1603 1603 { 1604 1604 "messages": [ 1605 1605 { 1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 - "speed": 0, ~/~/ Скорость, км/ч 1609 - "altitude": 0, ~/~/ Высота, м 1610 - "latitude": 0, ~/~/ Широта [-90°;90°] 1611 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 - "satellites": 0, ~/~/ Кол-во спутников 1613 - "voltage": 0, ~/~/ Напряжение 1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2199 + "deviceTime": "2023-11-29T07:40:44.052Z", 2200 + "serverTime": "2023-11-29T07:40:44.052Z", 2201 + "speed": 0, 2202 + "altitude": 0, 2203 + "latitude": 0, 2204 + "longitude": 0, 2205 + "satellites": 0, 2206 + "course": 0, 2207 + "voltage": 0, 2208 + "parameters": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 2213 + "photoCount": 0, 2214 + "lbsCorrectedCoords": true, 2215 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) == 2221 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2222 +|deviceTime|Время сообщения терминала 2223 +|serverTime|Время когда сообщение поступило на сервер 2224 +|speed|Скорость 2225 +|altitude|Высота над уровнем моря 2226 +|latitude|Широта 2227 +|longitude|Долгота 2228 +|satellites|Кол-во спутников 2229 +|course|Курс 2230 +|voltage|Бортовое напряжение 2231 +|parameters|Список параметров и их значений 2232 +|photoCount|Количество фото 2233 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2234 +|protocolType|ID типа протокола 1626 1626 1627 -(% class="box infomessage" %) 1628 -((( 1629 -**POST /api/v3/vehicles/export/history** 1630 -))) 1631 - 1632 -Метод возвращает список сообщений терминала объекта за выбранный период. 1633 - 1634 -(% style="text-align: left;" %) 1635 -Метод запроса **POST** 1636 - 1637 -(% style="text-align: left;" %) 1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1639 - 1640 -(% style="text-align: left;" %) 1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1642 - 1643 -{ 1644 - "vehicleId": 0, ~/~/ ID объекта 1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1648 -} 1649 - 1650 -Ответ: 1651 - 1652 -Получаете файл. Сообщение: Code 200/Success 1653 - 1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1655 - 1656 -(% class="box infomessage" %) 1657 -((( 1658 -**GET /api/v3/vehicles/export/history/status** 1659 -))) 1660 - 1661 -Метод возвращает список сообщений терминала объекта за выбранный период. 1662 - 1663 -(% style="text-align: left;" %) 1664 -Метод запроса **GET** 1665 - 1666 -(% style="text-align: left;" %) 1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1668 - 1669 -(% style="text-align: left;" %) 1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1671 - 1672 -Ответ: 1673 - 1674 -{ 1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1677 - "message": "string" ~/~/ текст описывающий статус. 1678 -} 1679 - 1680 1680 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1681 1681 1682 1682 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1713,10 +1713,12 @@ 1713 1713 { 1714 1714 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1715 1715 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1716 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1717 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1718 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1719 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2272 + "mileage": 0, ~/~/ Пробег за период, километры 2273 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2274 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2275 + "motohours": 0, ~/~/ Моточасы за период, секунды 2276 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2277 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1720 1720 } 1721 1721 ] 1722 1722 } ... ... @@ -1765,6 +1765,12 @@ 1765 1765 } 1766 1766 ] 1767 1767 2326 +(% class="box warningmessage" %) 2327 +((( 2328 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2329 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2330 +))) 2331 + 1768 1768 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1769 1769 1770 1770 (% class="box infomessage" %) ... ... @@ -1810,6 +1810,96 @@ 1810 1810 } 1811 1811 ] 1812 1812 2377 + 2378 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2379 + 2380 +(% class="box infomessage" %) 2381 +((( 2382 +**POST /api/v3/vehicles/moveStop** 2383 +))) 2384 + 2385 +Метод запроса: **POST** 2386 + 2387 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2388 + 2389 +В заголовках запроса: X-Auth: Токен авторизации 2390 + 2391 + 2392 +Тело запроса: 2393 + 2394 +{ 2395 + "vehicleIds": [ ], ~/~/ Список ID объектов 2396 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2397 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2398 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2399 +} 2400 + 2401 +Ответ: 2402 + 2403 +[ 2404 + { 2405 + "vehicleId": 0, ~/~/ ID объекта 2406 + "vehicleName": "string", ~/~/ Имя объекта 2407 + "moves": [ ~/~/ Событие движения 2408 + { 2409 + "mileage": 0, ~/~/ Пробег, км 2410 + "eventId": 0, ~/~/ Идентификатор события 2411 + "eventName": "string", ~/~/ Название события 2412 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2413 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2414 + "duration": 0 ~/~/ Продолжительность события, секунд 2415 + } 2416 + ], 2417 + "stops": [ ~/~/ События стоянок 2418 + { 2419 + "address": "string", ~/~/ Адрес события 2420 + "eventId": 0, ~/~/ Идентификатор события 2421 + "eventName": "string", ~/~/ Название события 2422 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2423 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2424 + "duration": 0 ~/~/ Продолжительность события, секунд 2425 + } 2426 + ] 2427 + } 2428 +] 2429 + 2430 + 2431 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2432 + 2433 +(% class="box infomessage" %) 2434 +((( 2435 +**POST /api/v3/vehicles/getlastdata** 2436 +))) 2437 + 2438 +Метод запроса: **POST** 2439 + 2440 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2441 + 2442 +В заголовках запроса: X-Auth: Токен авторизации 2443 + 2444 + 2445 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2446 + 2447 +Ответ: 2448 + { 2449 + "vehicleId": 0, ~/~/Идентификатор объекта. 2450 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2451 + "vehicleNumber": "string",~/~/Номер объекта. 2452 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2453 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2454 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2455 + "speed": 0,~/~/Скорость объекта. 2456 + "course": 0,~/~/Курс движения [0;360] 2457 + "latitude": 0,~/~/Широта [-90°;90°]. 2458 + "longitude": 0,~/~/Долгота [-180°;180°]. 2459 + "address": "string",~/~/Адрес. 2460 + "geozones": [ ~/~/Сведения по геозонам. 2461 + { 2462 + "id": 0, 2463 + "name": "string" 2464 + } 2465 + 2466 + 1813 1813 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1814 1814 1815 1815 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2117,6 +2117,32 @@ 2117 2117 2118 2118 Success 2119 2119 2774 + 2775 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2776 + 2777 +(% class="box warningmessage" %) 2778 +((( 2779 +**PUT** /api/v3/notifications/prolongation 2780 +))) 2781 + 2782 +Метод позволяет продлить уведомления. 2783 + 2784 +Метод запроса **PUT** 2785 + 2786 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2787 + 2788 +В заголовках запроса: X-Auth: Токен авторизации. 2789 + 2790 +Тело запроса: 2791 + 2792 +[ 2793 + 2794 +0 2795 + 2796 +] 2797 + 2798 +где 0 идентификатор ids. 2799 + 2120 2120 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2121 2121 2122 2122 (% class="box errormessage" %) ... ... @@ -2708,6 +2708,83 @@ 2708 2708 Success 2709 2709 2710 2710 3391 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3392 + 3393 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3394 + 3395 +(% class="box infomessage" %) 3396 +((( 3397 +**POST /api/v3/Trailers** 3398 +))) 3399 + 3400 +Пример запроса: 3401 + 3402 +{ 3403 + "startDate": "2023-11-14T10:48:03.671Z", 3404 + "endDate": "2023-11-14T10:48:03.671Z", 3405 + "ids": [ 0 ], 3406 + "timezone": 0 3407 +} 3408 + 3409 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3410 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3411 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3412 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3413 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3414 + 3415 +Пример ответа: 3416 + 3417 +[ 3418 + { 3419 + "SD": "2023-11-14T10:48:03.717Z", 3420 + "ED": "2023-11-14T10:48:03.717Z", 3421 + "id": 0, 3422 + "SLat": 0, 3423 + "SLon": 0, 3424 + "ELat": 0, 3425 + "ELon": 0, 3426 + "mileage": 0 3427 + "Duration": 0 3428 + "Address": "string", 3429 + "Address2": "string", 3430 + "name": "string", 3431 + "rid": "string", 3432 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3433 + "trailer": { 3434 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3435 + "Number": "string", 3436 + "Description": "string", 3437 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3438 + "ExternalID": "string", 3439 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3440 + "CreateTime": "2023-11-14T10:48:03.717Z", 3441 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3442 + "IsDeleted": true 3443 + }, 3444 + "filesCount": 0, 3445 + } 3446 +] 3447 + 3448 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3449 +|SD|Дата и время начала события 3450 +|ED|Дата и время окончания события 3451 +|id|ID объекта 3452 +|SLat|Широта начальной координаты 3453 +|SLon|Долгота начальной координаты 3454 +|ELat|Широта конечной координаты 3455 +|ELon|Долгота конечной координаты 3456 +|mileage|Пробег 3457 +|Duration|Продолжительность 3458 +|Address|Адрес начального местоположения 3459 +|Address2|Адрес конечного местоположения 3460 +|name|Имя радиометки 3461 +|rid|Номер радиометки 3462 +|rguid|ID радиометки 3463 +|trailer|Информация об агрегате 3464 +|ModelGuid|ID агрегата 3465 +|Number|Название/номер агрегата 3466 +|Description|Текст примечания агрегата 3467 + 2711 2711 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2712 2712 2713 2713 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2729,13 +2729,18 @@ 2729 2729 { 2730 2730 "name": "string", 2731 2731 "number": 0, 2732 - "period": 0, ~/~/ Частота трансляции радиометки3489 + "period": 0, 2733 2733 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2734 2734 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2735 - "deleted": true 2736 2736 } 2737 2737 ] 2738 2738 3495 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3496 +|parentId|ID клиента 3497 +|name|Название карты-метки 3498 +|number|Номер 3499 +|period|Период запросов в секундах (работает только для агрегатов) 3500 +|id|ID карты-метки 2739 2739 2740 2740 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2741 2741 ... ... @@ -2752,13 +2752,18 @@ 2752 2752 { 2753 2753 "name": "string", 2754 2754 "number": 0, 2755 - "period": 0, ~/~/ Частота трансляции радиометки3517 + "period": 0, 2756 2756 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2757 2757 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2758 - "deleted": true 2759 2759 } 2760 2760 ] 2761 2761 3523 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3524 +|name|Название карты-метки 3525 +|number|Номер 3526 +|period|Период запросов в секундах (работает только для агрегатов) 3527 +|id|ID карты-метки 3528 +|parentId|ID клиента 2762 2762 2763 2763 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2764 2764 ... ... @@ -2774,7 +2774,6 @@ 2774 2774 "number": 0, 2775 2775 "period": 0, 2776 2776 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2777 - "deleted": true 2778 2778 } 2779 2779 2780 2780 Ответ: ... ... @@ -2785,9 +2785,14 @@ 2785 2785 "period": 0, 2786 2786 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2787 2787 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2788 - "deleted": true 2789 2789 } 2790 2790 3556 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3557 +|name|Название карты-метки 3558 +|number|Номер 3559 +|period|Период запросов в секундах (работает только для агрегатов) 3560 +|id|ID карты-метки 3561 +|parentId|ID клиента 2791 2791 2792 2792 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2793 2793 ... ... @@ -2804,7 +2804,6 @@ 2804 2804 "period": 0, 2805 2805 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2806 2806 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2807 - "deleted": true 2808 2808 } 2809 2809 2810 2810 Ответ: ... ... @@ -2815,9 +2815,14 @@ 2815 2815 "period": 0, 2816 2816 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2817 2817 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2818 - "deleted": true 2819 2819 } 2820 2820 3590 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3591 +|name|Название карты-метки 3592 +|number|Номер 3593 +|period|Период запросов в секундах (работает только для агрегатов) 3594 +|id|ID карты-метки 3595 +|parentId|ID клиента 2821 2821 2822 2822 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2823 2823 ... ... @@ -2826,7 +2826,7 @@ 2826 2826 **DELETE /api/v3/Rfids/{rfidGuid}** 2827 2827 ))) 2828 2828 2829 -Передаем параметр rfidGuid - идентификатор карты-метки 3604 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2830 2830 2831 2831 Ответ: 2832 2832 ... ... @@ -2833,6 +2833,1108 @@ 2833 2833 Success 2834 2834 2835 2835 3611 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3612 + 3613 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3614 + 3615 +(% class="box infomessage" %) 3616 +((( 3617 +**GET /api/v3/Billing/client/balance/{clientId}** 3618 +))) 3619 + 3620 +Параметр запроса: **clientId **- идентификатор клиента. 3621 + 3622 +Ответ: 3623 + 3624 +{ 3625 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3626 + "Balance": 0 3627 +} 3628 + 3629 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3630 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3631 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3632 + 3633 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3634 + 3635 +(% class="box infomessage" %) 3636 +((( 3637 +**GET /api/v3/Billing/client/constraint/{clientId}** 3638 +))) 3639 + 3640 +Параметр запроса: **clientId **- идентификатор клиента. 3641 + 3642 +Ответ: 3643 + 3644 +{ 3645 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3646 + "CalculationType": 0, 3647 + "PermissibleBalance": 0, 3648 + "DefermentDays": 0, 3649 + "SendUiNotifications": true, 3650 + "SendEmailNotifications": true, 3651 + "IsPrivate": true, 3652 +} 3653 + 3654 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3655 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3656 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3657 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3658 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3659 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3660 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3661 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3662 + 3663 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3664 + 3665 +(% class="box infomessage" %) 3666 +((( 3667 +**GET /api/v3/Billing/client/plan/{clientId}** 3668 +))) 3669 + 3670 +Параметры запроса: 3671 + 3672 +**clientId **- идентификатор клиента. 3673 + 3674 +**planId **- идентификатор тарифного плана. 3675 + 3676 +Ответ: 3677 + 3678 +{ 3679 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3680 + "Plan": { **~/~/ Описание тарифного плана** 3681 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3682 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3683 + "Name": "string", 3684 + "IsArchived": true, 3685 + "Constraint": { 3686 + "CalculationType": 0, 3687 + "PermissibleBalance": 0, 3688 + "DefermentDays": 0 3689 + }, 3690 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3691 + { 3692 + "Feature": "string", 3693 + "IsFactual": true, 3694 + "Limit": 0, 3695 + "Price": 0, 3696 + "PeriodValue": 0, 3697 + "PeriodType": 0 3698 + } 3699 + ] 3700 + }, 3701 + "DebitDate": "2023-10-18T12:46:24.213Z", 3702 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3703 + { 3704 + "Feature": "string", 3705 + "IsEnabled": true, 3706 + "IsPrivate": true, 3707 + "IsFactual": true, 3708 + "Limit": 0, 3709 + "Price": 0, 3710 + "DebitDate": "2023-10-18T12:46:24.213Z", 3711 + "PeriodValue": 0, 3712 + "PeriodType": 0 3713 + } 3714 + ] 3715 +} 3716 + 3717 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3718 +|ClientId|Идентификатор клиента 3719 +|Id|Идентификатор тарифного плана 3720 +|OwnerId|Идентификатор клиента-владельца 3721 +|Name|Наименование тарифного плана 3722 +|IsArchived|Признак, определяющий архивный тарифный план 3723 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3724 +|PermissibleBalance|Допустимый баланс 3725 +|DefermentDays|Отсрочка, количество дней 3726 +|Feature|Код услуги 3727 +|IsEnabled|Признак, определяющий активирована ли услуга 3728 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3729 +|IsFactual|Признак, определяющий расчёт по факту 3730 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3731 +|Price|Цена за единицу. 3732 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3733 +|PeriodValue|Значение периода. 3734 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3735 + 3736 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3737 + 3738 +(% class="box infomessage" %) 3739 +((( 3740 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3741 +))) 3742 + 3743 +Параметр запроса: **clientId **- идентификатор клиента. 3744 + 3745 +Ответ: 3746 + 3747 +[ 3748 + { 3749 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3750 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3751 + "Name": "string", 3752 + "IsArchived": true, 3753 + "Constraint": { 3754 + "CalculationType": 0, 3755 + "PermissibleBalance": 0, 3756 + "DefermentDays": 0 3757 + }, 3758 + "Features": [ 3759 + { 3760 + "Feature": "string", 3761 + "IsFactual": true, 3762 + "Limit": 0, 3763 + "Price": 0, 3764 + "PeriodValue": 0, 3765 + "PeriodType": 0 3766 + } 3767 + ] 3768 + } 3769 +] 3770 + 3771 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3772 +|ClientId|Идентификатор клиента 3773 +|Id|Идентификатор тарифного плана 3774 +|OwnerId|Идентификатор клиента-владельца 3775 +|Name|Наименование тарифного плана 3776 +|IsArchived|Признак, определяющий архивный тарифный план 3777 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3778 +|PermissibleBalance|Допустимый баланс 3779 +|DefermentDays|Отсрочка, количество дней 3780 +|Feature|Код услуги 3781 +|IsFactual|Признак, определяющий расчёт по факту 3782 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3783 +|Price|Цена за единицу. 3784 +|PeriodValue|Значение периода. 3785 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3786 + 3787 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3788 + 3789 +(% class="box infomessage" %) 3790 +((( 3791 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3792 +))) 3793 + 3794 +Параметр запроса: **clientId **- идентификатор клиента. 3795 + 3796 +Ответ: 3797 + 3798 +[ 3799 + { 3800 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3801 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3802 + "Name": "string", 3803 + "IsArchived": true, 3804 + "Constraint": { 3805 + "CalculationType": 0, 3806 + "PermissibleBalance": 0, 3807 + "DefermentDays": 0 3808 + }, 3809 + "Features": [ 3810 + { 3811 + "Feature": "string", 3812 + "IsFactual": true, 3813 + "Limit": 0, 3814 + "Price": 0, 3815 + "PeriodValue": 0, 3816 + "PeriodType": 0 3817 + } 3818 + ] 3819 + } 3820 +] 3821 + 3822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3823 +|ClientId|Идентификатор клиента 3824 +|Id|Идентификатор тарифного плана 3825 +|OwnerId|Идентификатор клиента-владельца 3826 +|Name|Наименование тарифного плана 3827 +|IsArchived|Признак, определяющий архивный тарифный план 3828 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3829 +|PermissibleBalance|Допустимый баланс 3830 +|DefermentDays|Отсрочка, количество дней 3831 +|Feature|Код услуги 3832 +|IsFactual|Признак, определяющий расчёт по факту 3833 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3834 +|Price|Цена за единицу. 3835 +|PeriodValue|Значение периода. 3836 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3837 + 3838 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3839 + 3840 +(% class="box warningmessage" %) 3841 +((( 3842 +**PUT /api/v3/Billing/client/balance** 3843 +))) 3844 + 3845 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3846 + 3847 +Тело запроса: 3848 + 3849 +{ 3850 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3851 + "Balance": 0 3852 +} 3853 + 3854 +Ответ: Success 3855 + 3856 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3857 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3858 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3859 + 3860 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3861 + 3862 +(% class="box warningmessage" %) 3863 +((( 3864 +**PUT /api/v3/billing/client/balance/deposit** 3865 +))) 3866 + 3867 +Создает операцию **Пополнение **с указанной суммой 3868 + 3869 +Тело запроса: 3870 + 3871 +{ 3872 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3873 + "Balance": 0 3874 +} 3875 + 3876 +Ответ: Success 3877 + 3878 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3879 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3880 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3881 + 3882 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3883 + 3884 +Создает операцию **Списание **с указанной суммой 3885 + 3886 +(% class="box warningmessage" %) 3887 +((( 3888 +**PUT /api/v3/billing/client/balance/withdraw** 3889 +))) 3890 + 3891 +Тело запроса: 3892 + 3893 +{ 3894 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3895 + "Balance": 0 3896 +} 3897 + 3898 +Ответ: Success 3899 + 3900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3901 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3902 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3903 + 3904 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3905 + 3906 +(% class="box warningmessage" %) 3907 +((( 3908 +**PUT /api/v3/Billing/client/constraint** 3909 +))) 3910 + 3911 +Тело запроса: 3912 + 3913 +{ 3914 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3915 + "CalculationType": 0, 3916 + "PermissibleBalance": 0, 3917 + "DefermentDays": 0, 3918 + "SendUiNotifications": true, 3919 + "SendEmailNotifications": true, 3920 + "IsPrivate": true, 3921 +} 3922 + 3923 +Ответ: Success 3924 + 3925 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3926 +|ClientId|Идентификатор клиента 3927 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3928 +|PermissibleBalance|Допустимый баланс 3929 +|DefermentDays|((( 3930 +Отсрочка, количество дней 3931 +))) 3932 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3933 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3934 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3935 + 3936 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3937 + 3938 +(% class="box warningmessage" %) 3939 +((( 3940 +**PUT /api/v3/Billing/client/plan** 3941 +))) 3942 + 3943 +Тело запроса: 3944 + 3945 +{ 3946 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3947 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3948 + "Features": [ 3949 + { 3950 + "Feature": "string", 3951 + "IsEnabled": true, 3952 + "IsFactual": true, 3953 + "Limit": 0, 3954 + "Price": 0, 3955 + "DebitDate": "2023-10-18T13:26:58.987Z", 3956 + "PeriodValue": 0, 3957 + "PeriodType": 0 3958 + } 3959 + ] 3960 +} 3961 + 3962 +Ответ: Success 3963 + 3964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3965 +|ClientId|Идентификатор клиента 3966 +|PlanId|Идентификатор тарифного плана 3967 +|Feature|Код услуги 3968 +|IsEnabled|Признак, определяющий активирована ли услуга 3969 +|IsFactual|Признак, определяющий расчёт по факту 3970 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3971 +|Price|Цена за единицу. 3972 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3973 +|PeriodValue|Значение периода. 3974 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3975 + 3976 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3977 + 3978 +(% class="box warningmessage" %) 3979 +((( 3980 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3981 +))) 3982 + 3983 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3984 + 3985 +(% class="box infomessage" %) 3986 +((( 3987 +**POST /api/v3/vehicles/import/{agentId}** 3988 +))) 3989 + 3990 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3991 + 3992 +В пути указывается **agentId** - id клиента. 3993 + 3994 +**Заголовок** 3995 + 3996 +**X-Auth: [токен авторизации]** 3997 + 3998 +**Параметры** 3999 + 4000 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4001 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4002 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4003 + 4004 +В теле использовать тип **form-data,** тип значения** file** 4005 + 4006 +**Ключи** 4007 + 4008 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4009 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4010 +|csv|В значении передаем файл датчиков, формат **csv** 4011 + 4012 +Ответ: 4013 + 4014 +{ 4015 + "vehicleId": 0, 4016 + "name": "string", 4017 + "errors": ["string"] 4018 +} 4019 + 4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4021 +|vehicleId|ID созданного объекта 4022 +|name|Имя созданного объекта 4023 +|errors|Ошибки и их описание 4024 + 4025 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4026 + 4027 +(% class="box infomessage" %) 4028 +((( 4029 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4030 +))) 4031 + 4032 +(% class="wikigeneratedid" %) 4033 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4034 + 4035 +(% class="wikigeneratedid" %) 4036 +В пути указывается **vehicleId **- id объекта. 4037 + 4038 +**Заголовок** 4039 + 4040 +**X-Auth: [токен авторизации]** 4041 + 4042 +В теле использовать тип **form-data.** 4043 + 4044 +Ключи: 4045 + 4046 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4047 +|**history**|В значении передавать файл с историей 4048 + 4049 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4050 + 4051 +Ответ: 4052 + 4053 +{ 4054 + "results": [ 4055 + { 4056 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4057 + "vehicleId": 0, 4058 + "errors": [ 4059 + "string" 4060 + ], 4061 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4062 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4063 + "producedCount": 0, 4064 + "msgCount": 0 4065 + } 4066 + ] 4067 +} 4068 + 4069 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4070 +|results|Результаты импорта в разрезе ТС 4071 +|vehicleGuid|Guid ТС 4072 +|vehicleId|ID ТС 4073 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4074 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4075 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4076 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4077 +|msgCount|Кол-во обработанных сообщений всего 4078 + 4079 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4080 + 4081 +(% class="box infomessage" %) 4082 +((( 4083 +**GET /api/v3/vehicles/import/history/status** 4084 +))) 4085 + 4086 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4087 + 4088 +Ответ: 4089 + 4090 +{ 4091 + "activity": true, 4092 + "progress": 0, 4093 + "message": "string" 4094 +} 4095 + 4096 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4097 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4098 +|progress|Guid ТС 4099 + 4100 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4101 + 4102 +(% class="box infomessage" %) 4103 +((( 4104 +**POST /api/v3/vehicles/export** 4105 +))) 4106 + 4107 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4108 + 4109 +Тело запроса: 4110 + 4111 +[ 4112 + id 4113 +] 4114 + 4115 +Ответ: Success 200, получаете файлы с настройками. 4116 + 4117 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4118 + 4119 +(% class="box infomessage" %) 4120 +((( 4121 +**POST /api/v3/vehicles/export/history** 4122 +))) 4123 + 4124 +Метод возвращает список сообщений терминала объекта за выбранный период. 4125 + 4126 +Тело запроса: 4127 + 4128 +{ 4129 + "vehicleId": 0, 4130 + "asArchive": true, 4131 + "from": "2023-09-27T12:17:45.973Z", 4132 + "to": "2023-09-27T12:17:45.973Z" 4133 +} 4134 + 4135 +Ответ: 4136 + 4137 +Получаете файл. Сообщение: Code 200/Success 4138 + 4139 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4140 +|vehicleId|ID объекта 4141 +|asArchive|true - Архивировать файл, False - не архивировать 4142 +|from|Дата и время начала запроса 4143 +|to|Дата и время окончания запроса 4144 + 4145 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4146 + 4147 +(% class="box infomessage" %) 4148 +((( 4149 +**GET /api/v3/vehicles/export/history/status** 4150 +))) 4151 + 4152 +Метод возвращает список сообщений терминала объекта за выбранный период. 4153 + 4154 +Ответ: 4155 + 4156 +{ 4157 + "activity": true, 4158 + "progress": 0, 4159 + "message": "string" 4160 +} 4161 + 4162 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4163 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4164 +|progress|Прогресс экспорта, от 0 до 100% 4165 +|message|Текст описывающий статус 4166 + 4167 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4168 + 4169 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4170 + 4171 +(% class="box infomessage" %) 4172 +((( 4173 +**POST /api/v3/EcoDriving/rating** 4174 +))) 4175 + 4176 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4177 + 4178 +Тело запроса: 4179 + 4180 +{ 4181 + "vehicleIds": [vehicleId], 4182 + "from": "2023-11-22T09:29:48.051Z", 4183 + "to": "2023-11-22T09:29:48.051Z" 4184 +} 4185 + 4186 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4187 +|vehicleIds|Массив ID объектов 4188 +|from|Дата начала запроса 4189 +|to|Дата окончания запроса 4190 + 4191 +Ответ: 4192 + 4193 +{ 4194 + "items": [ 4195 + { 4196 + "from": "2023-11-22T09:29:48.052Z", 4197 + "to": "2023-11-22T09:29:48.052Z", 4198 + "vehicleId": 0, 4199 + "vehicleName": "string", 4200 + "vehicleModel": "string", 4201 + "penalty": 0, 4202 + "score": 0, 4203 + "totalViolations": 0, 4204 + "violationsByType": { 4205 + "overspeedingViolations": 0, 4206 + "accelerationViolations": 0, 4207 + "brakingViolations": 0, 4208 + "turningViolations": 0, 4209 + "dangerousDrivingViolations": 0, 4210 + "sensorViolations": 0 4211 + }, 4212 + "moveTime": 0, 4213 + "mileage": 0, 4214 + "tripsCount": 0, 4215 + "trips": [ 4216 + { 4217 + "penalty": 0, 4218 + "score": 0, 4219 + "violationsCount": 0, 4220 + "violationsByType": { 4221 + "overspeedingViolations": 0, 4222 + "accelerationViolations": 0, 4223 + "brakingViolations": 0, 4224 + "turningViolations": 0, 4225 + "dangerousDrivingViolations": 0, 4226 + "sensorViolations": 0 4227 + }, 4228 + "moveTime": 0, 4229 + "mileage": 0, 4230 + "motohours": 0, 4231 + "maxSpeed": 0, 4232 + "startAddress": "string", 4233 + "endAddress": "string", 4234 + "drivers": [ 4235 + { 4236 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4237 + "driverName": "string", 4238 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4239 + } 4240 + ] 4241 + } 4242 + ] 4243 + } 4244 + ] 4245 +} 4246 + 4247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4248 +|from|Дата начала запроса 4249 +|to|Дата окончания 4250 +|vehicleId|ID объекта 4251 +|vehicleName|Имя объекта 4252 +|vehicleModel|Модель объекта 4253 +|penalty|Сумма штрафных баллов 4254 +|score|Оценка 4255 +|totalViolations|Суммарное количество нарушений 4256 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4257 +|overspeedingViolations|Превышение скорости 4258 +|accelerationViolations|Ускорение 4259 +|brakingViolations|Торможение 4260 +|turningViolations|Резкий поворот 4261 +|dangerousDrivingViolations|Резкое вождение 4262 +|sensorViolations|Нарушение по датчику 4263 +|moveTime|Время в движении 4264 +|mileage|Пробег (км) 4265 +|tripsCount|Количество рейсов 4266 +|motohours|Моточасы 4267 +|maxSpeed|Максимальная скорость 4268 +|startAddress|Адрес начала рейса 4269 +|endAddress|Адрес окончания рейса 4270 +|drivers|Список водителей, которые были на объекте в течениии рейса 4271 +|driverGuid|Guid водителя 4272 +|driverName|Имя водителя 4273 +|driverRfid|Номер Карты-метки 4274 + 4275 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4276 + 4277 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4278 + 4279 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4280 + 4281 +(% class="box infomessage" %) 4282 +((( 4283 +POST /api/v3/fuelcards/transactions 4284 +))) 4285 + 4286 +Метод запроса: POST 4287 + 4288 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4289 +\\В заголовках запроса: X-Auth: Токен авторизации 4290 + 4291 +Параметры в теле запроса (JSON): 4292 + 4293 +{ 4294 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4295 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4296 + "ids": [ 4297 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4298 + ], 4299 + "timezone": 0 ~/~/Таймзона 4300 +} 4301 + 4302 + 4303 +Ответ: 4304 + { 4305 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4306 + "driver": "string", ~/~/Водители, привязанные к ТК 4307 + "object": "string", ~/~/Наименование ТС 4308 + "amount": 0, ~/~/Количество топлива 4309 + "amountDut": 0, ~/~/Количество по ДУТ 4310 + "amountDiff": 0, ~/~/Разница, л 4311 + "amountDiffPerc": 0, ~/~/Разница, % 4312 + "summa": 0, ~/~/Стоимость, руб 4313 + "serviceName": "string", ~/~/Тип топлива 4314 + "price": 0, ~/~/Цена за литр, руб 4315 + "cardName": "string", ~/~/Наименование ТК 4316 + "cardNum": "string", ~/~/Номер ТК 4317 + "operator": "string", ~/~/Оператор ТК 4318 + "address": "string" ~/~/Адрес АЗС 4319 + } 4320 + 4321 + 4322 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4323 + 4324 + 4325 +== **Получение полных данных о ретрансляторе** == 4326 + 4327 +(% class="box infomessage" %) 4328 +((( 4329 +**GET ** **/api/v3/retranslations/{id}** 4330 +))) 4331 + 4332 +Идентификатор запроса: ID 4333 + 4334 + 4335 +Пример ответа: 4336 + 4337 +{ 4338 +"description": "", ~/~/ Определяет описание 4339 +"subscriberId": "", ~/~/ Подписчик 4340 +"protocolType": 0, ~/~/ Тип протокола 4341 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4342 +"address": "string", ~/~/ Адрес события 4343 +"objects": [ ~/~/Объекты для ретрансляции 4344 +{ 4345 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4346 +"name": "", ~/~/ Наименование объекта ретрансляции 4347 +"imei": "", ~/~/ IMEI объекта 4348 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4349 +} 4350 + ], 4351 +"id": "", ~/~/ идентификатор пользователя 4352 +"parentId": "", ~/~/Guid родителя 4353 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4354 +} 4355 + 4356 + 4357 +== **Удаление данных ретранслятора** == 4358 + 4359 +(% class="box infomessage" %) 4360 +((( 4361 +**DELETE** **/api/v3/retranslations/{id}** 4362 +))) 4363 + 4364 +Параметр запроса: ID 4365 + 4366 + 4367 +== **Создание ретранслятора** == 4368 + 4369 +(% class="box infomessage" %) 4370 +((( 4371 +**POST ** **/api/v3/retranslations/{id}** 4372 +))) 4373 + 4374 +Запрос: 4375 + 4376 +{ 4377 +"description": "", ~/~/ Описание 4378 +"subscriberId": "", ~/~/ Подписчик 4379 +"protocolType": 0, ~/~/ Тип протокола 4380 +"address": "", ~/~/ Адрес ретрансляции 4381 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4382 +"objects": [ ~/~/Объекты для ретрансляции 4383 +{ 4384 +"id": "", ~/~/ идентификатор пользователя 4385 +"imei": "", ~/~/IMEI объекта 4386 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4387 +} 4388 + ] 4389 +} 4390 + 4391 + 4392 +Ответ: 4393 + 4394 +{ 4395 +"description": "string", ~/~/ Определяет описание 4396 +"subscriberId": "", ~/~/ идентификатор запроса 4397 +"protocolType": 0, ~/~/ Тип протокола 4398 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4399 +"address": "", ~/~/ Адрес события 4400 +"objects": [ ~/~/Объекты для ретрансляции 4401 +{ 4402 +"id": "", ~/~/ идентификатор пользователя 4403 +"name": "string", ~/~/ Название уведомления 4404 +"imei": "string", ~/~/IMEI объекта 4405 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4406 +} 4407 + ], 4408 +"id": "", ~/~/ идентификатор пользователя 4409 +"parentId": "", ~/~/ Guid идентификатор родителя 4410 +"deleted": true ~/~/ Признак удаления 4411 +} 4412 + 4413 + 4414 +== **Редактирование ретранслятора** == 4415 + 4416 +(% class="box infomessage" %) 4417 +((( 4418 +**PUT** **/api/v3/retranslations** 4419 +))) 4420 + 4421 +Пример запроса: 4422 + 4423 +{ 4424 +"id": "", ~/~/ идентификатор пользователя 4425 +"description": "string", ~/~/ Определяет описание 4426 +"subscriberId": "", ~/~/ идентификатор запроса 4427 +"protocolType": 0, ~/~/ Тип протокола 4428 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4429 +"address": "string", ~/~/ Адрес события 4430 +"objects": ~/~/Объекты для ретрансляции 4431 +[ 4432 +{ 4433 +"id": "", ~/~/ идентификатор пользователя 4434 +"imei": "", ~/~/IMEI объекта 4435 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4436 +} 4437 + ] 4438 +} 4439 + 4440 + 4441 +Пример ответа: 4442 + 4443 +{ 4444 +"description": "", ~/~/ Определяет описание 4445 +"subscriberId": "", ~/~/ идентификатор запроса 4446 +"protocolType": 0, ~/~/ Тип протокола 4447 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4448 +"address": "string", ~/~/ Адрес события 4449 +"objects": [ ~/~/Объекты для ретрансляции 4450 +{ 4451 +"id": "", ~/~/ идентификатор пользователя 4452 +"name": "string", ~/~/ Название уведомления 4453 +"imei": "", ~/~/IMEI объекта 4454 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4455 +} 4456 + ], 4457 +"id": "", ~/~/ идентификатор пользователя 4458 +"parentId": "", ~/~/ Guid идентификатор родителя 4459 +"deleted": true ~/~/ Признак удаления 4460 +} 4461 + 4462 + 4463 +== **Получение списка ретранслятора клиента** == 4464 + 4465 +(% class="box infomessage" %) 4466 +((( 4467 +**POST /api/v3/retranslations/find** 4468 +))) 4469 + 4470 +Пример запроса: 4471 + 4472 +{ 4473 +"id": "", ~/~/ идентификатор пользователя 4474 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4475 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4476 +} 4477 + 4478 +Ответ: 4479 + 4480 +[ 4481 +{ 4482 +"description": "", ~/~/ Определяет описание 4483 +"subscriberId": "", ~/~/ идентификатор запроса 4484 +"protocolType": 0, ~/~/ Тип протокола 4485 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4486 +"address": "string", ~/~/ Адрес события 4487 +"id": "", ~/~/ идентификатор пользователя 4488 +"parentId": "", ~/~/ Guid идентификатор родителя 4489 +"deleted": true ~/~/ Признак удаления 4490 +} 4491 +] 4492 + 4493 + 4494 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4495 + 4496 +== **API для отчета по выгрузке комбайнов** == 4497 + 4498 +(% class="box infomessage" %) 4499 +((( 4500 +POST **/api/v3/Reports/harvesterUnloading** 4501 +))) 4502 + 4503 +Пример запроса: 4504 + 4505 +{ 4506 + "byTime": 0, ~/~/ Объединение событий по времени 4507 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4508 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4509 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4510 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4511 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4512 + 0 4513 + ], 4514 + "from": "", ~/~/ Дата и время начало запроса 4515 + "to": "", ~/~/ Дата и время окончания запроса 4516 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4517 +} 4518 + 4519 +Пример ответа: 4520 + 4521 +[ 4522 + { 4523 + "harvesterName": "", ~/~/Комбайн, номер 4524 + "harvesterId": 0, ~/~/Комбайн, id 4525 +"harvesterModel": "", ~/~/ Модель комбайна 4526 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4527 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4528 + "events": [ ~/~/Список событий в разрезе комбайна 4529 + { 4530 + "driverId": "", ~/~/Идентификатор водителя 4531 + "driverName": "", ~/~/Водитель комбайна, ФИО 4532 + "RFID": "", ~/~/ идентификатор карты-метки 4533 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4534 + "vehicleId": 0, ~/~/идентификатор объекта 4535 + "vehicleName": "string", ~/~/ Имя объекта 4536 + "modelName": "string", ~/~/ Имя модели объекта 4537 + "nearestVehicles": [ ~/~/Объекты рядом 4538 + { 4539 + "vehicleId": 0, ~/~/идентификатор объекта 4540 + "vehicleName": "string" ~/~/ Имя объекта 4541 + } 4542 + ], 4543 + "fields": [ ~/~/Поля, где происходила выгрузка 4544 + { 4545 + "id": 0, ~/~/ идентификатор пользователя 4546 + "name": "string" ~/~/ имя пользователя 4547 + } 4548 + ], 4549 + "event": "string", ~/~/Событие 4550 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4551 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4552 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4553 + "cultureName": "string", ~/~/ название культуры 4554 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4555 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4556 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4557 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4558 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4559 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4560 + "issued": 0, ~/~/Выдано, бункеров 4561 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4562 + "latitude": 0, ~/~/Широта 4563 + "longitude": 0, ~/~/ Долгота 4564 + "litresAway": 0, ~/~/Отдано, л 4565 + "m3Away": 0 ~/~/Отдано, м3 4566 + } 4567 + ] 4568 + } 4569 +] 4570 + 4571 + 4572 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4573 + 4574 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4575 + 4576 + 4577 +(% class="box infomessage" %) 4578 +((( 4579 +GET api/v3/Vehicles/recyclebin/all 4580 +))) 4581 + 4582 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4583 + 4584 +Параметр запроса: {parentId} - идентификатор агента 4585 + 4586 +В заголовках запроса: X-Auth: Токен авторизации 4587 + 4588 +Ответ: 4589 + 4590 +[ 4591 + { 4592 + "recordTime": "", ~/~/Время записи 4593 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4594 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4595 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4596 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4597 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4598 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4599 + "items": [ ~/~/ 4600 +nullable: true ~/~/Детали 4601 + { 4602 + "name": "string", ~/~/наименование столбца 4603 + "value": "string" ~/~/содержание столбца 4604 + } 4605 + ] 4606 + }, 4607 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4608 + "string" 4609 + ] 4610 + } 4611 +] 4612 + 4613 + 4614 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4615 + 4616 +(% class="box infomessage" %) 4617 +((( 4618 +POST/api/v3/Vehicles/recyclebin/erase 4619 +))) 4620 + 4621 +В заголовках запроса: X-Auth: Токен авторизации 4622 + 4623 +Пример запроса: 4624 + 4625 +[ 4626 +0 4627 +] 4628 + 4629 + 4630 +Пример ответа: 4631 + 4632 +[ 4633 +{ 4634 + "recordTime": "", ~/~/Время записи 4635 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4636 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4637 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4638 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4639 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4640 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4641 + "items": [ ~/~/Детали 4642 + { 4643 + "name": "", ~/~/Имя свойства 4644 + "value": "" ~/~/Значение свойства 4645 + } 4646 + ] 4647 + }, 4648 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4649 + "" 4650 + ] 4651 + } 4652 +] 4653 + 4654 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4655 + 4656 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4657 + 4658 +(% class="box infomessage" %) 4659 +((( 4660 +POST/api/v3/Vehicles/recyclebin/restore 4661 +))) 4662 + 4663 +В заголовках запроса: X-Auth: Токен авторизации 4664 + 4665 +Параметры в теле запроса (JSON): 4666 + 4667 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4668 + 4669 +В заголовках запроса: X-Auth: Токен авторизации 4670 + 4671 + 4672 +Пример запроса: 4673 + 4674 +((( 4675 +[ 4676 +))) 4677 + 4678 +((( 4679 + 0 4680 +))) 4681 + 4682 +((( 4683 +] 4684 +))) 4685 + 4686 + 4687 +Пример ответа: 4688 + 4689 +[ 4690 +{ 4691 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4692 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4693 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4694 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4695 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4696 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4697 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4698 + "items": [ ~/~/Детали 4699 + { 4700 + "name": "string", ~/~/Имя свойства 4701 + "value": "string" ~/~/Значение свойства 4702 + } 4703 + ] 4704 + }, 4705 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4706 + "string" 4707 + ] 4708 + } 4709 +] 4710 + 4711 + 4712 + 2836 2836 (% class="box" lang="en-US" style="text-align: center;" %) 2837 2837 ((( 2838 2838 (% 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]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content