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
-
... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 + 20 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 + 22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 27 +((( 28 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 29 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 30 +))) 22 22 23 -(% class="box infomessage" %)32 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».43 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 62 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 63 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 64 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 65 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 66 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 67 + 68 +(% class="wikigeneratedid" %) 69 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 70 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 98 - "agentId": "", ~/~/идентификатор клиента(%%)99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)104 - "isForeign": true/false, ~/~/ Иностранный контрагент105 - "district": "string", ~/~/ округ106 - "region": "string", ~/~/ регион107 - "city": "string", ~/~/ город108 - "inn": "string", ~/~/ ИНН клиента109 - "kpp": "string", ~/~/ КПП клиента110 - "address": "string", ~/~/ юридический адрес111 - "addressFact": "string", ~/~/ фактический адрес112 - "email": "string", ~/~/ почта113 - "director": "string", ~/~/ ФИО руководителя114 - "bankName": "string", ~/~/ Банк115 - "bankBIK": "string", ~/~/ БИК116 - "bankRS": "string", ~/~/ Номер счета117 - "bankKS": "string" ~/~/ Корр. счет110 + "agentId": "", (%%) 111 + "parentId": "", 112 + "parentName": "string", 113 + "name": "string", 114 + "fullName": "string", 115 + "agentInfoType": 0, 116 + "isForeign": true/false, 117 + "district": "string", 118 + "region": "string", 119 + "city": "string", 120 + "inn": "string", 121 + "kpp": "string", 122 + "address": "string", 123 + "addressFact": "string", 124 + "email": "string", 125 + "director": "string", 126 + "bankName": "string", 127 + "bankBIK": "string", 128 + "bankRS": "string", 129 + "bankKS": "string" 118 118 } 119 119 132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 133 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 134 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 135 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 136 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 137 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 138 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 139 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 140 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 141 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 142 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 143 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 144 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 145 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 146 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 147 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 148 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 149 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 150 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 151 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 152 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 153 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».167 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 182 + "agentId": "",(% style="color:#000000" %) (%%) 183 + "parentId": "", 184 + "name": "string", 185 + "fullName": "string", 186 + "agentInfoType": 0, 187 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 190 + 191 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 192 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 193 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 194 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 195 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 196 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 197 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 198 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 262 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 263 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 264 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 265 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 266 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 267 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 268 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 269 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 270 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 271 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 272 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 273 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 274 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 275 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 276 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 277 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 278 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 279 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 280 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 281 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 282 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 365 + 366 +(% class="box warningmessage" %) 367 +((( 368 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 369 +))) 370 + 371 +Метод позволяет изменить статус клиента, указанного в запросе. 372 + 373 +В пути указывается GUID клиента и статус клиента. 374 + 375 +**status **- значение 0 - заблокирован, 1 - активен. 376 + 377 +Ответ: Code 204 378 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 443 +{ 444 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 483 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 602 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 631 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 652 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 677 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,8 +682,251 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: ** Транспортныесредства**(%%) =740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 742 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 743 + 744 +(% class="box infomessage" %) 745 +((( 746 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 747 +))) 748 + 749 +Метод возвращает полную информацию о модели объекта. 750 + 751 +(% style="color:#000000" %)Метод запроса: **GET** 752 + 753 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 754 + 755 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 756 + 757 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 758 + 759 +(% style="color:#000000" %)Ответ: 760 + 761 +(% style="color:#000000" %){ 762 + "parentName": "string", 763 + "name": "string", 764 + "picture": "string", 765 + "minspeed": 0, 766 + "maxspeed": 0, 767 + "width": 0, 768 + "imbeddedtrailer": true, 769 + "hoppercapacity": 0, 770 + "hopperdischargespeed": 0, 771 + "modelType": 0, 772 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 773 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 774 + "deleted": true 775 +} 776 + 777 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 778 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 779 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 780 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 781 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 782 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 783 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 784 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 785 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 786 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 787 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 788 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 789 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 790 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 791 + 792 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 793 + 794 +(% class="box successmessage" %) 795 +((( 796 +(% lang="en-US" %)**POST /api/v3/models/find** 797 +))) 798 + 799 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 800 + 801 +(% style="color:#000000" %)Метод запроса: **POST** 802 + 803 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 804 + 805 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 806 + 807 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 808 + 809 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 810 +} 811 + 812 +(% style="color:#000000" %)Ответ: 813 + 814 +(% style="color:#000000" %)[ 815 + { 816 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 817 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 818 + "parentName": "string", 819 + "name": "string", 820 + "modelType": 0 821 + } 822 +] 823 + 824 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 825 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 826 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 827 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 828 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 829 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 830 + 831 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 832 + 833 +(% class="box successmessage" %) 834 +((( 835 +(% lang="en-US" %)**POST /api/v3/models** 836 +))) 837 + 838 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 839 + 840 +(% style="color:#000000" %)Метод запроса: **POST** 841 + 842 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 843 + 844 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 845 + 846 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 847 + 848 +{ 849 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 850 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 + "deleted": true, 852 + "extId": "string", 853 + "name": "string", 854 + "picture": "string", 855 + "minspeed": 0, 856 + "maxspeed": 0, 857 + "width": 0, 858 + "imbeddedtrailer": true, 859 + "fueloutlay": 0, 860 + "hoppercapacity": 0, 861 + "hopperdischargespeed": 0, 862 + "modelType": 0 863 +} 864 + 865 +Ответ: 866 + 867 +{ 868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 869 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 + "deleted": true, 871 + "extId": "string", 872 + "name": "string", 873 + "picture": "string", 874 + "minspeed": 0, 875 + "maxspeed": 0, 876 + "width": 0, 877 + "imbeddedtrailer": true, 878 + "hoppercapacity": 0, 879 + "hopperdischargespeed": 0, 880 + "modelType": 0 881 +} 882 + 883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 884 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 885 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 887 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 888 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 889 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 890 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 891 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 892 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 893 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 894 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 895 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 896 + 897 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 898 + 899 +(% class="box warningmessage" %) 900 +((( 901 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 902 +))) 903 + 904 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 905 + 906 +(% style="color:#000000" %)Метод запроса: **PUT** 907 + 908 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 909 + 910 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 911 + 912 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 913 + 914 +{ 915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 916 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 917 + "deleted": true, 918 + "extId": "string", 919 + "name": "string", 920 + "picture": "string", 921 + "minspeed": 0, 922 + "maxspeed": 0, 923 + "width": 0, 924 + "imbeddedtrailer": true, 925 + "fueloutlay": 0, 926 + "hoppercapacity": 0, 927 + "hopperdischargespeed": 0, 928 + "modelType": 0 929 +} 930 + 931 +Ответ: 932 + 933 +{ 934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 935 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 936 + "deleted": true, 937 + "extId": "string", 938 + "name": "string", 939 + "picture": "string", 940 + "minspeed": 0, 941 + "maxspeed": 0, 942 + "width": 0, 943 + "imbeddedtrailer": true, 944 + "fueloutlay": 0, 945 + "hoppercapacity": 0, 946 + "hopperdischargespeed": 0, 947 + "modelType": 0 948 +} 949 + 950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 951 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 952 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 954 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 955 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 956 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 957 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 958 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 959 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 960 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 961 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 962 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 963 + 964 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 965 + 966 +(% class="box errormessage" %) 967 +((( 968 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 969 +))) 970 + 971 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 972 + 973 +(% style="color:#000000" %)Метод запроса: **DELETE** 974 + 975 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 976 + 977 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 978 + 979 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 980 + 981 +Ответ: В случае успеха **Success 200** 982 + 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 984 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -718,19 +718,15 @@ 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 720 "sim2": "", ~/~/ Номер SIM2 721 - 722 722 "parentId": "", ~/~/ ID клиента-родителя 723 723 "parentName": "", ~/~/ Наименование клиента-родителя 724 724 "modelId": "", ~/~/ ID модели объекта 725 725 "modelName": "", ~/~/ Имя модели объекта 726 - 727 727 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 728 "unitName": "string", ~/~/ Наименование подразделения 729 729 "status": 0, ~/~/ Статус объекта 730 - 731 731 "createdAt": "", ~/~/ Дата создания объекта 732 732 }, 733 - 734 734 "customFields": [ ~/~/ Произвольные поля 735 735 { 736 736 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -753,8 +753,7 @@ 753 753 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 754 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 755 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 758 758 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 759 "mileageCoeff": 0, ~/~/ коэффициент пробега 760 760 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -784,7 +784,6 @@ 784 784 "retries": 0 ~/~/ Количество попыток 785 785 } 786 786 ], 787 - 788 788 "sensors": [ ~/~/ Датчики 789 789 { 790 790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -825,31 +825,19 @@ 825 825 }, 826 826 827 827 ~/~/ Характерные для произвольного: 828 - 829 829 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 - 831 831 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 - 833 833 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 - 835 835 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 - 837 837 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 - 839 839 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 - 841 841 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 - 843 843 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 - 845 845 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 - 847 847 ~/~/ "ValueOn": "Вкл.", 848 - 849 849 ~/~/ "ValueOff": "Выкл." 850 850 "summaryMaxValue": 0 ~/~/ Макс. значение 851 851 } 852 - 853 853 "drivers": [ ~/~/ Водители 854 854 { 855 855 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -858,7 +858,6 @@ 858 858 "isDefault": true ~/~/ По умолчанию 859 859 } 860 860 ], 861 - 862 862 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 863 { 864 864 "id": "", ~/~/ ID задания ... ... @@ -875,8 +875,7 @@ 875 875 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 876 } 877 877 ], 878 - 879 - "statusHistory": [ ~/~/ История статусов 1157 +"statusHistory": [ ~/~/ История статусов 880 880 { 881 881 "status": 0, 882 882 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -884,7 +884,6 @@ 884 884 "additionalInfo": "string" 885 885 } 886 886 ] 887 - 888 888 } 889 889 ))) 890 890 ... ... @@ -894,6 +894,73 @@ 894 894 (% style="text-align:left" %) 895 895 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 896 896 1174 + 1175 +== **Отправить команду на терминал** == 1176 + 1177 +(% class="box successmessage" %) 1178 +((( 1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1180 +))) 1181 + 1182 +Команда для отправки на тс. 1183 + 1184 +{ 1185 +"id": "", ~/~/идентификатор произвольного поля 1186 +"command": "", ~/~/ Текст команды 1187 +"retries": "", ~/~/ Количество попыток 1188 +"idTemplate": "" ~/~/ ID шаблона команды 1189 +} 1190 + 1191 + 1192 +== **Получить ответ на отправленную на ТС команду** == 1193 + 1194 +(% class="box infomessage" %) 1195 +((( 1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 +))) 1198 + 1199 +Идентификатор команды: cmdid 1200 + 1201 +Запрос от терминала на ответ команды 1202 + 1203 +Пример ответ от терминала: 1204 + 1205 +ID= "" ~/~/ идентификатор произвольного поля 1206 +Soft="" ~/~/ версия софта 1207 +GPS=4 ~/~/ тип трекера 1208 +Time=11:05:43 28.06.24 ~/~/ время запроса 1209 +Lat=45.056221 ~/~/ широта 1210 +Lon=39.035938 ~/~/ долгота 1211 +Speed=0.0 ~/~/ скорость 1212 +Course=181.4 ~/~/направление 1213 + 1214 +((( 1215 +== **Список отправленных объекту команд с ответами** == 1216 + 1217 +(% class="box infomessage" %) 1218 +((( 1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1220 +))) 1221 + 1222 +Идентификатор ТС: vehicleId 1223 + 1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 + 1226 +Пример ответа терминала 1227 + 1228 +[ 1229 +{ 1230 +"id": "", ~/~/ идентификатор пользователя 1231 +"commandText": "", ~/~/Текст команды. 1232 +"templateId": "", ~/~/Идентификатор шаблона 1233 +"updated": "", ~/~/ Время отправки 1234 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1235 +"answer": "", ~/~/ Ответ терминала. 1236 +"status": "" ~/~/ Статус отправки 1237 +} 1238 +] 1239 +))) 1240 + 897 897 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 898 898 899 899 (% class="box successmessage" %) ... ... @@ -911,8 +911,7 @@ 911 911 912 912 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 913 913 914 -(% style="color:#000000" %){ 915 - 1258 +(% style="color:#000000" %){(%%) 916 916 "parentId": "" , ~/~/ ID клиента 917 917 "name": "" , ~/~/ имя ТС 918 918 "imei": "" , ~/~/ IMEI ... ... @@ -933,7 +933,6 @@ 933 933 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 934 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 935 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 - 937 937 "mileageCalcMethod": 0, 938 938 "mileageCoeff": 0, 939 939 "locationByCellId": true, ... ... @@ -966,7 +966,6 @@ 966 966 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 967 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 968 } 969 - 970 970 "drivers": [ ~/~/ Водители 971 971 { 972 972 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -981,8 +981,7 @@ 981 981 "retries": 0 982 982 } 983 983 ], 984 - 985 - "sensors": [ ~/~/ Датчики 1325 +"sensors": [ ~/~/ Датчики 986 986 { 987 987 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 988 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1020,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 ~/~/ Макс. значение 1375 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1376 + 1377 +((( 1378 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1379 + { 1380 + "from": 0, ~/~/ С какого значения 1381 + "color": "string", ~/~/ Каким цветом 1382 + "text": "string" ~/~/ Текст подписи к этому интервалу 1383 + } 1384 + ] 1048 1048 } 1049 1049 ], 1387 +))) 1388 + 1389 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1390 + 1391 + 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 1394 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1395 + "name": "string", ~/~/ Наименование произвольного поля 1396 + "value": "string", ~/~/ Значение произвольного поля 1397 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1398 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1399 + "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 - однократно) 1407 +((( 1408 +((( 1409 +((( 1410 +{ 1411 + "vehicleId": 0, ~/~/ ID ТС 1412 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1413 + "name": "string", ~/~/ Имя объекта 1414 + "imei": "string", ~/~/ IMEI 1415 + "deviceTypeId": 0, ~/~/ ID типа устройства 1416 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1417 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1418 + "sim1": "string", ~/~/ SIM1 1419 + "sim2": "string", ~/~/ SIM2 1420 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1421 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1422 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1423 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1424 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1425 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1426 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1427 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1428 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1429 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1430 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1431 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1432 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1433 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1434 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1435 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1436 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1437 + "counters": { ~/~/ Dto для состояний счётчиков 1438 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1439 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1440 + "mileage": 0, ~/~/ Пробег 1441 + "motohours": 0 ~/~/ Моточасы 1442 + }, 1443 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1444 + "id": "string", ~/~/ CMSV6 Идентификатор 1445 + "enabled": true, ~/~/ Признак включения 1446 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1447 + "login": "string", ~/~/ CMSV6 имя учетной записи 1448 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1449 + }, 1450 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1451 + { 1452 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1453 + "enabled": true, ~/~/ Признак включения 1454 + "name": "string", ~/~/ Имя задания 1455 + "description": "string", ~/~/ Описание задания 1456 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1457 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1458 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1459 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1460 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1461 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1462 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1463 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1102 1102 } 1465 + ], 1466 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1467 + { 1468 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1469 + "inputNumber": 0, ~/~/ № входа. 1470 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1471 + "comment": "string", ~/~/ Комментарий 1472 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1473 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1474 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1475 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1476 + } 1477 + ], 1478 + "commandTemplates": [ ~/~/ Список шаблонов команд 1479 + { 1480 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1481 + "name": "string", ~/~/ Название шаблона команд 1482 + "command": "string", ~/~/ Команда на выполнение 1483 + "retries": 0 ~/~/ Лимит попыток отправки 1484 + } 1485 + ], 1486 + "sensors": [ ~/~/ Список датчиков 1487 + { 1488 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1489 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1490 + "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 1491 + "name": "string", ~/~/ Имя датчика 1492 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1493 + "inputNumber": 0, ~/~/ Номер входа 1494 + "pseudonym": "string", ~/~/ Псевдоним 1495 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1496 + "isInverted": true, ~/~/ Признак инверсии 1497 + "disabled": true, ~/~/ Датчик не участвует в обработке 1498 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1499 + "gradesTables": [ ~/~/ Тарировка 1500 + { 1501 + "grades": [ ~/~/ Таблицы тарировки 1502 + { 1503 + "input": 0, ~/~/ Вход 1504 + "output": 0 ~/~/ Выход 1505 + } 1506 + ], 1507 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1508 + } 1509 + ], 1510 + "showInTooltip": true, ~/~/ Отображение в подсказке 1511 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1512 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1513 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1514 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1515 + "expr": "string", ~/~/ Выражение 1516 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1517 + "string" 1518 + ], 1519 + "customParams": { 1520 + "additionalProp1": "string", 1521 + "additionalProp2": "string", 1522 + "additionalProp3": "string" 1523 + }, 1524 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1525 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1526 + { 1527 + "from": 0, ~/~/ С какого значения 1528 + "color": "string", ~/~/ Каким цветом 1529 +))) 1103 1103 1104 -(% style="text-align:left" %) 1105 -(% style="color:#000000" %)} 1531 +((( 1532 + "text": "string" ~/~/ Текст подписи к этому интервалу 1533 + } 1534 + ] 1535 + } 1536 + ], 1537 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1538 + "customFields": [ ~/~/ Список произвольных полей 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1541 + "name": "string", ~/~/ Наименование произвольного поля 1542 + "value": "string", ~/~/ Значение произвольного поля 1543 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1544 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1545 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1546 + } 1547 + ], 1548 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1549 +} 1550 +))) 1551 +))) 1552 +))) 1106 1106 1554 + 1107 1107 **Валидация:** 1108 1108 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 1109 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 1110 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1111 1111 1112 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1560 +== (% 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, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1567 +(% 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 ~/~/ значение любого из произвольных полей ТС 1601 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1602 + "unitName": "string", ~/~/ Название подразделения (опционально) 1603 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1604 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1605 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1606 + "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" %){ 1613 +(% style="color:#000000" %)[ 1614 +{ 1163 1163 1616 +((( 1617 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1618 +))) 1619 + 1620 +((( 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" %)} 1646 +))) 1191 1191 1648 +((( 1649 + } 1650 + ], 1651 + "vehicleGroups": [ ~/~/ Группы ТС 1652 + { 1653 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1654 + "name": "string" ~/~/ Наименование группы ТС 1655 + } 1656 + ] 1657 + } 1658 +] 1659 +))) 1660 + 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 - 1696 +(% 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 1705 +== == 1706 + 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": [ ~/~/ Датчики 1794 +"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 ~/~/ Макс. значение 1845 + 1846 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1847 + { 1848 + "from": 0, ~/~/ С какого значения 1849 + "color": "string", ~/~/ Каким цветом 1850 + "text": "string" ~/~/ Текст подписи к этому интервалу 1851 + } 1852 + ] 1391 1391 } 1392 1392 ], 1855 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1856 + 1393 1393 "customFields": [ ~/~/ Произвольные поля 1394 - { 1395 - 1396 - "name": "string", 1397 - "value": "string", 1398 - "forClient": true, 1399 - "forTooltip": true, 1400 - "forReport": true 1858 + { 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1860 + "name": "string", ~/~/ Наименование произвольного поля 1861 + "value": "string", ~/~/ Значение произвольного поля 1862 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1863 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1864 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1401 1401 } 1402 1402 ] 1403 1403 } 1404 1404 1869 + 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" %){ 1872 +((( 1873 +{ 1874 + "vehicleId": 0, ~/~/ ID ТС 1875 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1876 + "name": "string", ~/~/ Имя объекта 1877 + "imei": "string", ~/~/ IMEI 1878 + "deviceTypeId": 0, ~/~/ ID типа устройства 1879 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1880 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1881 + "sim1": "string", ~/~/ SIM1 1882 + "sim2": "string", ~/~/ SIM2 1883 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1884 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1885 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1886 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1887 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1888 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1889 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1890 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1891 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1892 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1893 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1894 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1895 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1896 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1897 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1898 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1899 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1900 + "counters": { ~/~/ состояний счётчиков 1901 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1902 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1903 + "mileage": 0, ~/~/ Пробег 1904 + "motohours": 0 ~/~/ Моточасы 1905 + }, 1906 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1907 + "id": "string", ~/~/ CMSV6 Идентификатор 1908 + "enabled": true, ~/~/ Признак включения 1909 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1910 +))) 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 1912 + 1913 +((( 1914 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1915 + "login": "string", ~/~/ CMSV6 имя учетной записи 1916 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1917 + }, 1918 + "inspectionTasks": [ ~/~/ Задания на ТО 1919 + { 1920 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1921 + "enabled": true, ~/~/ Признак включения 1922 + "name": "string", ~/~/ Имя задания 1923 + "description": "string", ~/~/ Описание задания 1924 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1925 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1926 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1927 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1928 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1929 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1930 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1931 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1932 + } 1933 + ], 1934 + "drivers": [ ~/~/ Список водителей 1935 + { 1936 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1937 + "inputNumber": 0, ~/~/ № входа. 1938 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1939 + "comment": "string", ~/~/ Комментарий. 1940 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1941 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1942 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1943 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1944 + } 1945 + ], 1946 + "commandTemplates": [ ~/~/ Список шаблонов команд 1947 + { 1948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1949 + "name": "string", ~/~/ Название шаблона команд 1950 + "command": "string", ~/~/ Команда на выполнение 1951 + "retries": 0 ~/~/ Лимит попыток отправки 1952 + } 1953 + ], 1954 + "sensors": [ ~/~/ Список датчиков 1955 + { 1956 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1957 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1958 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1959 +))) 1960 + 1961 +((( 1962 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1963 +))) 1964 + 1965 +((( 1966 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 1967 +))) 1968 + 1969 +((( 1970 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 1971 +))) 1972 + 1973 +((( 1974 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 1975 +))) 1976 + 1977 +((( 1978 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1979 + "name": "string", ~/~/ Имя датчика 1980 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 1981 +))) 1982 + 1983 +((( 1984 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1985 + "inputNumber": 0, ~/~/ Номер входа 1986 + "pseudonym": "string", ~/~/ Псевдоним 1987 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1988 + "isInverted": true, ~/~/ Признак инверсии 1989 + "disabled": true, ~/~/ Датчик не участвует в обработке 1990 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1991 + "gradesTables": [ ~/~/ Тарировка 1430 1430 { 1431 - "id": ~/~/ идентификатор 1432 - "enabled": true, ~/~/ флаг включения 1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 - "login": "", ~/~/ имя учетной записи 1435 - "password": "", ~/~/ пароль учетной записи 1436 - } 1437 - "inspectionTasks": ~/~/ задания на ТО 1993 + "grades": [ ~/~/ Таблицы тарировки 1994 + { 1995 + "input": 0, ~/~/ Вход 1996 + "output": 0 ~/~/ Выход 1997 + } 1998 + ], 1999 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2000 + } 2001 + ], 2002 + "showInTooltip": true, ~/~/ Отображение в подсказке 2003 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2004 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2005 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2006 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2007 + "expr": "string", ~/~/ Выражение 2008 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2009 + "string" 2010 + ], 2011 + "customParams": { ~/~/ Дополнительные настройки 2012 + "additionalProp1": "string", 2013 + "additionalProp2": "string", 2014 + "additionalProp3": "string" 2015 + }, 2016 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2017 + "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": "", ~/~/ Сколько раз выполнить задание 2019 + "from": 0, ~/~/ С какого значения 2020 + "color": "string", ~/~/ Каким цветом 2021 + "text": "string" ~/~/ Текст подписи к этому интервалу 1450 1450 } 2023 + ] 2024 + } 2025 + ], 2026 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2027 + "customFields": [ ~/~/ Список произвольных полей 2028 + { 2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2030 + "name": "string", ~/~/ Наименование произвольного поля 2031 + "value": "string", ~/~/ Значение произвольного поля 2032 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2033 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2034 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2035 + } 2036 + ], 2037 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2038 +} 2039 +))) 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]]2079 +(% 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 - 2085 +(% 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 - 2109 +(% 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 2156 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2157 + 2158 +(% class="box infomessage" style="text-align: left;" %) 2159 +((( 2160 +**POST /api/v3/terminalMessages/mapping** 2161 +))) 2162 + 2163 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2164 + 2165 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2166 + 2167 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2168 + 2169 +{ 2170 + "protocolType": 0, 2171 + "params": ["string"] 2172 +} 2173 + 2174 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2175 +|protocolType|ID типа протокола 2176 +|params|((( 2177 +Массив наименований параметров в сообщении 2178 +))) 2179 + 2180 +Ответ: 2181 + 2182 +{ 2183 + "protocolType": 0, 2184 + "mapping": { 2185 + "additionalProp1": { 2186 + "inputType": 0, 2187 + "inputNumber": 0 2188 + }, 2189 + "additionalProp2": { 2190 + "inputType": 0, 2191 + "inputNumber": 0 2192 + } 2193 + } 2194 +} 2195 + 2196 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2197 +|protocolType|Тип протокола 2198 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2199 +|inputNumber|((( 2200 +Номер входа 2201 +))) 2202 + 2203 +(% class="wikigeneratedid" %) 2204 +Перечень 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/]] 2205 + 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 2230 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2231 +|vehicleId|ID объекта 2232 +|from|Дата и время начала периода запроса 2233 +|to|Дата и время окончания периода запроса 2234 + 1600 1600 Ответ: 1601 1601 1602 1602 [ ... ... @@ -1603,25 +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": { ~/~/ список параметров датчиков передаваемых терминалом 2241 + "deviceTime": "2023-11-29T07:40:44.052Z", 2242 + "serverTime": "2023-11-29T07:40:44.052Z", 2243 + "speed": 0, 2244 + "altitude": 0, 2245 + "latitude": 0, 2246 + "longitude": 0, 2247 + "satellites": 0, 2248 + "course": 0, 2249 + "voltage": 0, 2250 + "parameters": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 2255 + "photoCount": 0, 2256 + "lbsCorrectedCoords": true, 2257 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 2263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2264 +|deviceTime|Время сообщения терминала 2265 +|serverTime|Время когда сообщение поступило на сервер 2266 +|speed|Скорость 2267 +|altitude|Высота над уровнем моря 2268 +|latitude|Широта 2269 +|longitude|Долгота 2270 +|satellites|Кол-во спутников 2271 +|course|Курс 2272 +|voltage|Бортовое напряжение 2273 +|parameters|Список параметров и их значений 2274 +|photoCount|Количество фото 2275 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2276 +|protocolType|ID типа протокола 2277 + 1625 1625 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1626 1626 1627 1627 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1658,10 +1658,12 @@ 1658 1658 { 1659 1659 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1660 1660 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1661 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1662 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1663 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1664 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2314 + "mileage": 0, ~/~/ Пробег за период, километры 2315 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2316 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2317 + "motohours": 0, ~/~/ Моточасы за период, секунды 2318 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2319 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1665 1665 } 1666 1666 ] 1667 1667 } ... ... @@ -1710,6 +1710,12 @@ 1710 1710 } 1711 1711 ] 1712 1712 2368 +(% class="box warningmessage" %) 2369 +((( 2370 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2371 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2372 +))) 2373 + 1713 1713 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1714 1714 1715 1715 (% class="box infomessage" %) ... ... @@ -1755,6 +1755,96 @@ 1755 1755 } 1756 1756 ] 1757 1757 2419 + 2420 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2421 + 2422 +(% class="box infomessage" %) 2423 +((( 2424 +**POST /api/v3/vehicles/moveStop** 2425 +))) 2426 + 2427 +Метод запроса: **POST** 2428 + 2429 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2430 + 2431 +В заголовках запроса: X-Auth: Токен авторизации 2432 + 2433 + 2434 +Тело запроса: 2435 + 2436 +{ 2437 + "vehicleIds": [ ], ~/~/ Список ID объектов 2438 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2439 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2440 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2441 +} 2442 + 2443 +Ответ: 2444 + 2445 +[ 2446 + { 2447 + "vehicleId": 0, ~/~/ ID объекта 2448 + "vehicleName": "string", ~/~/ Имя объекта 2449 + "moves": [ ~/~/ Событие движения 2450 + { 2451 + "mileage": 0, ~/~/ Пробег, км 2452 + "eventId": 0, ~/~/ Идентификатор события 2453 + "eventName": "string", ~/~/ Название события 2454 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2455 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2456 + "duration": 0 ~/~/ Продолжительность события, секунд 2457 + } 2458 + ], 2459 + "stops": [ ~/~/ События стоянок 2460 + { 2461 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2462 + "eventId": 0, ~/~/ Идентификатор события 2463 + "eventName": "string", ~/~/ Название события 2464 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2465 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2466 + "duration": 0 ~/~/ Продолжительность события, секунд 2467 + } 2468 + ] 2469 + } 2470 +] 2471 + 2472 + 2473 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2474 + 2475 +(% class="box infomessage" %) 2476 +((( 2477 +**POST /api/v3/vehicles/getlastdata** 2478 +))) 2479 + 2480 +Метод запроса: **POST** 2481 + 2482 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2483 + 2484 +В заголовках запроса: X-Auth: Токен авторизации 2485 + 2486 + 2487 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2488 + 2489 +Ответ: 2490 + { 2491 + "vehicleId": 0, ~/~/Идентификатор объекта. 2492 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2493 + "vehicleNumber": "string",~/~/Номер объекта. 2494 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2495 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2496 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2497 + "speed": 0,~/~/Скорость объекта. 2498 + "course": 0,~/~/Курс движения [0;360] 2499 + "latitude": 0,~/~/Широта [-90°;90°]. 2500 + "longitude": 0,~/~/Долгота [-180°;180°]. 2501 + "address": "string",~/~/Адрес. 2502 + "geozones": [ ~/~/Сведения по геозонам. 2503 + { 2504 + "id": 0, 2505 + "name": "string" 2506 + } 2507 + 2508 + 1758 1758 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1759 1759 1760 1760 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -1768,7 +1768,7 @@ 1768 1768 1769 1769 (% style="color:#000000" %)Метод запроса: **POST** 1770 1770 1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find2522 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1772 1772 1773 1773 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 1774 ... ... @@ -2062,6 +2062,32 @@ 2062 2062 2063 2063 Success 2064 2064 2816 + 2817 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2818 + 2819 +(% class="box warningmessage" %) 2820 +((( 2821 +**PUT** /api/v3/notifications/prolongation 2822 +))) 2823 + 2824 +Метод позволяет продлить уведомления. 2825 + 2826 +Метод запроса **PUT** 2827 + 2828 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2829 + 2830 +В заголовках запроса: X-Auth: Токен авторизации. 2831 + 2832 +Тело запроса: 2833 + 2834 +[ 2835 + 2836 +0 2837 + 2838 +] 2839 + 2840 +где 0 идентификатор ids. 2841 + 2065 2065 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2066 2066 2067 2067 (% class="box errormessage" %) ... ... @@ -2653,6 +2653,83 @@ 2653 2653 Success 2654 2654 2655 2655 3433 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3434 + 3435 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3436 + 3437 +(% class="box infomessage" %) 3438 +((( 3439 +**POST /api/v3/Trailers** 3440 +))) 3441 + 3442 +Пример запроса: 3443 + 3444 +{ 3445 + "startDate": "2023-11-14T10:48:03.671Z", 3446 + "endDate": "2023-11-14T10:48:03.671Z", 3447 + "ids": [ 0 ], 3448 + "timezone": 0 3449 +} 3450 + 3451 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3452 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3453 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3454 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3455 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3456 + 3457 +Пример ответа: 3458 + 3459 +[ 3460 + { 3461 + "SD": "2023-11-14T10:48:03.717Z", 3462 + "ED": "2023-11-14T10:48:03.717Z", 3463 + "id": 0, 3464 + "SLat": 0, 3465 + "SLon": 0, 3466 + "ELat": 0, 3467 + "ELon": 0, 3468 + "mileage": 0 3469 + "Duration": 0 3470 + "Address": "string", 3471 + "Address2": "string", 3472 + "name": "string", 3473 + "rid": "string", 3474 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3475 + "trailer": { 3476 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3477 + "Number": "string", 3478 + "Description": "string", 3479 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3480 + "ExternalID": "string", 3481 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3482 + "CreateTime": "2023-11-14T10:48:03.717Z", 3483 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3484 + "IsDeleted": true 3485 + }, 3486 + "filesCount": 0, 3487 + } 3488 +] 3489 + 3490 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3491 +|SD|Дата и время начала события 3492 +|ED|Дата и время окончания события 3493 +|id|ID объекта 3494 +|SLat|Широта начальной координаты 3495 +|SLon|Долгота начальной координаты 3496 +|ELat|Широта конечной координаты 3497 +|ELon|Долгота конечной координаты 3498 +|mileage|Пробег 3499 +|Duration|Продолжительность 3500 +|Address|Адрес начального местоположения 3501 +|Address2|Адрес конечного местоположения 3502 +|name|Имя радиометки 3503 +|rid|Номер радиометки 3504 +|rguid|ID радиометки 3505 +|trailer|Информация об агрегате 3506 +|ModelGuid|ID агрегата 3507 +|Number|Название/номер агрегата 3508 +|Description|Текст примечания агрегата 3509 + 2656 2656 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2657 2657 2658 2658 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2674,13 +2674,18 @@ 2674 2674 { 2675 2675 "name": "string", 2676 2676 "number": 0, 2677 - "period": 0, ~/~/ Частота трансляции радиометки3531 + "period": 0, 2678 2678 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2679 2679 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2680 - "deleted": true 2681 2681 } 2682 2682 ] 2683 2683 3537 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3538 +|parentId|ID клиента 3539 +|name|Название карты-метки 3540 +|number|Номер 3541 +|period|Период запросов в секундах (работает только для агрегатов) 3542 +|id|ID карты-метки 2684 2684 2685 2685 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2686 2686 ... ... @@ -2697,13 +2697,18 @@ 2697 2697 { 2698 2698 "name": "string", 2699 2699 "number": 0, 2700 - "period": 0, ~/~/ Частота трансляции радиометки3559 + "period": 0, 2701 2701 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2702 2702 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2703 - "deleted": true 2704 2704 } 2705 2705 ] 2706 2706 3565 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3566 +|name|Название карты-метки 3567 +|number|Номер 3568 +|period|Период запросов в секундах (работает только для агрегатов) 3569 +|id|ID карты-метки 3570 +|parentId|ID клиента 2707 2707 2708 2708 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2709 2709 ... ... @@ -2719,7 +2719,6 @@ 2719 2719 "number": 0, 2720 2720 "period": 0, 2721 2721 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2722 - "deleted": true 2723 2723 } 2724 2724 2725 2725 Ответ: ... ... @@ -2730,9 +2730,14 @@ 2730 2730 "period": 0, 2731 2731 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2732 2732 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2733 - "deleted": true 2734 2734 } 2735 2735 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 клиента 2736 2736 2737 2737 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2738 2738 ... ... @@ -2749,7 +2749,6 @@ 2749 2749 "period": 0, 2750 2750 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2751 2751 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2752 - "deleted": true 2753 2753 } 2754 2754 2755 2755 Ответ: ... ... @@ -2760,9 +2760,14 @@ 2760 2760 "period": 0, 2761 2761 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2762 2762 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2763 - "deleted": true 2764 2764 } 2765 2765 3632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3633 +|name|Название карты-метки 3634 +|number|Номер 3635 +|period|Период запросов в секундах (работает только для агрегатов) 3636 +|id|ID карты-метки 3637 +|parentId|ID клиента 2766 2766 2767 2767 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2768 2768 ... ... @@ -2771,7 +2771,7 @@ 2771 2771 **DELETE /api/v3/Rfids/{rfidGuid}** 2772 2772 ))) 2773 2773 2774 -Передаем параметр rfidGuid - идентификатор карты-метки 3646 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2775 2775 2776 2776 Ответ: 2777 2777 ... ... @@ -2778,6 +2778,1083 @@ 2778 2778 Success 2779 2779 2780 2780 3653 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3654 + 3655 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3656 + 3657 +(% class="box infomessage" %) 3658 +((( 3659 +**GET /api/v3/Billing/client/balance/{clientId}** 3660 +))) 3661 + 3662 +Параметр запроса: **clientId **- идентификатор клиента. 3663 + 3664 +Ответ: 3665 + 3666 +{ 3667 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3668 + "Balance": 0 3669 +} 3670 + 3671 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3672 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3673 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3674 + 3675 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3676 + 3677 +(% class="box infomessage" %) 3678 +((( 3679 +**GET /api/v3/Billing/client/constraint/{clientId}** 3680 +))) 3681 + 3682 +Параметр запроса: **clientId **- идентификатор клиента. 3683 + 3684 +Ответ: 3685 + 3686 +{ 3687 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3688 + "CalculationType": 0, 3689 + "PermissibleBalance": 0, 3690 + "DefermentDays": 0, 3691 + "SendUiNotifications": true, 3692 + "SendEmailNotifications": true, 3693 + "IsPrivate": true, 3694 +} 3695 + 3696 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3697 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3698 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3699 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3700 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3701 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3702 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3703 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3704 + 3705 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3706 + 3707 +(% class="box infomessage" %) 3708 +((( 3709 +**GET /api/v3/Billing/client/plan/{clientId}** 3710 +))) 3711 + 3712 +Параметры запроса: 3713 + 3714 +**clientId **- идентификатор клиента. 3715 + 3716 +**planId **- идентификатор тарифного плана. 3717 + 3718 +Ответ: 3719 + 3720 +{ 3721 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3722 + "Plan": { **~/~/ Описание тарифного плана** 3723 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3724 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3725 + "Name": "string", 3726 + "IsArchived": true, 3727 + "Constraint": { 3728 + "CalculationType": 0, 3729 + "PermissibleBalance": 0, 3730 + "DefermentDays": 0 3731 + }, 3732 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3733 + { 3734 + "Feature": "string", 3735 + "IsFactual": true, 3736 + "Limit": 0, 3737 + "Price": 0, 3738 + "PeriodValue": 0, 3739 + "PeriodType": 0 3740 + } 3741 + ] 3742 + }, 3743 + "DebitDate": "2023-10-18T12:46:24.213Z", 3744 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3745 + { 3746 + "Feature": "string", 3747 + "IsEnabled": true, 3748 + "IsPrivate": true, 3749 + "IsFactual": true, 3750 + "Limit": 0, 3751 + "Price": 0, 3752 + "DebitDate": "2023-10-18T12:46:24.213Z", 3753 + "PeriodValue": 0, 3754 + "PeriodType": 0 3755 + } 3756 + ] 3757 +} 3758 + 3759 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3760 +|ClientId|Идентификатор клиента 3761 +|Id|Идентификатор тарифного плана 3762 +|OwnerId|Идентификатор клиента-владельца 3763 +|Name|Наименование тарифного плана 3764 +|IsArchived|Признак, определяющий архивный тарифный план 3765 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3766 +|PermissibleBalance|Допустимый баланс 3767 +|DefermentDays|Отсрочка, количество дней 3768 +|Feature|Код услуги 3769 +|IsEnabled|Признак, определяющий активирована ли услуга 3770 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3771 +|IsFactual|Признак, определяющий расчёт по факту 3772 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3773 +|Price|Цена за единицу. 3774 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3775 +|PeriodValue|Значение периода. 3776 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3777 + 3778 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3779 + 3780 +(% class="box infomessage" %) 3781 +((( 3782 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3783 +))) 3784 + 3785 +Параметр запроса: **clientId **- идентификатор клиента. 3786 + 3787 +Ответ: 3788 + 3789 +[ 3790 + { 3791 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3792 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3793 + "Name": "string", 3794 + "IsArchived": true, 3795 + "Constraint": { 3796 + "CalculationType": 0, 3797 + "PermissibleBalance": 0, 3798 + "DefermentDays": 0 3799 + }, 3800 + "Features": [ 3801 + { 3802 + "Feature": "string", 3803 + "IsFactual": true, 3804 + "Limit": 0, 3805 + "Price": 0, 3806 + "PeriodValue": 0, 3807 + "PeriodType": 0 3808 + } 3809 + ] 3810 + } 3811 +] 3812 + 3813 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3814 +|ClientId|Идентификатор клиента 3815 +|Id|Идентификатор тарифного плана 3816 +|OwnerId|Идентификатор клиента-владельца 3817 +|Name|Наименование тарифного плана 3818 +|IsArchived|Признак, определяющий архивный тарифный план 3819 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3820 +|PermissibleBalance|Допустимый баланс 3821 +|DefermentDays|Отсрочка, количество дней 3822 +|Feature|Код услуги 3823 +|IsFactual|Признак, определяющий расчёт по факту 3824 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3825 +|Price|Цена за единицу. 3826 +|PeriodValue|Значение периода. 3827 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3828 + 3829 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3830 + 3831 +(% class="box infomessage" %) 3832 +((( 3833 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3834 +))) 3835 + 3836 +Параметр запроса: **clientId **- идентификатор клиента. 3837 + 3838 +Ответ: 3839 + 3840 +[ 3841 + { 3842 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3843 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3844 + "Name": "string", 3845 + "IsArchived": true, 3846 + "Constraint": { 3847 + "CalculationType": 0, 3848 + "PermissibleBalance": 0, 3849 + "DefermentDays": 0 3850 + }, 3851 + "Features": [ 3852 + { 3853 + "Feature": "string", 3854 + "IsFactual": true, 3855 + "Limit": 0, 3856 + "Price": 0, 3857 + "PeriodValue": 0, 3858 + "PeriodType": 0 3859 + } 3860 + ] 3861 + } 3862 +] 3863 + 3864 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3865 +|ClientId|Идентификатор клиента 3866 +|Id|Идентификатор тарифного плана 3867 +|OwnerId|Идентификатор клиента-владельца 3868 +|Name|Наименование тарифного плана 3869 +|IsArchived|Признак, определяющий архивный тарифный план 3870 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3871 +|PermissibleBalance|Допустимый баланс 3872 +|DefermentDays|Отсрочка, количество дней 3873 +|Feature|Код услуги 3874 +|IsFactual|Признак, определяющий расчёт по факту 3875 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3876 +|Price|Цена за единицу. 3877 +|PeriodValue|Значение периода. 3878 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3879 + 3880 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3881 + 3882 +(% class="box warningmessage" %) 3883 +((( 3884 +**PUT /api/v3/Billing/client/balance** 3885 +))) 3886 + 3887 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3888 + 3889 +Тело запроса: 3890 + 3891 +{ 3892 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3893 + "Balance": 0 3894 +} 3895 + 3896 +Ответ: Success 3897 + 3898 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3899 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3900 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3901 + 3902 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3903 + 3904 +(% class="box warningmessage" %) 3905 +((( 3906 +**PUT /api/v3/billing/client/balance/deposit** 3907 +))) 3908 + 3909 +Создает операцию **Пополнение **с указанной суммой 3910 + 3911 +Тело запроса: 3912 + 3913 +{ 3914 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3915 + "Balance": 0 3916 +} 3917 + 3918 +Ответ: Success 3919 + 3920 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3921 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3922 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3923 + 3924 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3925 + 3926 +Создает операцию **Списание **с указанной суммой 3927 + 3928 +(% class="box warningmessage" %) 3929 +((( 3930 +**PUT /api/v3/billing/client/balance/withdraw** 3931 +))) 3932 + 3933 +Тело запроса: 3934 + 3935 +{ 3936 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3937 + "Balance": 0 3938 +} 3939 + 3940 +Ответ: Success 3941 + 3942 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3943 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3944 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3945 + 3946 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3947 + 3948 +(% class="box warningmessage" %) 3949 +((( 3950 +**PUT /api/v3/Billing/client/constraint** 3951 +))) 3952 + 3953 +Тело запроса: 3954 + 3955 +{ 3956 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3957 + "CalculationType": 0, 3958 + "PermissibleBalance": 0, 3959 + "DefermentDays": 0, 3960 + "SendUiNotifications": true, 3961 + "SendEmailNotifications": true, 3962 + "IsPrivate": true, 3963 +} 3964 + 3965 +Ответ: Success 3966 + 3967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3968 +|ClientId|Идентификатор клиента 3969 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3970 +|PermissibleBalance|Допустимый баланс 3971 +|DefermentDays|((( 3972 +Отсрочка, количество дней 3973 +))) 3974 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3975 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3976 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3977 + 3978 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3979 + 3980 +(% class="box warningmessage" %) 3981 +((( 3982 +**PUT /api/v3/Billing/client/plan** 3983 +))) 3984 + 3985 +Тело запроса: 3986 + 3987 +{ 3988 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3989 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3990 + "Features": [ 3991 + { 3992 + "Feature": "string", 3993 + "IsEnabled": true, 3994 + "IsFactual": true, 3995 + "Limit": 0, 3996 + "Price": 0, 3997 + "DebitDate": "2023-10-18T13:26:58.987Z", 3998 + "PeriodValue": 0, 3999 + "PeriodType": 0 4000 + } 4001 + ] 4002 +} 4003 + 4004 +Ответ: Success 4005 + 4006 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4007 +|ClientId|Идентификатор клиента 4008 +|PlanId|Идентификатор тарифного плана 4009 +|Feature|Код услуги 4010 +|IsEnabled|Признак, определяющий активирована ли услуга 4011 +|IsFactual|Признак, определяющий расчёт по факту 4012 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4013 +|Price|Цена за единицу. 4014 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4015 +|PeriodValue|Значение периода. 4016 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4017 + 4018 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4019 + 4020 +(% class="box warningmessage" %) 4021 +((( 4022 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4023 +))) 4024 + 4025 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4026 + 4027 +(% class="box infomessage" %) 4028 +((( 4029 +**POST /api/v3/vehicles/import/{agentId}** 4030 +))) 4031 + 4032 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4033 + 4034 +В пути указывается **agentId** - id клиента. 4035 + 4036 +**Заголовок** 4037 + 4038 +**X-Auth: [токен авторизации]** 4039 + 4040 +**Параметры** 4041 + 4042 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4043 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4044 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4045 + 4046 +В теле использовать тип **form-data,** тип значения** file** 4047 + 4048 +**Ключи** 4049 + 4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4051 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4052 +|csv|В значении передаем файл датчиков, формат **csv** 4053 + 4054 +Ответ: 4055 + 4056 +{ 4057 + "vehicleId": 0, 4058 + "name": "string", 4059 + "errors": ["string"] 4060 +} 4061 + 4062 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4063 +|vehicleId|ID созданного объекта 4064 +|name|Имя созданного объекта 4065 +|errors|Ошибки и их описание 4066 + 4067 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4068 + 4069 +(% class="box infomessage" %) 4070 +((( 4071 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4072 +))) 4073 + 4074 +(% class="wikigeneratedid" %) 4075 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4076 + 4077 +(% class="wikigeneratedid" %) 4078 +В пути указывается **vehicleId **- id объекта. 4079 + 4080 +**Заголовок** 4081 + 4082 +**X-Auth: [токен авторизации]** 4083 + 4084 +В теле использовать тип **form-data.** 4085 + 4086 +Ключи: 4087 + 4088 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4089 +|**history**|В значении передавать файл с историей 4090 + 4091 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4092 + 4093 +Ответ: 4094 + 4095 +{ 4096 + "results": [ 4097 + { 4098 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4099 + "vehicleId": 0, 4100 + "errors": [ 4101 + "string" 4102 + ], 4103 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4104 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4105 + "producedCount": 0, 4106 + "msgCount": 0 4107 + } 4108 + ] 4109 +} 4110 + 4111 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4112 +|results|Результаты импорта в разрезе ТС 4113 +|vehicleGuid|Guid ТС 4114 +|vehicleId|ID ТС 4115 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4116 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4117 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4118 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4119 +|msgCount|Кол-во обработанных сообщений всего 4120 + 4121 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4122 + 4123 +(% class="box infomessage" %) 4124 +((( 4125 +**GET /api/v3/vehicles/import/history/status** 4126 +))) 4127 + 4128 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4129 + 4130 +Ответ: 4131 + 4132 +{ 4133 + "activity": true, 4134 + "progress": 0, 4135 + "message": "string" 4136 +} 4137 + 4138 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4139 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4140 +|progress|Guid ТС 4141 + 4142 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4143 + 4144 +(% class="box infomessage" %) 4145 +((( 4146 +**POST /api/v3/vehicles/export** 4147 +))) 4148 + 4149 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4150 + 4151 +Тело запроса: 4152 + 4153 +[ 4154 + id 4155 +] 4156 + 4157 +Ответ: Success 200, получаете файлы с настройками. 4158 + 4159 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4160 + 4161 +(% class="box infomessage" %) 4162 +((( 4163 +**POST /api/v3/vehicles/export/history** 4164 +))) 4165 + 4166 +Метод возвращает список сообщений терминала объекта за выбранный период. 4167 + 4168 +Тело запроса: 4169 + 4170 +{ 4171 + "vehicleId": 0, 4172 + "asArchive": true, 4173 + "from": "2023-09-27T12:17:45.973Z", 4174 + "to": "2023-09-27T12:17:45.973Z" 4175 +} 4176 + 4177 +Ответ: 4178 + 4179 +Получаете файл. Сообщение: Code 200/Success 4180 + 4181 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4182 +|vehicleId|ID объекта 4183 +|asArchive|true - Архивировать файл, False - не архивировать 4184 +|from|Дата и время начала запроса 4185 +|to|Дата и время окончания запроса 4186 + 4187 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4188 + 4189 +(% class="box infomessage" %) 4190 +((( 4191 +**GET /api/v3/vehicles/export/history/status** 4192 +))) 4193 + 4194 +Метод возвращает список сообщений терминала объекта за выбранный период. 4195 + 4196 +Ответ: 4197 + 4198 +{ 4199 + "activity": true, 4200 + "progress": 0, 4201 + "message": "string" 4202 +} 4203 + 4204 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4205 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4206 +|progress|Прогресс экспорта, от 0 до 100% 4207 +|message|Текст описывающий статус 4208 + 4209 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4210 + 4211 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4212 + 4213 +(% class="box infomessage" %) 4214 +((( 4215 +**POST /api/v3/EcoDriving/rating** 4216 +))) 4217 + 4218 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4219 + 4220 +Тело запроса: 4221 + 4222 +{ 4223 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4224 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4225 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4226 +} 4227 + 4228 +Ответ: 4229 + 4230 +{ 4231 + "items": [ ~/~/ Список в разрезе ТС 4232 + { 4233 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4234 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4235 + "vehicleId": 0, ~/~/ ID ТС 4236 + "vehicleName": "string", ~/~/ Название ТС 4237 + "vehicleModel": "string", ~/~/ Модель ТС 4238 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4239 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4240 + "totalViolations": 0, ~/~/ Нарушений всего 4241 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4242 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4243 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4244 + "brakingViolations": 0, ~/~/ Нарушений торможения 4245 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4246 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4247 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4248 + }, 4249 + 4250 +((( 4251 + 4252 +))) 4253 + 4254 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4255 + "mileage": 0, ~/~/ Пробег, м 4256 + "tripsCount": 0, ~/~/ Кол-во рейсов 4257 + "trips": [ ~/~/ Информация по рейсу 4258 + { 4259 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4260 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4261 + "violationsCount": 0, ~/~/ Всего нарушений 4262 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4263 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4264 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4265 + "brakingViolations": 0, ~/~/ Нарушений торможения 4266 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4267 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4268 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4269 + }, 4270 + 4271 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4272 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4273 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4274 + "mileage": 0, ~/~/ Пробег, м 4275 + "motohours": 0, ~/~/ Моточасы, секунды 4276 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4277 + "startAddress": "string", ~/~/ Адрес начала рейса 4278 + "endAddress": "string", ~/~/ Адрес конца рейса 4279 + "drivers": [ ~/~/ Список водителей 4280 + { 4281 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4282 + "driverName": "string", ~/~/ФИО водителя 4283 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4284 + } 4285 + ] 4286 + } 4287 + ] 4288 + } 4289 + ] 4290 +} 4291 + 4292 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4293 + 4294 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4295 + 4296 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4297 + 4298 +(% class="box infomessage" %) 4299 +((( 4300 +POST /api/v3/fuelcards/transactions 4301 +))) 4302 + 4303 +Метод запроса: POST 4304 + 4305 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4306 +\\В заголовках запроса: X-Auth: Токен авторизации 4307 + 4308 +Параметры в теле запроса (JSON): 4309 + 4310 +{ 4311 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4312 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4313 + "ids": [ 4314 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4315 + ], 4316 + "timezone": 0 ~/~/Таймзона 4317 +} 4318 + 4319 + 4320 +Ответ: 4321 + { 4322 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4323 + "driver": "string", ~/~/Водители, привязанные к ТК 4324 + "object": "string", ~/~/Наименование ТС 4325 + "amount": 0, ~/~/Количество топлива 4326 + "amountDut": 0, ~/~/Количество по ДУТ 4327 + "amountDiff": 0, ~/~/Разница, л 4328 + "amountDiffPerc": 0, ~/~/Разница, % 4329 + "summa": 0, ~/~/Стоимость, руб 4330 + "serviceName": "string", ~/~/Тип топлива 4331 + "price": 0, ~/~/Цена за литр, руб 4332 + "cardName": "string", ~/~/Наименование ТК 4333 + "cardNum": "string", ~/~/Номер ТК 4334 + "operator": "string", ~/~/Оператор ТК 4335 + "address": "string" ~/~/Адрес АЗС 4336 + } 4337 + 4338 + 4339 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4340 + 4341 + 4342 +== **Получение полных данных о ретрансляторе** == 4343 + 4344 +(% class="box infomessage" %) 4345 +((( 4346 +**GET ** **/api/v3/retranslations/{id}** 4347 +))) 4348 + 4349 +Идентификатор запроса: ID 4350 + 4351 + 4352 +Пример ответа: 4353 + 4354 +{ 4355 +"description": "", ~/~/ Определяет описание 4356 +"subscriberId": "", ~/~/ Подписчик 4357 +"protocolType": 0, ~/~/ Тип протокола 4358 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4359 +"address": "string", ~/~/ Адрес события 4360 +"objects": [ ~/~/Объекты для ретрансляции 4361 +{ 4362 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4363 +"name": "", ~/~/ Наименование объекта ретрансляции 4364 +"imei": "", ~/~/ IMEI объекта 4365 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4366 +} 4367 + ], 4368 +"id": "", ~/~/ идентификатор пользователя 4369 +"parentId": "", ~/~/Guid родителя 4370 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4371 +} 4372 + 4373 + 4374 +== **Удаление данных ретранслятора** == 4375 + 4376 +(% class="box infomessage" %) 4377 +((( 4378 +**DELETE** **/api/v3/retranslations/{id}** 4379 +))) 4380 + 4381 +Параметр запроса: ID 4382 + 4383 + 4384 +== **Создание ретранслятора** == 4385 + 4386 +(% class="box infomessage" %) 4387 +((( 4388 +**POST ** **/api/v3/retranslations/{id}** 4389 +))) 4390 + 4391 +Запрос: 4392 + 4393 +{ 4394 +"description": "", ~/~/ Описание 4395 +"subscriberId": "", ~/~/ Подписчик 4396 +"protocolType": 0, ~/~/ Тип протокола 4397 +"address": "", ~/~/ Адрес ретрансляции 4398 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4399 +"objects": [ ~/~/Объекты для ретрансляции 4400 +{ 4401 +"id": "", ~/~/ идентификатор пользователя 4402 +"imei": "", ~/~/IMEI объекта 4403 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4404 +} 4405 + ] 4406 +} 4407 + 4408 + 4409 +Ответ: 4410 + 4411 +{ 4412 +"description": "string", ~/~/ Определяет описание 4413 +"subscriberId": "", ~/~/ идентификатор запроса 4414 +"protocolType": 0, ~/~/ Тип протокола 4415 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4416 +"address": "", ~/~/ Адрес события 4417 +"objects": [ ~/~/Объекты для ретрансляции 4418 +{ 4419 +"id": "", ~/~/ идентификатор пользователя 4420 +"name": "string", ~/~/ Название уведомления 4421 +"imei": "string", ~/~/IMEI объекта 4422 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4423 +} 4424 + ], 4425 +"id": "", ~/~/ идентификатор пользователя 4426 +"parentId": "", ~/~/ Guid идентификатор родителя 4427 +"deleted": true ~/~/ Признак удаления 4428 +} 4429 + 4430 + 4431 +== **Редактирование ретранслятора** == 4432 + 4433 +(% class="box infomessage" %) 4434 +((( 4435 +**PUT** **/api/v3/retranslations** 4436 +))) 4437 + 4438 +Пример запроса: 4439 + 4440 +{ 4441 +"id": "", ~/~/ идентификатор пользователя 4442 +"description": "string", ~/~/ Определяет описание 4443 +"subscriberId": "", ~/~/ идентификатор запроса 4444 +"protocolType": 0, ~/~/ Тип протокола 4445 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4446 +"address": "string", ~/~/ Адрес события 4447 +"objects": ~/~/Объекты для ретрансляции 4448 +[ 4449 +{ 4450 +"id": "", ~/~/ идентификатор пользователя 4451 +"imei": "", ~/~/IMEI объекта 4452 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4453 +} 4454 + ] 4455 +} 4456 + 4457 + 4458 +Пример ответа: 4459 + 4460 +{ 4461 +"description": "", ~/~/ Определяет описание 4462 +"subscriberId": "", ~/~/ идентификатор запроса 4463 +"protocolType": 0, ~/~/ Тип протокола 4464 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4465 +"address": "string", ~/~/ Адрес события 4466 +"objects": [ ~/~/Объекты для ретрансляции 4467 +{ 4468 +"id": "", ~/~/ идентификатор пользователя 4469 +"name": "string", ~/~/ Название уведомления 4470 +"imei": "", ~/~/IMEI объекта 4471 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4472 +} 4473 + ], 4474 +"id": "", ~/~/ идентификатор пользователя 4475 +"parentId": "", ~/~/ Guid идентификатор родителя 4476 +"deleted": true ~/~/ Признак удаления 4477 +} 4478 + 4479 + 4480 +== **Получение списка ретранслятора клиента** == 4481 + 4482 +(% class="box infomessage" %) 4483 +((( 4484 +**POST /api/v3/retranslations/find** 4485 +))) 4486 + 4487 +Пример запроса: 4488 + 4489 +{ 4490 +"id": "", ~/~/ идентификатор пользователя 4491 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4492 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4493 +} 4494 + 4495 +Ответ: 4496 + 4497 +[ 4498 +{ 4499 +"description": "", ~/~/ Определяет описание 4500 +"subscriberId": "", ~/~/ идентификатор запроса 4501 +"protocolType": 0, ~/~/ Тип протокола 4502 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4503 +"address": "string", ~/~/ Адрес события 4504 +"id": "", ~/~/ идентификатор пользователя 4505 +"parentId": "", ~/~/ Guid идентификатор родителя 4506 +"deleted": true ~/~/ Признак удаления 4507 +} 4508 +] 4509 + 4510 + 4511 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4512 + 4513 +== **API для отчета по выгрузке комбайнов** == 4514 + 4515 +(% class="box infomessage" %) 4516 +((( 4517 +POST **/api/v3/Reports/harvesterUnloading** 4518 +))) 4519 + 4520 +Пример запроса: 4521 + 4522 +{ 4523 + "byTime": 0, ~/~/ Объединение событий по времени 4524 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4525 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4526 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4527 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4528 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4529 + 0 4530 + ], 4531 + "from": "", ~/~/ Дата и время начало запроса 4532 + "to": "", ~/~/ Дата и время окончания запроса 4533 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4534 +} 4535 + 4536 +Пример ответа: 4537 + 4538 +[ 4539 + { 4540 + "harvesterName": "", ~/~/Комбайн, номер 4541 + "harvesterId": 0, ~/~/Комбайн, id 4542 +"harvesterModel": "", ~/~/ Модель комбайна 4543 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4544 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4545 + "events": [ ~/~/Список событий в разрезе комбайна 4546 + { 4547 + "driverId": "", ~/~/Идентификатор водителя 4548 + "driverName": "", ~/~/Водитель комбайна, ФИО 4549 + "RFID": "", ~/~/ идентификатор карты-метки 4550 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4551 + "vehicleId": 0, ~/~/идентификатор объекта 4552 + "vehicleName": "string", ~/~/ Имя объекта 4553 + "modelName": "string", ~/~/ Имя модели объекта 4554 + "nearestVehicles": [ ~/~/Объекты рядом 4555 + { 4556 + "vehicleId": 0, ~/~/идентификатор объекта 4557 + "vehicleName": "string" ~/~/ Имя объекта 4558 + } 4559 + ], 4560 + "fields": [ ~/~/Поля, где происходила выгрузка 4561 + { 4562 + "id": 0, ~/~/ идентификатор пользователя 4563 + "name": "string" ~/~/ имя пользователя 4564 + } 4565 + ], 4566 + "event": "string", ~/~/Событие 4567 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4568 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4569 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4570 + "cultureName": "string", ~/~/ название культуры 4571 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4572 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4573 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4574 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4575 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4576 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4577 + "issued": 0, ~/~/Выдано, бункеров 4578 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4579 + "latitude": 0, ~/~/Широта 4580 + "longitude": 0, ~/~/ Долгота 4581 + "litresAway": 0, ~/~/Отдано, л 4582 + "m3Away": 0 ~/~/Отдано, м3 4583 + } 4584 + ] 4585 + } 4586 +] 4587 + 4588 + 4589 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4590 + 4591 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4592 + 4593 + 4594 +(% class="box infomessage" %) 4595 +((( 4596 +GET api/v3/Vehicles/recyclebin/all 4597 +))) 4598 + 4599 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4600 + 4601 +Параметр запроса: {parentId} - идентификатор агента 4602 + 4603 +В заголовках запроса: X-Auth: Токен авторизации 4604 + 4605 +Ответ: 4606 + 4607 +[ 4608 + { 4609 + "recordTime": "", ~/~/Время записи 4610 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4611 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4612 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4613 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4614 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4615 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4616 + "items": [ ~/~/ 4617 +nullable: true ~/~/Детали 4618 + { 4619 + "name": "string", ~/~/наименование столбца 4620 + "value": "string" ~/~/содержание столбца 4621 + } 4622 + ] 4623 + }, 4624 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4625 + "string" 4626 + ] 4627 + } 4628 +] 4629 + 4630 + 4631 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4632 + 4633 +(% class="box infomessage" %) 4634 +((( 4635 +POST/api/v3/Vehicles/recyclebin/erase 4636 +))) 4637 + 4638 +В заголовках запроса: X-Auth: Токен авторизации 4639 + 4640 +Пример запроса: 4641 + 4642 +[ 4643 +0 4644 +] 4645 + 4646 + 4647 +Пример ответа: 4648 + 4649 +[ 4650 +{ 4651 + "recordTime": "", ~/~/Время записи 4652 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4653 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4654 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4655 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4656 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4657 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4658 + "items": [ ~/~/Детали 4659 + { 4660 + "name": "", ~/~/Имя свойства 4661 + "value": "" ~/~/Значение свойства 4662 + } 4663 + ] 4664 + }, 4665 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4666 + "" 4667 + ] 4668 + } 4669 +] 4670 + 4671 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4672 + 4673 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4674 + 4675 +(% class="box infomessage" %) 4676 +((( 4677 +POST/api/v3/Vehicles/recyclebin/restore 4678 +))) 4679 + 4680 +В заголовках запроса: X-Auth: Токен авторизации 4681 + 4682 +Параметры в теле запроса (JSON): 4683 + 4684 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4685 + 4686 +В заголовках запроса: X-Auth: Токен авторизации 4687 + 4688 + 4689 +Пример запроса: 4690 + 4691 +((( 4692 +[ 4693 +))) 4694 + 4695 +((( 4696 + 0 4697 +))) 4698 + 4699 +((( 4700 +] 4701 +))) 4702 + 4703 + 4704 +Пример ответа: 4705 + 4706 +[ 4707 +{ 4708 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4709 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4710 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4711 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4712 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4713 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4714 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4715 + "items": [ ~/~/Детали 4716 + { 4717 + "name": "string", ~/~/Имя свойства 4718 + "value": "string" ~/~/Значение свойства 4719 + } 4720 + ] 4721 + }, 4722 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4723 + "string" 4724 + ] 4725 + } 4726 +] 4727 + 4728 + 4729 + 2781 2781 (% class="box" lang="en-US" style="text-align: center;" %) 2782 2782 ((( 2783 2783 (% 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