Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,11 +1,9 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 -**Содержание страницы:** 3 +**Содержание страницы:**\ 4 4 ))) 5 5 6 -{{toc/}} 7 7 8 - 9 9 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 10 11 11 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!15 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 17 + 18 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 19 + 20 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 21 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 24 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 25 +((( 26 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 27 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 28 +))) 22 22 23 -(% class="box infomessage" %)30 +(% 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**__».41 +(% 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" %) 54 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 55 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 60 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 61 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 62 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 63 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 64 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 65 + 66 +(% class="wikigeneratedid" %) 67 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 68 + 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" ~/~/ Корр. счет108 + "agentId": "", (%%) 109 + "parentId": "", 110 + "parentName": "string", 111 + "name": "string", 112 + "fullName": "string", 113 + "agentInfoType": 0, 114 + "isForeign": true/false, 115 + "district": "string", 116 + "region": "string", 117 + "city": "string", 118 + "inn": "string", 119 + "kpp": "string", 120 + "address": "string", 121 + "addressFact": "string", 122 + "email": "string", 123 + "director": "string", 124 + "bankName": "string", 125 + "bankBIK": "string", 126 + "bankRS": "string", 127 + "bankKS": "string" 118 118 } 119 119 130 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 131 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 132 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 133 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 134 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 135 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 136 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 137 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 138 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 139 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 140 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 141 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 142 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 143 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 144 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 145 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 146 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 147 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 148 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 149 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 150 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 151 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».165 +(% 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 - Отказ) 180 + "agentId": "",(% style="color:#000000" %) (%%) 181 + "parentId": "", 182 + "name": "string", 183 + "fullName": "string", 184 + "agentInfoType": 0, 185 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 188 + 189 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 190 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 191 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 192 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 193 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 194 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 195 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 196 + 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 - 215 + "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 259 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 260 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 261 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 262 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 263 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 264 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 265 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 266 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 267 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 268 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 269 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 270 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 271 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 272 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 273 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 274 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 275 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 276 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 277 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 278 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 279 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 280 + 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 362 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 363 + 364 +(% class="box warningmessage" %) 365 +((( 366 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 367 +))) 368 + 369 +Метод позволяет изменить статус клиента, указанного в запросе. 370 + 371 +В пути указывается GUID клиента и статус клиента. 372 + 373 +**status **- значение 0 - заблокирован, 1 - активен. 374 + 375 +Ответ: Code 204 376 + 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 пользователя 441 +{ 442 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 459 +} 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 - 481 +(% 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 пользователя 577 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 578 + "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" %) 600 + "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": "" , ~/~/ идентификатор пользователя 607 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 608 + "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» названия группы пользователя 629 +} 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 - 650 +(% 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 - 675 + "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" %)Раздел: ** Транспортныесредства**(%%) =738 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 740 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 741 + 742 +(% class="box infomessage" %) 743 +((( 744 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 745 +))) 746 + 747 +Метод возвращает полную информацию о модели объекта. 748 + 749 +(% style="color:#000000" %)Метод запроса: **GET** 750 + 751 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 752 + 753 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 754 + 755 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 756 + 757 +(% style="color:#000000" %)Ответ: 758 + 759 +(% style="color:#000000" %){ 760 + "parentName": "string", 761 + "name": "string", 762 + "picture": "string", 763 + "minspeed": 0, 764 + "maxspeed": 0, 765 + "width": 0, 766 + "imbeddedtrailer": true, 767 + "hoppercapacity": 0, 768 + "hopperdischargespeed": 0, 769 + "modelType": 0, 770 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 771 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 772 + "deleted": true 773 +} 774 + 775 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 776 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 777 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 778 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 779 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 780 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 781 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 782 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 783 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 784 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 785 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 786 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 787 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 788 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 789 + 790 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 791 + 792 +(% class="box successmessage" %) 793 +((( 794 +(% lang="en-US" %)**POST /api/v3/models/find** 795 +))) 796 + 797 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 798 + 799 +(% style="color:#000000" %)Метод запроса: **POST** 800 + 801 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 802 + 803 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 804 + 805 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 806 + 807 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 808 +} 809 + 810 +(% style="color:#000000" %)Ответ: 811 + 812 +(% style="color:#000000" %)[ 813 + { 814 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 815 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 816 + "parentName": "string", 817 + "name": "string", 818 + "modelType": 0 819 + } 820 +] 821 + 822 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 823 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 824 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 825 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 826 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 827 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 828 + 829 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 830 + 831 +(% class="box successmessage" %) 832 +((( 833 +(% lang="en-US" %)**POST /api/v3/models** 834 +))) 835 + 836 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 837 + 838 +(% style="color:#000000" %)Метод запроса: **POST** 839 + 840 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 841 + 842 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 843 + 844 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 845 + 846 +{ 847 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 848 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 849 + "deleted": true, 850 + "extId": "string", 851 + "name": "string", 852 + "picture": "string", 853 + "minspeed": 0, 854 + "maxspeed": 0, 855 + "width": 0, 856 + "imbeddedtrailer": true, 857 + "fueloutlay": 0, 858 + "hoppercapacity": 0, 859 + "hopperdischargespeed": 0, 860 + "modelType": 0 861 +} 862 + 863 +Ответ: 864 + 865 +{ 866 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 867 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 868 + "deleted": true, 869 + "extId": "string", 870 + "name": "string", 871 + "picture": "string", 872 + "minspeed": 0, 873 + "maxspeed": 0, 874 + "width": 0, 875 + "imbeddedtrailer": true, 876 + "hoppercapacity": 0, 877 + "hopperdischargespeed": 0, 878 + "modelType": 0 879 +} 880 + 881 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 882 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 883 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 884 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 885 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 887 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 888 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 889 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 890 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 891 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 892 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 893 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 894 + 895 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 896 + 897 +(% class="box warningmessage" %) 898 +((( 899 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 900 +))) 901 + 902 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 903 + 904 +(% style="color:#000000" %)Метод запроса: **PUT** 905 + 906 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 907 + 908 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 909 + 910 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 911 + 912 +{ 913 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 914 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 915 + "deleted": true, 916 + "extId": "string", 917 + "name": "string", 918 + "picture": "string", 919 + "minspeed": 0, 920 + "maxspeed": 0, 921 + "width": 0, 922 + "imbeddedtrailer": true, 923 + "fueloutlay": 0, 924 + "hoppercapacity": 0, 925 + "hopperdischargespeed": 0, 926 + "modelType": 0 927 +} 928 + 929 +Ответ: 930 + 931 +{ 932 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 933 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 934 + "deleted": true, 935 + "extId": "string", 936 + "name": "string", 937 + "picture": "string", 938 + "minspeed": 0, 939 + "maxspeed": 0, 940 + "width": 0, 941 + "imbeddedtrailer": true, 942 + "fueloutlay": 0, 943 + "hoppercapacity": 0, 944 + "hopperdischargespeed": 0, 945 + "modelType": 0 946 +} 947 + 948 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 949 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 950 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 951 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 952 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 954 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 955 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 956 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 957 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 958 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 959 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 960 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 961 + 962 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 963 + 964 +(% class="box errormessage" %) 965 +((( 966 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 967 +))) 968 + 969 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 970 + 971 +(% style="color:#000000" %)Метод запроса: **DELETE** 972 + 973 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 974 + 975 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 976 + 977 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 978 + 979 +Ответ: В случае успеха **Success 200** 980 + 981 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 982 + 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 - 1048 + "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": [ ~/~/ История статусов 1155 +"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,108 @@ 894 894 (% style="text-align:left" %) 895 895 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 896 896 1172 + 1173 +== **Импортировать историю ТС (Асинхронный запрос)** == 1174 + 1175 +(% class="box successmessage" %) 1176 +((( 1177 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1178 +))) 1179 + 1180 +(% style="color:#000000" %)Метод запроса: **POST** 1181 + 1182 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} 1183 + 1184 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства 1185 + 1186 + 1187 +Ответ: 1188 + 1189 +{ 1190 + 1191 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1192 + 1193 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1194 + 1195 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1196 + 1197 + "Message": "string", ~/~/ Информация о выполнении запроса 1198 + 1199 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1200 + 1201 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1202 + 1203 + "Data": "string" ~/~/ Данные 1204 + 1205 +} 1206 + 1207 + 1208 +== **Отправить команду на терминал** == 1209 + 1210 +(% class="box successmessage" %) 1211 +((( 1212 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1213 +))) 1214 + 1215 +Команда для отправки на тс. 1216 + 1217 +{ 1218 +"id": "", ~/~/идентификатор произвольного поля 1219 +"command": "", ~/~/ Текст команды 1220 +"retries": "", ~/~/ Количество попыток 1221 +"idTemplate": "" ~/~/ ID шаблона команды 1222 +} 1223 + 1224 + 1225 +== **Получить ответ на отправленную на ТС команду** == 1226 + 1227 +(% class="box infomessage" %) 1228 +((( 1229 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1230 +))) 1231 + 1232 +Идентификатор команды: cmdid 1233 + 1234 +Запрос от терминала на ответ команды 1235 + 1236 +Пример ответ от терминала: 1237 + 1238 +ID= "" ~/~/ идентификатор произвольного поля 1239 +Soft="" ~/~/ версия софта 1240 +GPS=4 ~/~/ тип трекера 1241 +Time=11:05:43 28.06.24 ~/~/ время запроса 1242 +Lat=45.056221 ~/~/ широта 1243 +Lon=39.035938 ~/~/ долгота 1244 +Speed=0.0 ~/~/ скорость 1245 +Course=181.4 ~/~/направление 1246 + 1247 +((( 1248 +== **Список отправленных объекту команд с ответами** == 1249 + 1250 +(% class="box infomessage" %) 1251 +((( 1252 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1253 +))) 1254 + 1255 +Идентификатор ТС: vehicleId 1256 + 1257 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1258 + 1259 +Пример ответа терминала 1260 + 1261 +[ 1262 +{ 1263 +"id": "", ~/~/ идентификатор пользователя 1264 +"commandText": "", ~/~/Текст команды. 1265 +"templateId": "", ~/~/Идентификатор шаблона 1266 +"updated": "", ~/~/ Время отправки 1267 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1268 +"answer": "", ~/~/ Ответ терминала. 1269 +"status": "" ~/~/ Статус отправки 1270 +} 1271 +] 1272 +))) 1273 + 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 - 1291 +(% 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": [ ~/~/ Датчики 1358 +"sensors": [ ~/~/ Датчики 986 986 { 987 987 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 988 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1020,41 +1020,43 @@ 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 - "summaryMaxValue": 0 ~/~/ Макс. значение 1408 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1409 + 1410 +((( 1411 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1412 + { 1413 + "from": 0, ~/~/ С какого значения 1414 + "color": "string", ~/~/ Каким цветом 1415 + "text": "string" ~/~/ Текст подписи к этому интервалу 1416 + } 1417 + ] 1048 1048 } 1049 1049 ], 1420 +))) 1421 + 1422 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1423 + 1424 + 1050 1050 "customFields": [ ~/~/ Произвольные поля 1051 1051 { 1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1053 - "name": "string", 1054 - "value": "string", 1055 - "forClient": true, 1056 - "forTooltip": true, 1057 - "forReport": true 1427 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1428 + "name": "string", ~/~/ Наименование произвольного поля 1429 + "value": "string", ~/~/ Значение произвольного поля 1430 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1431 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1432 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1058 1058 } 1059 1059 ] 1060 1060 } ... ... @@ -1061,55 +1061,161 @@ 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 - однократно) 1440 +((( 1441 +((( 1442 +((( 1443 +{ 1444 + "vehicleId": 0, ~/~/ ID ТС 1445 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1446 + "name": "string", ~/~/ Имя объекта 1447 + "imei": "string", ~/~/ IMEI 1448 + "deviceTypeId": 0, ~/~/ ID типа устройства 1449 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1450 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1451 + "sim1": "string", ~/~/ SIM1 1452 + "sim2": "string", ~/~/ SIM2 1453 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1454 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1455 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1456 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1457 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1458 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1459 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1460 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1461 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1462 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1463 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1464 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1465 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1466 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1467 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1468 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1469 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1470 + "counters": { ~/~/ Dto для состояний счётчиков 1471 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1472 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1473 + "mileage": 0, ~/~/ Пробег 1474 + "motohours": 0 ~/~/ Моточасы 1475 + }, 1476 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1477 + "id": "string", ~/~/ CMSV6 Идентификатор 1478 + "enabled": true, ~/~/ Признак включения 1479 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1480 + "login": "string", ~/~/ CMSV6 имя учетной записи 1481 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1482 + }, 1483 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1484 + { 1485 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1486 + "enabled": true, ~/~/ Признак включения 1487 + "name": "string", ~/~/ Имя задания 1488 + "description": "string", ~/~/ Описание задания 1489 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1490 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1491 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1492 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1493 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1494 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1495 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1496 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1102 1102 } 1498 + ], 1499 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1500 + { 1501 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1502 + "inputNumber": 0, ~/~/ № входа. 1503 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1504 + "comment": "string", ~/~/ Комментарий 1505 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1506 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1507 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1508 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1509 + } 1510 + ], 1511 + "commandTemplates": [ ~/~/ Список шаблонов команд 1512 + { 1513 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1514 + "name": "string", ~/~/ Название шаблона команд 1515 + "command": "string", ~/~/ Команда на выполнение 1516 + "retries": 0 ~/~/ Лимит попыток отправки 1517 + } 1518 + ], 1519 + "sensors": [ ~/~/ Список датчиков 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1522 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1523 + "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 1524 + "name": "string", ~/~/ Имя датчика 1525 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1526 + "inputNumber": 0, ~/~/ Номер входа 1527 + "pseudonym": "string", ~/~/ Псевдоним 1528 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1529 + "isInverted": true, ~/~/ Признак инверсии 1530 + "disabled": true, ~/~/ Датчик не участвует в обработке 1531 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1532 + "gradesTables": [ ~/~/ Тарировка 1533 + { 1534 + "grades": [ ~/~/ Таблицы тарировки 1535 + { 1536 + "input": 0, ~/~/ Вход 1537 + "output": 0 ~/~/ Выход 1538 + } 1539 + ], 1540 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1541 + } 1542 + ], 1543 + "showInTooltip": true, ~/~/ Отображение в подсказке 1544 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1545 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1546 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1547 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1548 + "expr": "string", ~/~/ Выражение 1549 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1550 + "string" 1551 + ], 1552 + "customParams": { 1553 + "additionalProp1": "string", 1554 + "additionalProp2": "string", 1555 + "additionalProp3": "string" 1556 + }, 1557 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1558 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1559 + { 1560 + "from": 0, ~/~/ С какого значения 1561 + "color": "string", ~/~/ Каким цветом 1562 +))) 1103 1103 1104 -(% style="text-align:left" %) 1105 -(% style="color:#000000" %)} 1564 +((( 1565 + "text": "string" ~/~/ Текст подписи к этому интервалу 1566 + } 1567 + ] 1568 + } 1569 + ], 1570 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1571 + "customFields": [ ~/~/ Список произвольных полей 1572 + { 1573 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1574 + "name": "string", ~/~/ Наименование произвольного поля 1575 + "value": "string", ~/~/ Значение произвольного поля 1576 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1577 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1578 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1579 + } 1580 + ], 1581 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1582 +} 1583 +))) 1584 +))) 1585 +))) 1106 1106 1587 + 1107 1107 **Валидация:** 1108 1108 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 1109 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 1110 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1111 1111 1112 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1593 +== (% 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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1600 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1120 1120 1121 1121 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1122 1122 ... ... @@ -1150,9 +1150,12 @@ 1150 1150 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1151 1151 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1152 1152 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1155 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1634 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1635 + "unitName": "string", ~/~/ Название подразделения (опционально) 1636 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1637 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1638 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1639 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1156 1156 } 1157 1157 1158 1158 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1159,8 +1159,14 @@ 1159 1159 1160 1160 (% style="color:#000000" %)Ответ: 1161 1161 1162 -(% style="color:#000000" %){ 1646 +(% style="color:#000000" %)[ 1647 +{ 1163 1163 1649 +((( 1650 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1651 +))) 1652 + 1653 +((( 1164 1164 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1165 1165 "name": "" ~/~/ наименование объекта 1166 1166 "imei": "" ~/~/ IMEI объекта ... ... @@ -1186,9 +1186,21 @@ 1186 1186 "forClient": true, ~/~/ право на отображение у клиента 1187 1187 "forTooltip": false, ~/~/ право на отображение в подсказке 1188 1188 "forReport": false ~/~/ право на отображение в отчетах 1189 - }(%%) 1190 -(% style="color:#000000" %)} 1679 +))) 1191 1191 1681 +((( 1682 + } 1683 + ], 1684 + "vehicleGroups": [ ~/~/ Группы ТС 1685 + { 1686 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1687 + "name": "string" ~/~/ Наименование группы ТС 1688 + } 1689 + ] 1690 + } 1691 +] 1692 +))) 1693 + 1192 1192 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1193 1193 1194 1194 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -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 - 1729 +(% 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 1738 +== == 1739 + 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": [ ~/~/ Датчики 1827 +"sensors": [ ~/~/ Датчики 1329 1329 { 1330 1330 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 1331 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1363,95 +1363,215 @@ 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 ~/~/ Макс. значение 1878 + 1879 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1880 + { 1881 + "from": 0, ~/~/ С какого значения 1882 + "color": "string", ~/~/ Каким цветом 1883 + "text": "string" ~/~/ Текст подписи к этому интервалу 1884 + } 1885 + ] 1391 1391 } 1392 1392 ], 1888 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1889 + 1393 1393 "customFields": [ ~/~/ Произвольные поля 1394 - { 1395 - 1396 - "name": "string", 1397 - "value": "string", 1398 - "forClient": true, 1399 - "forTooltip": true, 1400 - "forReport": true 1891 + { 1892 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1893 + "name": "string", ~/~/ Наименование произвольного поля 1894 + "value": "string", ~/~/ Значение произвольного поля 1895 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1896 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1897 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1401 1401 } 1402 1402 ] 1403 1403 } 1404 1404 1902 + 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" %){ 1905 +((( 1906 +{ 1907 + "vehicleId": 0, ~/~/ ID ТС 1908 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1909 + "name": "string", ~/~/ Имя объекта 1910 + "imei": "string", ~/~/ IMEI 1911 + "deviceTypeId": 0, ~/~/ ID типа устройства 1912 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1913 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1914 + "sim1": "string", ~/~/ SIM1 1915 + "sim2": "string", ~/~/ SIM2 1916 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1917 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1918 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1919 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1920 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1921 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1922 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1923 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1924 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1925 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1926 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1927 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1928 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1929 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1930 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1931 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1932 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1933 + "counters": { ~/~/ состояний счётчиков 1934 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1935 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1936 + "mileage": 0, ~/~/ Пробег 1937 + "motohours": 0 ~/~/ Моточасы 1938 + }, 1939 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1940 + "id": "string", ~/~/ CMSV6 Идентификатор 1941 + "enabled": true, ~/~/ Признак включения 1942 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1943 +))) 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 1945 + 1946 +((( 1947 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1948 + "login": "string", ~/~/ CMSV6 имя учетной записи 1949 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1950 + }, 1951 + "inspectionTasks": [ ~/~/ Задания на ТО 1952 + { 1953 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1954 + "enabled": true, ~/~/ Признак включения 1955 + "name": "string", ~/~/ Имя задания 1956 + "description": "string", ~/~/ Описание задания 1957 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1958 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1959 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1960 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1961 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1962 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1963 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1964 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1965 + } 1966 + ], 1967 + "drivers": [ ~/~/ Список водителей 1968 + { 1969 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1970 + "inputNumber": 0, ~/~/ № входа. 1971 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1972 + "comment": "string", ~/~/ Комментарий. 1973 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1974 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1975 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1976 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1977 + } 1978 + ], 1979 + "commandTemplates": [ ~/~/ Список шаблонов команд 1980 + { 1981 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1982 + "name": "string", ~/~/ Название шаблона команд 1983 + "command": "string", ~/~/ Команда на выполнение 1984 + "retries": 0 ~/~/ Лимит попыток отправки 1985 + } 1986 + ], 1987 + "sensors": [ ~/~/ Список датчиков 1988 + { 1989 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1990 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1991 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1992 +))) 1993 + 1994 +((( 1995 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1996 +))) 1997 + 1998 +((( 1999 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2000 +))) 2001 + 2002 +((( 2003 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2004 +))) 2005 + 2006 +((( 2007 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2008 +))) 2009 + 2010 +((( 2011 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2012 + "name": "string", ~/~/ Имя датчика 2013 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2014 +))) 2015 + 2016 +((( 2017 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2018 + "inputNumber": 0, ~/~/ Номер входа 2019 + "pseudonym": "string", ~/~/ Псевдоним 2020 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2021 + "isInverted": true, ~/~/ Признак инверсии 2022 + "disabled": true, ~/~/ Датчик не участвует в обработке 2023 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2024 + "gradesTables": [ ~/~/ Тарировка 1430 1430 { 1431 - "id": ~/~/ идентификатор 1432 - "enabled": true, ~/~/ флаг включения 1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 - "login": "", ~/~/ имя учетной записи 1435 - "password": "", ~/~/ пароль учетной записи 1436 - } 1437 - "inspectionTasks": ~/~/ задания на ТО 2026 + "grades": [ ~/~/ Таблицы тарировки 2027 + { 2028 + "input": 0, ~/~/ Вход 2029 + "output": 0 ~/~/ Выход 2030 + } 2031 + ], 2032 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2033 + } 2034 + ], 2035 + "showInTooltip": true, ~/~/ Отображение в подсказке 2036 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2037 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2038 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2039 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2040 + "expr": "string", ~/~/ Выражение 2041 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2042 + "string" 2043 + ], 2044 + "customParams": { ~/~/ Дополнительные настройки 2045 + "additionalProp1": "string", 2046 + "additionalProp2": "string", 2047 + "additionalProp3": "string" 2048 + }, 2049 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2050 + "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": "", ~/~/ Сколько раз выполнить задание 2052 + "from": 0, ~/~/ С какого значения 2053 + "color": "string", ~/~/ Каким цветом 2054 + "text": "string" ~/~/ Текст подписи к этому интервалу 1450 1450 } 2056 + ] 2057 + } 2058 + ], 2059 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2060 + "customFields": [ ~/~/ Список произвольных полей 2061 + { 2062 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2063 + "name": "string", ~/~/ Наименование произвольного поля 2064 + "value": "string", ~/~/ Значение произвольного поля 2065 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2066 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2067 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2068 + } 2069 + ], 2070 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2071 +} 2072 +))) 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]]2112 +(% 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 - 2118 +(% 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 - 2142 +(% 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 2189 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2190 + 2191 +(% class="box infomessage" style="text-align: left;" %) 2192 +((( 2193 +**POST /api/v3/terminalMessages/mapping** 2194 +))) 2195 + 2196 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2197 + 2198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2199 + 2200 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2201 + 2202 +{ 2203 + "protocolType": 0, 2204 + "params": ["string"] 2205 +} 2206 + 2207 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2208 +|protocolType|ID типа протокола 2209 +|params|((( 2210 +Массив наименований параметров в сообщении 2211 +))) 2212 + 2213 +Ответ: 2214 + 2215 +{ 2216 + "protocolType": 0, 2217 + "mapping": { 2218 + "additionalProp1": { 2219 + "inputType": 0, 2220 + "inputNumber": 0 2221 + }, 2222 + "additionalProp2": { 2223 + "inputType": 0, 2224 + "inputNumber": 0 2225 + } 2226 + } 2227 +} 2228 + 2229 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2230 +|protocolType|Тип протокола 2231 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2232 +|inputNumber|((( 2233 +Номер входа 2234 +))) 2235 + 2236 +(% class="wikigeneratedid" %) 2237 +Перечень 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/]] 2238 + 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 2263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2264 +|vehicleId|ID объекта 2265 +|from|Дата и время начала периода запроса 2266 +|to|Дата и время окончания периода запроса 2267 + 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": { ~/~/ список параметров датчиков передаваемых терминалом 2274 + "deviceTime": "2023-11-29T07:40:44.052Z", 2275 + "serverTime": "2023-11-29T07:40:44.052Z", 2276 + "speed": 0, 2277 + "altitude": 0, 2278 + "latitude": 0, 2279 + "longitude": 0, 2280 + "satellites": 0, 2281 + "course": 0, 2282 + "voltage": 0, 2283 + "parameters": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 2288 + "photoCount": 0, 2289 + "lbsCorrectedCoords": true, 2290 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) == 2296 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2297 +|deviceTime|Время сообщения терминала 2298 +|serverTime|Время когда сообщение поступило на сервер 2299 +|speed|Скорость 2300 +|altitude|Высота над уровнем моря 2301 +|latitude|Широта 2302 +|longitude|Долгота 2303 +|satellites|Кол-во спутников 2304 +|course|Курс 2305 +|voltage|Бортовое напряжение 2306 +|parameters|Список параметров и их значений 2307 +|photoCount|Количество фото 2308 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2309 +|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 ~/~/ Моточасы на окончание периода 2347 + "mileage": 0, ~/~/ Пробег за период, километры 2348 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2349 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2350 + "motohours": 0, ~/~/ Моточасы за период, секунды 2351 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2352 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1720 1720 } 1721 1721 ] 1722 1722 } ... ... @@ -1765,6 +1765,12 @@ 1765 1765 } 1766 1766 ] 1767 1767 2401 +(% class="box warningmessage" %) 2402 +((( 2403 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2404 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2405 +))) 2406 + 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 2452 + 2453 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2454 + 2455 +(% class="box infomessage" %) 2456 +((( 2457 +**POST /api/v3/vehicles/moveStop** 2458 +))) 2459 + 2460 +Метод запроса: **POST** 2461 + 2462 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2463 + 2464 +В заголовках запроса: X-Auth: Токен авторизации 2465 + 2466 + 2467 +Тело запроса: 2468 + 2469 +{ 2470 + "vehicleIds": [ ], ~/~/ Список ID объектов 2471 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2472 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2473 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2474 +} 2475 + 2476 +Ответ: 2477 + 2478 +[ 2479 + { 2480 + "vehicleId": 0, ~/~/ ID объекта 2481 + "vehicleName": "string", ~/~/ Имя объекта 2482 + "moves": [ ~/~/ Событие движения 2483 + { 2484 + "mileage": 0, ~/~/ Пробег, км 2485 + "eventId": 0, ~/~/ Идентификатор события 2486 + "eventName": "string", ~/~/ Название события 2487 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2488 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2489 + "duration": 0 ~/~/ Продолжительность события, секунд 2490 + } 2491 + ], 2492 + "stops": [ ~/~/ События стоянок 2493 + { 2494 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2495 + "eventId": 0, ~/~/ Идентификатор события 2496 + "eventName": "string", ~/~/ Название события 2497 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2498 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2499 + "duration": 0 ~/~/ Продолжительность события, секунд 2500 + } 2501 + ] 2502 + } 2503 +] 2504 + 2505 + 2506 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2507 + 2508 +(% class="box infomessage" %) 2509 +((( 2510 +**POST /api/v3/vehicles/getlastdata** 2511 +))) 2512 + 2513 +Метод запроса: **POST** 2514 + 2515 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2516 + 2517 +В заголовках запроса: X-Auth: Токен авторизации 2518 + 2519 + 2520 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2521 + 2522 +Ответ: 2523 + { 2524 + "vehicleId": 0, ~/~/Идентификатор объекта. 2525 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2526 + "vehicleNumber": "string",~/~/Номер объекта. 2527 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2528 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2529 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2530 + "speed": 0,~/~/Скорость объекта. 2531 + "course": 0,~/~/Курс движения [0;360] 2532 + "latitude": 0,~/~/Широта [-90°;90°]. 2533 + "longitude": 0,~/~/Долгота [-180°;180°]. 2534 + "address": "string",~/~/Адрес. 2535 + "geozones": [ ~/~/Сведения по геозонам. 2536 + { 2537 + "id": 0, 2538 + "name": "string" 2539 + } 2540 + 2541 + 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 2849 + 2850 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2851 + 2852 +(% class="box warningmessage" %) 2853 +((( 2854 +**PUT** /api/v3/notifications/prolongation 2855 +))) 2856 + 2857 +Метод позволяет продлить уведомления. 2858 + 2859 +Метод запроса **PUT** 2860 + 2861 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2862 + 2863 +В заголовках запроса: X-Auth: Токен авторизации. 2864 + 2865 +Тело запроса: 2866 + 2867 +[ 2868 + 2869 +0 2870 + 2871 +] 2872 + 2873 +где 0 идентификатор ids. 2874 + 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 3466 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3467 + 3468 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3469 + 3470 +(% class="box infomessage" %) 3471 +((( 3472 +**POST /api/v3/Trailers** 3473 +))) 3474 + 3475 +Пример запроса: 3476 + 3477 +{ 3478 + "startDate": "2023-11-14T10:48:03.671Z", 3479 + "endDate": "2023-11-14T10:48:03.671Z", 3480 + "ids": [ 0 ], 3481 + "timezone": 0 3482 +} 3483 + 3484 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3485 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3486 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3487 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3488 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3489 + 3490 +Пример ответа: 3491 + 3492 +[ 3493 + { 3494 + "SD": "2023-11-14T10:48:03.717Z", 3495 + "ED": "2023-11-14T10:48:03.717Z", 3496 + "id": 0, 3497 + "SLat": 0, 3498 + "SLon": 0, 3499 + "ELat": 0, 3500 + "ELon": 0, 3501 + "mileage": 0 3502 + "Duration": 0 3503 + "Address": "string", 3504 + "Address2": "string", 3505 + "name": "string", 3506 + "rid": "string", 3507 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3508 + "trailer": { 3509 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3510 + "Number": "string", 3511 + "Description": "string", 3512 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3513 + "ExternalID": "string", 3514 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3515 + "CreateTime": "2023-11-14T10:48:03.717Z", 3516 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3517 + "IsDeleted": true 3518 + }, 3519 + "filesCount": 0, 3520 + } 3521 +] 3522 + 3523 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3524 +|SD|Дата и время начала события 3525 +|ED|Дата и время окончания события 3526 +|id|ID объекта 3527 +|SLat|Широта начальной координаты 3528 +|SLon|Долгота начальной координаты 3529 +|ELat|Широта конечной координаты 3530 +|ELon|Долгота конечной координаты 3531 +|mileage|Пробег 3532 +|Duration|Продолжительность 3533 +|Address|Адрес начального местоположения 3534 +|Address2|Адрес конечного местоположения 3535 +|name|Имя радиометки 3536 +|rid|Номер радиометки 3537 +|rguid|ID радиометки 3538 +|trailer|Информация об агрегате 3539 +|ModelGuid|ID агрегата 3540 +|Number|Название/номер агрегата 3541 +|Description|Текст примечания агрегата 3542 + 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, ~/~/ Частота трансляции радиометки3564 + "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 3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3571 +|parentId|ID клиента 3572 +|name|Название карты-метки 3573 +|number|Номер 3574 +|period|Период запросов в секундах (работает только для агрегатов) 3575 +|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, ~/~/ Частота трансляции радиометки3592 + "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 3598 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3599 +|name|Название карты-метки 3600 +|number|Номер 3601 +|period|Период запросов в секундах (работает только для агрегатов) 3602 +|id|ID карты-метки 3603 +|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 3631 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3632 +|name|Название карты-метки 3633 +|number|Номер 3634 +|period|Период запросов в секундах (работает только для агрегатов) 3635 +|id|ID карты-метки 3636 +|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 3665 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3666 +|name|Название карты-метки 3667 +|number|Номер 3668 +|period|Период запросов в секундах (работает только для агрегатов) 3669 +|id|ID карты-метки 3670 +|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 - идентификатор карты-метки 3679 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2830 2830 2831 2831 Ответ: 2832 2832 ... ... @@ -2833,6 +2833,1083 @@ 2833 2833 Success 2834 2834 2835 2835 3686 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3687 + 3688 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3689 + 3690 +(% class="box infomessage" %) 3691 +((( 3692 +**GET /api/v3/Billing/client/balance/{clientId}** 3693 +))) 3694 + 3695 +Параметр запроса: **clientId **- идентификатор клиента. 3696 + 3697 +Ответ: 3698 + 3699 +{ 3700 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3701 + "Balance": 0 3702 +} 3703 + 3704 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3705 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3706 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3707 + 3708 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3709 + 3710 +(% class="box infomessage" %) 3711 +((( 3712 +**GET /api/v3/Billing/client/constraint/{clientId}** 3713 +))) 3714 + 3715 +Параметр запроса: **clientId **- идентификатор клиента. 3716 + 3717 +Ответ: 3718 + 3719 +{ 3720 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3721 + "CalculationType": 0, 3722 + "PermissibleBalance": 0, 3723 + "DefermentDays": 0, 3724 + "SendUiNotifications": true, 3725 + "SendEmailNotifications": true, 3726 + "IsPrivate": true, 3727 +} 3728 + 3729 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3730 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3731 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3732 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3733 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3734 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3735 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3736 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3737 + 3738 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3739 + 3740 +(% class="box infomessage" %) 3741 +((( 3742 +**GET /api/v3/Billing/client/plan/{clientId}** 3743 +))) 3744 + 3745 +Параметры запроса: 3746 + 3747 +**clientId **- идентификатор клиента. 3748 + 3749 +**planId **- идентификатор тарифного плана. 3750 + 3751 +Ответ: 3752 + 3753 +{ 3754 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3755 + "Plan": { **~/~/ Описание тарифного плана** 3756 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3757 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3758 + "Name": "string", 3759 + "IsArchived": true, 3760 + "Constraint": { 3761 + "CalculationType": 0, 3762 + "PermissibleBalance": 0, 3763 + "DefermentDays": 0 3764 + }, 3765 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3766 + { 3767 + "Feature": "string", 3768 + "IsFactual": true, 3769 + "Limit": 0, 3770 + "Price": 0, 3771 + "PeriodValue": 0, 3772 + "PeriodType": 0 3773 + } 3774 + ] 3775 + }, 3776 + "DebitDate": "2023-10-18T12:46:24.213Z", 3777 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3778 + { 3779 + "Feature": "string", 3780 + "IsEnabled": true, 3781 + "IsPrivate": true, 3782 + "IsFactual": true, 3783 + "Limit": 0, 3784 + "Price": 0, 3785 + "DebitDate": "2023-10-18T12:46:24.213Z", 3786 + "PeriodValue": 0, 3787 + "PeriodType": 0 3788 + } 3789 + ] 3790 +} 3791 + 3792 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3793 +|ClientId|Идентификатор клиента 3794 +|Id|Идентификатор тарифного плана 3795 +|OwnerId|Идентификатор клиента-владельца 3796 +|Name|Наименование тарифного плана 3797 +|IsArchived|Признак, определяющий архивный тарифный план 3798 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3799 +|PermissibleBalance|Допустимый баланс 3800 +|DefermentDays|Отсрочка, количество дней 3801 +|Feature|Код услуги 3802 +|IsEnabled|Признак, определяющий активирована ли услуга 3803 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3804 +|IsFactual|Признак, определяющий расчёт по факту 3805 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3806 +|Price|Цена за единицу. 3807 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3808 +|PeriodValue|Значение периода. 3809 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3810 + 3811 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3812 + 3813 +(% class="box infomessage" %) 3814 +((( 3815 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3816 +))) 3817 + 3818 +Параметр запроса: **clientId **- идентификатор клиента. 3819 + 3820 +Ответ: 3821 + 3822 +[ 3823 + { 3824 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3825 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3826 + "Name": "string", 3827 + "IsArchived": true, 3828 + "Constraint": { 3829 + "CalculationType": 0, 3830 + "PermissibleBalance": 0, 3831 + "DefermentDays": 0 3832 + }, 3833 + "Features": [ 3834 + { 3835 + "Feature": "string", 3836 + "IsFactual": true, 3837 + "Limit": 0, 3838 + "Price": 0, 3839 + "PeriodValue": 0, 3840 + "PeriodType": 0 3841 + } 3842 + ] 3843 + } 3844 +] 3845 + 3846 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3847 +|ClientId|Идентификатор клиента 3848 +|Id|Идентификатор тарифного плана 3849 +|OwnerId|Идентификатор клиента-владельца 3850 +|Name|Наименование тарифного плана 3851 +|IsArchived|Признак, определяющий архивный тарифный план 3852 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3853 +|PermissibleBalance|Допустимый баланс 3854 +|DefermentDays|Отсрочка, количество дней 3855 +|Feature|Код услуги 3856 +|IsFactual|Признак, определяющий расчёт по факту 3857 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3858 +|Price|Цена за единицу. 3859 +|PeriodValue|Значение периода. 3860 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3861 + 3862 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3863 + 3864 +(% class="box infomessage" %) 3865 +((( 3866 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3867 +))) 3868 + 3869 +Параметр запроса: **clientId **- идентификатор клиента. 3870 + 3871 +Ответ: 3872 + 3873 +[ 3874 + { 3875 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3876 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3877 + "Name": "string", 3878 + "IsArchived": true, 3879 + "Constraint": { 3880 + "CalculationType": 0, 3881 + "PermissibleBalance": 0, 3882 + "DefermentDays": 0 3883 + }, 3884 + "Features": [ 3885 + { 3886 + "Feature": "string", 3887 + "IsFactual": true, 3888 + "Limit": 0, 3889 + "Price": 0, 3890 + "PeriodValue": 0, 3891 + "PeriodType": 0 3892 + } 3893 + ] 3894 + } 3895 +] 3896 + 3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3898 +|ClientId|Идентификатор клиента 3899 +|Id|Идентификатор тарифного плана 3900 +|OwnerId|Идентификатор клиента-владельца 3901 +|Name|Наименование тарифного плана 3902 +|IsArchived|Признак, определяющий архивный тарифный план 3903 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3904 +|PermissibleBalance|Допустимый баланс 3905 +|DefermentDays|Отсрочка, количество дней 3906 +|Feature|Код услуги 3907 +|IsFactual|Признак, определяющий расчёт по факту 3908 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3909 +|Price|Цена за единицу. 3910 +|PeriodValue|Значение периода. 3911 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3912 + 3913 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3914 + 3915 +(% class="box warningmessage" %) 3916 +((( 3917 +**PUT /api/v3/Billing/client/balance** 3918 +))) 3919 + 3920 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3921 + 3922 +Тело запроса: 3923 + 3924 +{ 3925 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3926 + "Balance": 0 3927 +} 3928 + 3929 +Ответ: Success 3930 + 3931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3932 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3933 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3934 + 3935 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3936 + 3937 +(% class="box warningmessage" %) 3938 +((( 3939 +**PUT /api/v3/billing/client/balance/deposit** 3940 +))) 3941 + 3942 +Создает операцию **Пополнение **с указанной суммой 3943 + 3944 +Тело запроса: 3945 + 3946 +{ 3947 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3948 + "Balance": 0 3949 +} 3950 + 3951 +Ответ: Success 3952 + 3953 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3954 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3955 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3956 + 3957 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3958 + 3959 +Создает операцию **Списание **с указанной суммой 3960 + 3961 +(% class="box warningmessage" %) 3962 +((( 3963 +**PUT /api/v3/billing/client/balance/withdraw** 3964 +))) 3965 + 3966 +Тело запроса: 3967 + 3968 +{ 3969 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3970 + "Balance": 0 3971 +} 3972 + 3973 +Ответ: Success 3974 + 3975 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3976 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3977 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3978 + 3979 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3980 + 3981 +(% class="box warningmessage" %) 3982 +((( 3983 +**PUT /api/v3/Billing/client/constraint** 3984 +))) 3985 + 3986 +Тело запроса: 3987 + 3988 +{ 3989 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3990 + "CalculationType": 0, 3991 + "PermissibleBalance": 0, 3992 + "DefermentDays": 0, 3993 + "SendUiNotifications": true, 3994 + "SendEmailNotifications": true, 3995 + "IsPrivate": true, 3996 +} 3997 + 3998 +Ответ: Success 3999 + 4000 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4001 +|ClientId|Идентификатор клиента 4002 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4003 +|PermissibleBalance|Допустимый баланс 4004 +|DefermentDays|((( 4005 +Отсрочка, количество дней 4006 +))) 4007 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4008 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4009 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4010 + 4011 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4012 + 4013 +(% class="box warningmessage" %) 4014 +((( 4015 +**PUT /api/v3/Billing/client/plan** 4016 +))) 4017 + 4018 +Тело запроса: 4019 + 4020 +{ 4021 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4022 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4023 + "Features": [ 4024 + { 4025 + "Feature": "string", 4026 + "IsEnabled": true, 4027 + "IsFactual": true, 4028 + "Limit": 0, 4029 + "Price": 0, 4030 + "DebitDate": "2023-10-18T13:26:58.987Z", 4031 + "PeriodValue": 0, 4032 + "PeriodType": 0 4033 + } 4034 + ] 4035 +} 4036 + 4037 +Ответ: Success 4038 + 4039 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4040 +|ClientId|Идентификатор клиента 4041 +|PlanId|Идентификатор тарифного плана 4042 +|Feature|Код услуги 4043 +|IsEnabled|Признак, определяющий активирована ли услуга 4044 +|IsFactual|Признак, определяющий расчёт по факту 4045 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4046 +|Price|Цена за единицу. 4047 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4048 +|PeriodValue|Значение периода. 4049 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4050 + 4051 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4052 + 4053 +(% class="box warningmessage" %) 4054 +((( 4055 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4056 +))) 4057 + 4058 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4059 + 4060 +(% class="box infomessage" %) 4061 +((( 4062 +**POST /api/v3/vehicles/import/{agentId}** 4063 +))) 4064 + 4065 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4066 + 4067 +В пути указывается **agentId** - id клиента. 4068 + 4069 +**Заголовок** 4070 + 4071 +**X-Auth: [токен авторизации]** 4072 + 4073 +**Параметры** 4074 + 4075 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4076 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4077 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4078 + 4079 +В теле использовать тип **form-data,** тип значения** file** 4080 + 4081 +**Ключи** 4082 + 4083 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4084 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4085 +|csv|В значении передаем файл датчиков, формат **csv** 4086 + 4087 +Ответ: 4088 + 4089 +{ 4090 + "vehicleId": 0, 4091 + "name": "string", 4092 + "errors": ["string"] 4093 +} 4094 + 4095 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4096 +|vehicleId|ID созданного объекта 4097 +|name|Имя созданного объекта 4098 +|errors|Ошибки и их описание 4099 + 4100 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4101 + 4102 +(% class="box infomessage" %) 4103 +((( 4104 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4105 +))) 4106 + 4107 +(% class="wikigeneratedid" %) 4108 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4109 + 4110 +(% class="wikigeneratedid" %) 4111 +В пути указывается **vehicleId **- id объекта. 4112 + 4113 +**Заголовок** 4114 + 4115 +**X-Auth: [токен авторизации]** 4116 + 4117 +В теле использовать тип **form-data.** 4118 + 4119 +Ключи: 4120 + 4121 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4122 +|**history**|В значении передавать файл с историей 4123 + 4124 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4125 + 4126 +Ответ: 4127 + 4128 +{ 4129 + "results": [ 4130 + { 4131 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4132 + "vehicleId": 0, 4133 + "errors": [ 4134 + "string" 4135 + ], 4136 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4137 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4138 + "producedCount": 0, 4139 + "msgCount": 0 4140 + } 4141 + ] 4142 +} 4143 + 4144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4145 +|results|Результаты импорта в разрезе ТС 4146 +|vehicleGuid|Guid ТС 4147 +|vehicleId|ID ТС 4148 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4149 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4150 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4151 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4152 +|msgCount|Кол-во обработанных сообщений всего 4153 + 4154 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4155 + 4156 +(% class="box infomessage" %) 4157 +((( 4158 +**GET /api/v3/vehicles/import/history/status** 4159 +))) 4160 + 4161 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4162 + 4163 +Ответ: 4164 + 4165 +{ 4166 + "activity": true, 4167 + "progress": 0, 4168 + "message": "string" 4169 +} 4170 + 4171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4172 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4173 +|progress|Guid ТС 4174 + 4175 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4176 + 4177 +(% class="box infomessage" %) 4178 +((( 4179 +**POST /api/v3/vehicles/export** 4180 +))) 4181 + 4182 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4183 + 4184 +Тело запроса: 4185 + 4186 +[ 4187 + id 4188 +] 4189 + 4190 +Ответ: Success 200, получаете файлы с настройками. 4191 + 4192 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4193 + 4194 +(% class="box infomessage" %) 4195 +((( 4196 +**POST /api/v3/vehicles/export/history** 4197 +))) 4198 + 4199 +Метод возвращает список сообщений терминала объекта за выбранный период. 4200 + 4201 +Тело запроса: 4202 + 4203 +{ 4204 + "vehicleId": 0, 4205 + "asArchive": true, 4206 + "from": "2023-09-27T12:17:45.973Z", 4207 + "to": "2023-09-27T12:17:45.973Z" 4208 +} 4209 + 4210 +Ответ: 4211 + 4212 +Получаете файл. Сообщение: Code 200/Success 4213 + 4214 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4215 +|vehicleId|ID объекта 4216 +|asArchive|true - Архивировать файл, False - не архивировать 4217 +|from|Дата и время начала запроса 4218 +|to|Дата и время окончания запроса 4219 + 4220 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4221 + 4222 +(% class="box infomessage" %) 4223 +((( 4224 +**GET /api/v3/vehicles/export/history/status** 4225 +))) 4226 + 4227 +Метод возвращает список сообщений терминала объекта за выбранный период. 4228 + 4229 +Ответ: 4230 + 4231 +{ 4232 + "activity": true, 4233 + "progress": 0, 4234 + "message": "string" 4235 +} 4236 + 4237 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4238 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4239 +|progress|Прогресс экспорта, от 0 до 100% 4240 +|message|Текст описывающий статус 4241 + 4242 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4243 + 4244 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4245 + 4246 +(% class="box infomessage" %) 4247 +((( 4248 +**POST /api/v3/EcoDriving/rating** 4249 +))) 4250 + 4251 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4252 + 4253 +Тело запроса: 4254 + 4255 +{ 4256 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4257 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4258 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4259 +} 4260 + 4261 +Ответ: 4262 + 4263 +{ 4264 + "items": [ ~/~/ Список в разрезе ТС 4265 + { 4266 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4267 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4268 + "vehicleId": 0, ~/~/ ID ТС 4269 + "vehicleName": "string", ~/~/ Название ТС 4270 + "vehicleModel": "string", ~/~/ Модель ТС 4271 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4272 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4273 + "totalViolations": 0, ~/~/ Нарушений всего 4274 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4275 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4276 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4277 + "brakingViolations": 0, ~/~/ Нарушений торможения 4278 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4279 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4280 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4281 + }, 4282 + 4283 +((( 4284 + 4285 +))) 4286 + 4287 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4288 + "mileage": 0, ~/~/ Пробег, м 4289 + "tripsCount": 0, ~/~/ Кол-во рейсов 4290 + "trips": [ ~/~/ Информация по рейсу 4291 + { 4292 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4293 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4294 + "violationsCount": 0, ~/~/ Всего нарушений 4295 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4296 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4297 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4298 + "brakingViolations": 0, ~/~/ Нарушений торможения 4299 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4300 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4301 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4302 + }, 4303 + 4304 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4305 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4306 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4307 + "mileage": 0, ~/~/ Пробег, м 4308 + "motohours": 0, ~/~/ Моточасы, секунды 4309 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4310 + "startAddress": "string", ~/~/ Адрес начала рейса 4311 + "endAddress": "string", ~/~/ Адрес конца рейса 4312 + "drivers": [ ~/~/ Список водителей 4313 + { 4314 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4315 + "driverName": "string", ~/~/ФИО водителя 4316 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4317 + } 4318 + ] 4319 + } 4320 + ] 4321 + } 4322 + ] 4323 +} 4324 + 4325 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4326 + 4327 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4328 + 4329 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4330 + 4331 +(% class="box infomessage" %) 4332 +((( 4333 +POST /api/v3/fuelcards/transactions 4334 +))) 4335 + 4336 +Метод запроса: POST 4337 + 4338 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4339 +\\В заголовках запроса: X-Auth: Токен авторизации 4340 + 4341 +Параметры в теле запроса (JSON): 4342 + 4343 +{ 4344 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4345 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4346 + "ids": [ 4347 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4348 + ], 4349 + "timezone": 0 ~/~/Таймзона 4350 +} 4351 + 4352 + 4353 +Ответ: 4354 + { 4355 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4356 + "driver": "string", ~/~/Водители, привязанные к ТК 4357 + "object": "string", ~/~/Наименование ТС 4358 + "amount": 0, ~/~/Количество топлива 4359 + "amountDut": 0, ~/~/Количество по ДУТ 4360 + "amountDiff": 0, ~/~/Разница, л 4361 + "amountDiffPerc": 0, ~/~/Разница, % 4362 + "summa": 0, ~/~/Стоимость, руб 4363 + "serviceName": "string", ~/~/Тип топлива 4364 + "price": 0, ~/~/Цена за литр, руб 4365 + "cardName": "string", ~/~/Наименование ТК 4366 + "cardNum": "string", ~/~/Номер ТК 4367 + "operator": "string", ~/~/Оператор ТК 4368 + "address": "string" ~/~/Адрес АЗС 4369 + } 4370 + 4371 + 4372 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4373 + 4374 + 4375 +== **Получение полных данных о ретрансляторе** == 4376 + 4377 +(% class="box infomessage" %) 4378 +((( 4379 +**GET ** **/api/v3/retranslations/{id}** 4380 +))) 4381 + 4382 +Идентификатор запроса: ID 4383 + 4384 + 4385 +Пример ответа: 4386 + 4387 +{ 4388 +"description": "", ~/~/ Определяет описание 4389 +"subscriberId": "", ~/~/ Подписчик 4390 +"protocolType": 0, ~/~/ Тип протокола 4391 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4392 +"address": "string", ~/~/ Адрес события 4393 +"objects": [ ~/~/Объекты для ретрансляции 4394 +{ 4395 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4396 +"name": "", ~/~/ Наименование объекта ретрансляции 4397 +"imei": "", ~/~/ IMEI объекта 4398 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4399 +} 4400 + ], 4401 +"id": "", ~/~/ идентификатор пользователя 4402 +"parentId": "", ~/~/Guid родителя 4403 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4404 +} 4405 + 4406 + 4407 +== **Удаление данных ретранслятора** == 4408 + 4409 +(% class="box infomessage" %) 4410 +((( 4411 +**DELETE** **/api/v3/retranslations/{id}** 4412 +))) 4413 + 4414 +Параметр запроса: ID 4415 + 4416 + 4417 +== **Создание ретранслятора** == 4418 + 4419 +(% class="box infomessage" %) 4420 +((( 4421 +**POST ** **/api/v3/retranslations/{id}** 4422 +))) 4423 + 4424 +Запрос: 4425 + 4426 +{ 4427 +"description": "", ~/~/ Описание 4428 +"subscriberId": "", ~/~/ Подписчик 4429 +"protocolType": 0, ~/~/ Тип протокола 4430 +"address": "", ~/~/ Адрес ретрансляции 4431 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4432 +"objects": [ ~/~/Объекты для ретрансляции 4433 +{ 4434 +"id": "", ~/~/ идентификатор пользователя 4435 +"imei": "", ~/~/IMEI объекта 4436 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4437 +} 4438 + ] 4439 +} 4440 + 4441 + 4442 +Ответ: 4443 + 4444 +{ 4445 +"description": "string", ~/~/ Определяет описание 4446 +"subscriberId": "", ~/~/ идентификатор запроса 4447 +"protocolType": 0, ~/~/ Тип протокола 4448 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4449 +"address": "", ~/~/ Адрес события 4450 +"objects": [ ~/~/Объекты для ретрансляции 4451 +{ 4452 +"id": "", ~/~/ идентификатор пользователя 4453 +"name": "string", ~/~/ Название уведомления 4454 +"imei": "string", ~/~/IMEI объекта 4455 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4456 +} 4457 + ], 4458 +"id": "", ~/~/ идентификатор пользователя 4459 +"parentId": "", ~/~/ Guid идентификатор родителя 4460 +"deleted": true ~/~/ Признак удаления 4461 +} 4462 + 4463 + 4464 +== **Редактирование ретранслятора** == 4465 + 4466 +(% class="box infomessage" %) 4467 +((( 4468 +**PUT** **/api/v3/retranslations** 4469 +))) 4470 + 4471 +Пример запроса: 4472 + 4473 +{ 4474 +"id": "", ~/~/ идентификатор пользователя 4475 +"description": "string", ~/~/ Определяет описание 4476 +"subscriberId": "", ~/~/ идентификатор запроса 4477 +"protocolType": 0, ~/~/ Тип протокола 4478 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4479 +"address": "string", ~/~/ Адрес события 4480 +"objects": ~/~/Объекты для ретрансляции 4481 +[ 4482 +{ 4483 +"id": "", ~/~/ идентификатор пользователя 4484 +"imei": "", ~/~/IMEI объекта 4485 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4486 +} 4487 + ] 4488 +} 4489 + 4490 + 4491 +Пример ответа: 4492 + 4493 +{ 4494 +"description": "", ~/~/ Определяет описание 4495 +"subscriberId": "", ~/~/ идентификатор запроса 4496 +"protocolType": 0, ~/~/ Тип протокола 4497 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4498 +"address": "string", ~/~/ Адрес события 4499 +"objects": [ ~/~/Объекты для ретрансляции 4500 +{ 4501 +"id": "", ~/~/ идентификатор пользователя 4502 +"name": "string", ~/~/ Название уведомления 4503 +"imei": "", ~/~/IMEI объекта 4504 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4505 +} 4506 + ], 4507 +"id": "", ~/~/ идентификатор пользователя 4508 +"parentId": "", ~/~/ Guid идентификатор родителя 4509 +"deleted": true ~/~/ Признак удаления 4510 +} 4511 + 4512 + 4513 +== **Получение списка ретранслятора клиента** == 4514 + 4515 +(% class="box infomessage" %) 4516 +((( 4517 +**POST /api/v3/retranslations/find** 4518 +))) 4519 + 4520 +Пример запроса: 4521 + 4522 +{ 4523 +"id": "", ~/~/ идентификатор пользователя 4524 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4525 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4526 +} 4527 + 4528 +Ответ: 4529 + 4530 +[ 4531 +{ 4532 +"description": "", ~/~/ Определяет описание 4533 +"subscriberId": "", ~/~/ идентификатор запроса 4534 +"protocolType": 0, ~/~/ Тип протокола 4535 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4536 +"address": "string", ~/~/ Адрес события 4537 +"id": "", ~/~/ идентификатор пользователя 4538 +"parentId": "", ~/~/ Guid идентификатор родителя 4539 +"deleted": true ~/~/ Признак удаления 4540 +} 4541 +] 4542 + 4543 + 4544 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4545 + 4546 +== **API для отчета по выгрузке комбайнов** == 4547 + 4548 +(% class="box infomessage" %) 4549 +((( 4550 +POST **/api/v3/Reports/harvesterUnloading** 4551 +))) 4552 + 4553 +Пример запроса: 4554 + 4555 +{ 4556 + "byTime": 0, ~/~/ Объединение событий по времени 4557 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4558 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4559 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4560 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4561 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4562 + 0 4563 + ], 4564 + "from": "", ~/~/ Дата и время начало запроса 4565 + "to": "", ~/~/ Дата и время окончания запроса 4566 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4567 +} 4568 + 4569 +Пример ответа: 4570 + 4571 +[ 4572 + { 4573 + "harvesterName": "", ~/~/Комбайн, номер 4574 + "harvesterId": 0, ~/~/Комбайн, id 4575 +"harvesterModel": "", ~/~/ Модель комбайна 4576 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4577 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4578 + "events": [ ~/~/Список событий в разрезе комбайна 4579 + { 4580 + "driverId": "", ~/~/Идентификатор водителя 4581 + "driverName": "", ~/~/Водитель комбайна, ФИО 4582 + "RFID": "", ~/~/ идентификатор карты-метки 4583 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4584 + "vehicleId": 0, ~/~/идентификатор объекта 4585 + "vehicleName": "string", ~/~/ Имя объекта 4586 + "modelName": "string", ~/~/ Имя модели объекта 4587 + "nearestVehicles": [ ~/~/Объекты рядом 4588 + { 4589 + "vehicleId": 0, ~/~/идентификатор объекта 4590 + "vehicleName": "string" ~/~/ Имя объекта 4591 + } 4592 + ], 4593 + "fields": [ ~/~/Поля, где происходила выгрузка 4594 + { 4595 + "id": 0, ~/~/ идентификатор пользователя 4596 + "name": "string" ~/~/ имя пользователя 4597 + } 4598 + ], 4599 + "event": "string", ~/~/Событие 4600 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4601 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4602 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4603 + "cultureName": "string", ~/~/ название культуры 4604 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4605 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4606 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4607 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4608 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4609 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4610 + "issued": 0, ~/~/Выдано, бункеров 4611 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4612 + "latitude": 0, ~/~/Широта 4613 + "longitude": 0, ~/~/ Долгота 4614 + "litresAway": 0, ~/~/Отдано, л 4615 + "m3Away": 0 ~/~/Отдано, м3 4616 + } 4617 + ] 4618 + } 4619 +] 4620 + 4621 + 4622 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4623 + 4624 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4625 + 4626 + 4627 +(% class="box infomessage" %) 4628 +((( 4629 +GET api/v3/Vehicles/recyclebin/all 4630 +))) 4631 + 4632 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4633 + 4634 +Параметр запроса: {parentId} - идентификатор агента 4635 + 4636 +В заголовках запроса: X-Auth: Токен авторизации 4637 + 4638 +Ответ: 4639 + 4640 +[ 4641 + { 4642 + "recordTime": "", ~/~/Время записи 4643 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4644 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4645 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4646 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4647 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4648 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4649 + "items": [ ~/~/ 4650 +nullable: true ~/~/Детали 4651 + { 4652 + "name": "string", ~/~/наименование столбца 4653 + "value": "string" ~/~/содержание столбца 4654 + } 4655 + ] 4656 + }, 4657 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4658 + "string" 4659 + ] 4660 + } 4661 +] 4662 + 4663 + 4664 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4665 + 4666 +(% class="box infomessage" %) 4667 +((( 4668 +POST/api/v3/Vehicles/recyclebin/erase 4669 +))) 4670 + 4671 +В заголовках запроса: X-Auth: Токен авторизации 4672 + 4673 +Пример запроса: 4674 + 4675 +[ 4676 +0 4677 +] 4678 + 4679 + 4680 +Пример ответа: 4681 + 4682 +[ 4683 +{ 4684 + "recordTime": "", ~/~/Время записи 4685 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4686 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4687 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4688 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4689 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4690 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4691 + "items": [ ~/~/Детали 4692 + { 4693 + "name": "", ~/~/Имя свойства 4694 + "value": "" ~/~/Значение свойства 4695 + } 4696 + ] 4697 + }, 4698 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4699 + "" 4700 + ] 4701 + } 4702 +] 4703 + 4704 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4705 + 4706 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4707 + 4708 +(% class="box infomessage" %) 4709 +((( 4710 +POST/api/v3/Vehicles/recyclebin/restore 4711 +))) 4712 + 4713 +В заголовках запроса: X-Auth: Токен авторизации 4714 + 4715 +Параметры в теле запроса (JSON): 4716 + 4717 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4718 + 4719 +В заголовках запроса: X-Auth: Токен авторизации 4720 + 4721 + 4722 +Пример запроса: 4723 + 4724 +((( 4725 +[ 4726 +))) 4727 + 4728 +((( 4729 + 0 4730 +))) 4731 + 4732 +((( 4733 +] 4734 +))) 4735 + 4736 + 4737 +Пример ответа: 4738 + 4739 +[ 4740 +{ 4741 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4742 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4743 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4744 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4745 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4746 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4747 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4748 + "items": [ ~/~/Детали 4749 + { 4750 + "name": "string", ~/~/Имя свойства 4751 + "value": "string" ~/~/Значение свойства 4752 + } 4753 + ] 4754 + }, 4755 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4756 + "string" 4757 + ] 4758 + } 4759 +] 4760 + 4761 + 4762 + 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