Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/20 09:52
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.krainovim - Content
-
... ... @@ -14,13 +14,13 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При **редактировании**необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,25 +40,21 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 + 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 - "User": "testuser" , ~/~/ имя пользователя(%%) 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" %) 49 49 } 50 50 51 51 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 52 52 53 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 54 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 55 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 56 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 57 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 58 - 59 -(% class="wikigeneratedid" %) 60 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 61 - 62 62 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 63 63 64 64 (% class="box infomessage" %) ... ... @@ -66,7 +66,7 @@ 66 66 (% lang="en-US" %)**GET /api/v3/auth/check** 67 67 ))) 68 68 69 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 70 70 71 71 (% style="color:#000000" %)Метод запроса: **GET** 72 72 ... ... @@ -86,7 +86,7 @@ 86 86 **GET api/v3/agents/{id}** 87 87 ))) 88 88 89 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 90 90 91 91 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 92 92 ... ... @@ -97,51 +97,30 @@ 97 97 Запрос должен содержать данные параметра "**agentId**" 98 98 99 99 (% style="color:#000000" %)Ответ: 96 +А 100 100 { 101 - "agentId": "", (%%) 102 - "parentId": "", 103 - "parentName": "string", 104 - "name": "string", 105 - "fullName": "string", 106 - "agentInfoType": 0, 107 - "isForeign": true/false, 108 - "district": "string", 109 - "region": "string", 110 - "city": "string", 111 - "inn": "string", 112 - "kpp": "string", 113 - "address": "string", 114 - "addressFact": "string", 115 - "email": "string", 116 - "director": "string", 117 - "bankName": "string", 118 - "bankBIK": "string", 119 - "bankRS": "string", 120 - "bankKS": "string" 98 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 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" ~/~/ Корр. счет 121 121 } 122 122 123 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 124 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 125 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 126 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 127 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 128 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 129 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 130 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 131 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 132 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 133 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 134 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 135 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 136 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 137 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 138 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 139 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 140 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 141 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 142 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 143 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 144 - 145 145 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 146 146 147 147 (% class="box infomessage" %) ... ... @@ -149,13 +149,13 @@ 149 149 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 150 150 ))) 151 151 152 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 153 153 154 154 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 155 155 156 156 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 157 157 158 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 159 159 160 160 (% style="color:#000000" %)Метод запроса: **POST** 161 161 ... ... @@ -170,23 +170,15 @@ 170 170 (% style="color:#000000" %)Ответ: 171 171 172 172 { 173 - "agentId": "",(% style="color:#000000" %) (%%) 174 - "parentId": "", 175 - "name": "string", 176 - "fullName": "string", 177 - "agentInfoType": 0, 178 -(% style="color:#000000" %) "status": "", 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 - Отказ) 179 179 } 180 180 181 - 182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 183 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 184 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 185 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 186 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 187 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 188 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 189 - 190 190 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 191 191 192 192 (% class="box successmessage" %) ... ... @@ -194,7 +194,7 @@ 194 194 **POST /api/v3/agents ** 195 195 ))) 196 196 197 -Метод позволяет добавить клиента, указанного в запросе. 164 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 198 198 199 199 Метод запроса: **POST** 200 200 ... ... @@ -205,7 +205,7 @@ 205 205 Параметры в теле запроса (JSON): 206 206 207 207 { 208 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 209 209 "name": "string", ~/~/ имя 210 210 "fullName": "string", ~/~/ полное наименование 211 211 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -225,6 +225,7 @@ 225 225 "bankKS": "string" ~/~/ корр. счёт 226 226 } 227 227 195 + 228 228 Ответ: 229 229 230 230 { ... ... @@ -249,28 +249,6 @@ 249 249 "bankKS": "string" ~/~/ корр. счёт 250 250 } 251 251 252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 253 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 254 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 255 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 256 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 257 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 258 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 259 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 260 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 261 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 262 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 263 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 264 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 265 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 266 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 267 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 268 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 269 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 270 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 271 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 272 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 273 - 274 274 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 275 275 276 276 (% class="box warningmessage" %) ... ... @@ -278,7 +278,7 @@ 278 278 **PUT /api/v3/agents** 279 279 ))) 280 280 281 -Метод позволяет отредактировать клиента, указанного в запросе. 227 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 282 282 283 283 Метод запроса: **PUT** 284 284 ... ... @@ -286,6 +286,7 @@ 286 286 287 287 В заголовках запроса: X-Auth: Токен авторизации 288 288 235 + 289 289 Параметры в теле запроса (JSON): 290 290 291 291 { ... ... @@ -310,6 +310,7 @@ 310 310 "bankKS": "string" ~/~/ корр. счёт 311 311 } 312 312 260 + 313 313 Ответ: 314 314 315 315 { ... ... @@ -340,7 +340,7 @@ 340 340 **DELETE /api/v3/agents/{clientId}** 341 341 ))) 342 342 343 -Метод позволяет удалить клиента, указанного в строке запроса. 291 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 344 344 345 345 Метод запроса: **DELETE** 346 346 ... ... @@ -352,21 +352,6 @@ 352 352 353 353 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 354 354 355 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 356 - 357 -(% class="box warningmessage" %) 358 -((( 359 -**PUT /api/v3/agents/{id}/changeStatus/{status}** 360 -))) 361 - 362 -Метод позволяет изменить статус клиента, указанного в запросе. 363 - 364 -В пути указывается GUID клиента и статус клиента. 365 - 366 -**status **- значение 0 - заблокирован, 1 - активен. 367 - 368 -Ответ: Code 204 369 - 370 370 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 371 371 372 372 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -376,7 +376,7 @@ 376 376 (% lang="en-US" %)**POST /api/v3/users** 377 377 ))) 378 378 379 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 380 380 381 381 (% style="color:#000000" %)Метод запроса: **POST** 382 382 ... ... @@ -386,8 +386,7 @@ 386 386 387 387 (% style="color:#000000" %)Параметры в теле запроса (JSON): 388 388 389 -(% style="color:#000000" %) 390 -{ 322 +(% style="color:#000000" %){ 391 391 "lastName": "", ~/~/ фамилия 392 392 "firstName": "", ~/~/ имя 393 393 "position": "", ~/~/ должность ... ... @@ -396,43 +396,25 @@ 396 396 "login": "", ~/~/ логин (обязателен) 397 397 "password": "", ~/~/ пароль (обязателен) 398 398 "email": "", ~/~/ email (обязателен) 399 - "description": "string", ~/~/ Описание 400 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 401 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 402 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 331 + "description": "", ~/~/ описание 332 + "isEnabled": "", ~/~/ признак включения 403 403 "parentId": "", ~/~/ Guid родительского агента 404 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 405 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 406 - "doubleAuth": 407 - { 408 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 409 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 410 - }, 411 - "groups": 412 - [ 413 - "string" ~/~/ группы пользователя, перечисление названия системных ролей 414 - ], 415 - "customGroups": 416 - [ 417 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 418 - ], 419 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 334 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 335 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 336 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 337 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 338 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 339 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 420 420 } 421 -{ 422 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 423 - "lastName": "string", 424 - "firstName": "string", 425 - "position": "string", 426 - "phone": "string", 427 - "organization": "string", 428 - "login": "string", 429 - "password": "string", 430 - "email": "string", 431 431 432 432 (% style="text-align:left" %) 433 433 (% style="color:#000000; font-weight:normal" %)Ответ: 434 -{ 435 - "id": "" , ~/~/ ID пользователя 344 + 345 +(% style="text-align:left" %) 346 +(% style="color:#000000; font-weight:normal" %){ 347 + 348 +(% style="text-align:left" %) 349 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 436 436 "lastName": "" , ~/~/ Фамилия , 437 437 "firstName": "" , ~/~/ Имя 438 438 "position": "" , ~/~/ Должность ... ... @@ -449,8 +449,9 @@ 449 449 "kind": "" , ~/~/ тип аутентификации 450 450 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 451 451 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 -} 453 453 367 +(% style="text-align:left" %) 368 +(% style="color:#000000; font-weight:normal" %)} 454 454 455 455 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 456 456 ... ... @@ -471,16 +471,19 @@ 471 471 472 472 (% style="color:#000000" %)Параметры в теле запроса (JSON): 473 473 474 -(% style="color:#000000" %){(%%) 389 +(% style="color:#000000" %){ 390 + 475 475 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 476 476 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 477 477 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 478 478 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 395 + 479 479 (% style="color:#000000" %)} 480 480 481 481 (% style="color:#000000" %)Ответ: 482 482 483 483 (% style="color:#000000" %){ (%%) 401 + 484 484 "id": "" , ~/~/ идентификатор пользователя 485 485 "lastName": "" , ~/~/ фамилия 486 486 "firstName": "" , ~/~/ имя ... ... @@ -493,7 +493,8 @@ 493 493 "email": "" , ~/~/ E-mail 494 494 "sessionDuration":"", ~/~/ длительность сессии в минутах 495 495 "status": "1", ~/~/ статус пользователя 496 - "lastLogged": "", ~/~/ дата/время последней авторизации 414 + "astLogged": "", ~/~/ дата/время последней авторизации 415 + 497 497 (% style="color:#000000" %)} 498 498 499 499 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -530,7 +530,7 @@ 530 530 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 531 531 "description": "", ~/~/ Описание 532 532 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 533 - "doubleAuth": 452 + "doubleAuth": 534 534 { 535 535 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации ... ... @@ -555,7 +555,7 @@ 555 555 (% lang="en-US" %)**PUT /api/v3/users** 556 556 ))) 557 557 558 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 477 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 559 559 560 560 (% style="color:#000000" %)Метод запроса: **PUT** 561 561 ... ... @@ -567,8 +567,10 @@ 567 567 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 568 569 569 (% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - "id": "" , ~/~/ ID пользователя 489 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 490 + 491 +(% lang="en-US" style="text-align:left" %) 492 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 572 572 "lastName": "" , ~/~/ фамилия 573 573 "firstName": "" , ~/~/ имя 574 574 "position": "" , ~/~/ должность ... ... @@ -584,13 +584,15 @@ 584 584 "parentId": "" , ~/~/ Guid родительского агента 585 585 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 586 586 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 587 - "doubleAuth": 508 + "doubleAuth": 588 588 { 589 589 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 590 590 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 591 591 }, 592 592 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 593 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 514 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 515 + 516 +(% lang="en-US" style="text-align:left" %) 594 594 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 595 595 596 596 (% lang="en-US" style="text-align:left" %) ... ... @@ -597,8 +597,10 @@ 597 597 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 598 598 599 599 (% lang="en-US" style="text-align:left" %) 600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 - "id": "" , ~/~/ идентификатор пользователя 523 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 524 + 525 +(% lang="en-US" style="text-align:left" %) 526 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 602 602 "lastName": "" , ~/~/ фамилия 603 603 "firstName": "" , ~/~/ имя 604 604 "position": "" , ~/~/ должность ... ... @@ -611,7 +611,7 @@ 611 611 "isEnabled": "" , ~/~/ признак включения 612 612 "parentId": "" , ~/~/ Guid родительского агента 613 613 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 614 - "doubleAuth": 539 + "doubleAuth": 615 615 { 616 616 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 617 617 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации ... ... @@ -619,8 +619,10 @@ 619 619 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 620 620 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 621 621 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 -} 623 623 548 +(% lang="en-US" style="text-align:left" %) 549 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 550 + 624 624 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 625 625 626 626 (% class="box warningmessage" %) ... ... @@ -628,7 +628,7 @@ 628 628 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 629 629 ))) 630 630 631 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 558 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 632 632 633 633 (% style="color:#000000" %)Метод запроса: **PUT** 634 634 ... ... @@ -640,10 +640,12 @@ 640 640 641 641 (% style="color:#000000" %)Параметры в теле запроса (JSON): 642 642 643 -(% style="color:#000000" %){(%%) 570 +(% style="color:#000000" %){ 571 + 644 644 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 645 645 "description": "" , ~/~/ описание 646 646 "data": "" , ~/~/ данные, связанные со сменой статуса 575 + 647 647 (% style="color:#000000" %)} 648 648 649 649 (% style="text-align:left" %) ... ... @@ -656,7 +656,7 @@ 656 656 **POST /api/v3/users/disable** 657 657 ))) 658 658 659 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 588 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 660 660 661 661 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 662 662 ... ... @@ -665,7 +665,7 @@ 665 665 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 666 666 667 667 [ 668 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 597 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 669 669 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 670 670 ] 671 671 ... ... @@ -678,7 +678,7 @@ 678 678 **POST /api/v3/users/enable** 679 679 ))) 680 680 681 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 610 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 682 682 683 683 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 684 684 ... ... @@ -715,7 +715,7 @@ 715 715 (% lang="en-US" %)**DELETE /api/v3/users/{id}** 716 716 ))) 717 717 718 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 647 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 719 719 720 720 (% style="color:#000000" %)Метод запроса: **DELETE** 721 721 ... ... @@ -728,249 +728,6 @@ 728 728 (% style="text-align:left" %) 729 729 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 730 730 731 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 732 - 733 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 734 - 735 -(% class="box infomessage" %) 736 -((( 737 -(% lang="en-US" %)**GET /api/v3/models/{Id}** 738 -))) 739 - 740 -Метод возвращает полную информацию о модели объекта. 741 - 742 -(% style="color:#000000" %)Метод запроса: **GET** 743 - 744 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 745 - 746 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 747 - 748 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 749 - 750 -(% style="color:#000000" %)Ответ: 751 - 752 -(% style="color:#000000" %){ 753 - "parentName": "string", 754 - "name": "string", 755 - "picture": "string", 756 - "minspeed": 0, 757 - "maxspeed": 0, 758 - "width": 0, 759 - "imbeddedtrailer": true, 760 - "hoppercapacity": 0, 761 - "hopperdischargespeed": 0, 762 - "modelType": 0, 763 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 764 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 765 - "deleted": true 766 -} 767 - 768 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 769 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 770 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 771 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 772 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 773 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 774 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 775 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 776 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 777 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 778 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 779 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 780 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 781 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 782 - 783 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 784 - 785 -(% class="box successmessage" %) 786 -((( 787 -(% lang="en-US" %)**POST /api/v3/models/find** 788 -))) 789 - 790 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 791 - 792 -(% style="color:#000000" %)Метод запроса: **POST** 793 - 794 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 795 - 796 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 797 - 798 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 799 - 800 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 801 -} 802 - 803 -(% style="color:#000000" %)Ответ: 804 - 805 -(% style="color:#000000" %)[ 806 - { 807 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 808 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 809 - "parentName": "string", 810 - "name": "string", 811 - "modelType": 0 812 - } 813 -] 814 - 815 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 816 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 817 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 818 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 819 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 820 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 821 - 822 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 823 - 824 -(% class="box successmessage" %) 825 -((( 826 -(% lang="en-US" %)**POST /api/v3/models** 827 -))) 828 - 829 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 830 - 831 -(% style="color:#000000" %)Метод запроса: **POST** 832 - 833 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 834 - 835 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 836 - 837 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 838 - 839 -{ 840 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 841 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 842 - "deleted": true, 843 - "extId": "string", 844 - "name": "string", 845 - "picture": "string", 846 - "minspeed": 0, 847 - "maxspeed": 0, 848 - "width": 0, 849 - "imbeddedtrailer": true, 850 - "fueloutlay": 0, 851 - "hoppercapacity": 0, 852 - "hopperdischargespeed": 0, 853 - "modelType": 0 854 -} 855 - 856 -Ответ: 857 - 858 -{ 859 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 860 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 861 - "deleted": true, 862 - "extId": "string", 863 - "name": "string", 864 - "picture": "string", 865 - "minspeed": 0, 866 - "maxspeed": 0, 867 - "width": 0, 868 - "imbeddedtrailer": true, 869 - "hoppercapacity": 0, 870 - "hopperdischargespeed": 0, 871 - "modelType": 0 872 -} 873 - 874 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 875 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 876 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 877 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 878 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 879 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 880 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 881 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 882 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 883 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 884 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 885 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 886 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 887 - 888 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 889 - 890 -(% class="box warningmessage" %) 891 -((( 892 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 893 -))) 894 - 895 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 896 - 897 -(% style="color:#000000" %)Метод запроса: **PUT** 898 - 899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 900 - 901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 902 - 903 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 904 - 905 -{ 906 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 907 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 908 - "deleted": true, 909 - "extId": "string", 910 - "name": "string", 911 - "picture": "string", 912 - "minspeed": 0, 913 - "maxspeed": 0, 914 - "width": 0, 915 - "imbeddedtrailer": true, 916 - "fueloutlay": 0, 917 - "hoppercapacity": 0, 918 - "hopperdischargespeed": 0, 919 - "modelType": 0 920 -} 921 - 922 -Ответ: 923 - 924 -{ 925 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 926 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 927 - "deleted": true, 928 - "extId": "string", 929 - "name": "string", 930 - "picture": "string", 931 - "minspeed": 0, 932 - "maxspeed": 0, 933 - "width": 0, 934 - "imbeddedtrailer": true, 935 - "fueloutlay": 0, 936 - "hoppercapacity": 0, 937 - "hopperdischargespeed": 0, 938 - "modelType": 0 939 -} 940 - 941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 942 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 943 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 944 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 945 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 946 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 947 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 948 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 949 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 950 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 951 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 952 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 953 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 954 - 955 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 956 - 957 -(% class="box errormessage" %) 958 -((( 959 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 960 -))) 961 - 962 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 963 - 964 -(% style="color:#000000" %)Метод запроса: **DELETE** 965 - 966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 967 - 968 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 969 - 970 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 971 - 972 -Ответ: В случае успеха **Success 200** 973 - 974 974 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 975 975 976 976 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -982,7 +982,7 @@ 982 982 983 983 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 984 984 985 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 671 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 986 986 987 987 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 988 988 ... ... @@ -990,9 +990,9 @@ 990 990 991 991 (% style="color:#000000" %)Метод запроса: **GET** 992 992 993 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) {(% lang="en-US" %)v(%%)ehicleID}679 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID> 994 994 995 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__integer($int32))681 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 996 996 997 997 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 998 998 ... ... @@ -1006,129 +1006,20 @@ 1006 1006 "deviceTypeId": , ~/~/ ID типа устройства 1007 1007 "deviceTypeName": "", ~/~/ Название типа устройства 1008 1008 "sim1": "", ~/~/ Номер SIM1 1009 - "sim2": "", ~/~/ Номер SIM2 1010 - "parentId": "", ~/~/ ID клиента-родителя 1011 - "parentName": "", ~/~/ Наименование клиента-родителя 1012 - "modelId": "", ~/~/ ID модели объекта 1013 - "modelName": "", ~/~/ Имя модели объекта 1014 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1015 - "unitName": "string", ~/~/ Наименование подразделения 1016 - "status": 0, ~/~/ Статус объекта 1017 - "createdAt": "", ~/~/ Дата создания объекта 695 + "parentId": "", Номер SIM2 696 + "parentName": "", Наименование клиента-родителя 697 + "modelId": "", ID модели объекта 698 + "modelName": "", Имя модели объекта 699 + "createdAt": "", Дата создания объекта 700 + "mileageCalcMethod": "", Выбранный метод расчета пробега 701 + "counters": { ~/~/ Нормы 702 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 703 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 704 + "mileage": "", ~/~/ Пробег по нормам в метрах 705 + "motohours": "" ~/~/ Моточасы по нормам, в секундах 706 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 707 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 1018 1018 }, 1019 -"customFields": [ ~/~/ Произвольные поля 1020 - { 1021 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1022 - "name": "string", ~/~/ Имя поля 1023 - "value": "string", ~/~/ Значение поля 1024 - "forClient": true, ~/~/ Не используемая функция 1025 - "forTooltip": true, ~/~/ Отображать в подсказке 1026 - "forReport": true ~/~/ Отображать в отчете 1027 - } 1028 - 1029 -], ~/~/ Данные с вкладки нормы 1030 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1031 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1032 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1033 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1034 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1035 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1036 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1037 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1038 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1039 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1040 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1042 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1043 - "mileageCoeff": 0, ~/~/ коэффициент пробега 1044 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1045 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1046 - "counters": { ~/~/ Счетчики 1047 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1048 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1049 - "mileage": 0, ~/~/ Текущий пробег 1050 - "motohours": 0, ~/~/ Текущие моточасы 1051 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1052 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1053 - }, 1054 - 1055 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1056 - "id": "string", ~/~/ ID объекта 1057 - "enabled": true, ~/~/ Включить, true - активна, false - не активна 1058 - "host": "string", ~/~/ CMSV6 Web Host 1059 - "login": "string", ~/~/ CMSV6 Account 1060 - "password": "string" ~/~/ CMSV6 Password 1061 - }, 1062 - 1063 -"commandTemplates": [ ~/~/ Шаблоны команд 1064 - { 1065 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1066 - "name": "string", ~/~/ Наименование команды 1067 - "command": "string", ~/~/ Текст команды 1068 - "retries": 0 ~/~/ Количество попыток 1069 - } 1070 - ], 1071 - "sensors": [ ~/~/ Датчики 1072 - { 1073 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1074 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1075 - "type": 0, ~/~/ Тип датчика 1076 - "name": "string", ~/~/ Имя датчика 1077 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1078 - "inputNumber": 0, ~/~/ Номер входа 1079 - "pseudonym": "string", ~/~/ Псевдоним 1080 - "medianDegree": 0, ~/~/ Медианная фильтрация 1081 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1082 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1083 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1084 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1085 - { 1086 - "grades": [ ~/~/ Таблица тарировки 1 1087 - { 1088 - "input": 0, ~/~/ Входящее значение 1089 - "output": 0 ~/~/ Выходящее значение 1090 - } 1091 - ], 1092 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1093 - } 1094 - ], 1095 - "showInTooltip": true, ~/~/ Отображать в подсказке 1096 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1097 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1098 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1099 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1100 - "expr": "string", ~/~/ Формула 1101 - "children": [ ~/~/ массив дочерних датчиков 1102 - "string" 1103 - ], 1104 - "customParams": { ~/~/ прочие произвольные параметры 1105 - "additionalProp1": "string", 1106 - "additionalProp2": "string", 1107 - "additionalProp3": "string" 1108 - }, 1109 - 1110 -~/~/ Характерные для произвольного: 1111 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1112 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1113 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1114 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1115 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1116 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1117 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1118 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1119 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1120 -~/~/ "ValueOn": "Вкл.", 1121 -~/~/ "ValueOff": "Выкл." 1122 - "summaryMaxValue": 0 ~/~/ Макс. значение 1123 - } 1124 - "drivers": [ ~/~/ Водители 1125 - { 1126 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1127 - "name": "string", ~/~/ Наименование 1128 - "description": "string", 1129 - "isDefault": true ~/~/ По умолчанию 1130 - } 1131 - ], 1132 1132 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1133 1133 { 1134 1134 "id": "", ~/~/ ID задания ... ... @@ -1144,15 +1144,7 @@ 1144 1144 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 1145 1145 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1146 1146 } 1147 - ], 1148 -"statusHistory": [ ~/~/ История статусов 1149 - { 1150 - "status": 0, 1151 - "date": "2023-05-22T09:57:39.562Z", 1152 - "description": "string", 1153 - "additionalInfo": "string" 1154 - } 1155 - ] 724 + ] 1156 1156 } 1157 1157 ))) 1158 1158 ... ... @@ -1162,56 +1162,6 @@ 1162 1162 (% style="text-align:left" %) 1163 1163 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1164 1164 1165 - 1166 -== **Получить ответ на отправленную на ТС команду** == 1167 - 1168 -(% class="box infomessage" %) 1169 -((( 1170 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1171 -))) 1172 - 1173 -Идентификатор команды: cmdid 1174 - 1175 -Запрос от терминала на ответ команды 1176 - 1177 -Пример ответ от терминала: 1178 - 1179 -ID= "" ~/~/ идентификатор произвольного поля 1180 -Soft="" ~/~/ версия софта 1181 -GPS=4 ~/~/ тип трекера 1182 -Time=11:05:43 28.06.24 ~/~/ время запроса 1183 -Lat=45.056221 ~/~/ широта 1184 -Lon=39.035938 ~/~/ долгота 1185 -Speed=0.0 ~/~/ скорость 1186 -Course=181.4 ~/~/направление 1187 - 1188 -((( 1189 -== **Список отправленных объекту команд с ответами** == 1190 - 1191 -(% class="box infomessage" %) 1192 -((( 1193 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1194 -))) 1195 - 1196 -Идентификатор ТС: vehicleId 1197 - 1198 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1199 - 1200 -Пример ответа терминала 1201 - 1202 -[ 1203 -{ 1204 -"id": "", ~/~/ идентификатор пользователя 1205 -"commandText": "", ~/~/Текст команды. 1206 -"templateId": "", ~/~/Идентификатор шаблона 1207 -"updated": "", ~/~/ Время отправки 1208 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1209 -"answer": "", ~/~/ Ответ терминала. 1210 -"status": "" ~/~/ Статус отправки 1211 -} 1212 -] 1213 -))) 1214 - 1215 1215 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1216 1216 1217 1217 (% class="box successmessage" %) ... ... @@ -1219,7 +1219,7 @@ 1219 1219 (% lang="en-US" %)**POST /api/v3/vehicles** 1220 1220 ))) 1221 1221 1222 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 741 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 1223 1223 1224 1224 (% style="color:#000000" %)Метод запроса: **POST** 1225 1225 ... ... @@ -1229,7 +1229,8 @@ 1229 1229 1230 1230 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1231 1231 1232 -(% style="color:#000000" %){(%%) 751 +(% style="color:#000000" %){ 752 + 1233 1233 "parentId": "" , ~/~/ ID клиента 1234 1234 "name": "" , ~/~/ имя ТС 1235 1235 "imei": "" , ~/~/ IMEI ... ... @@ -1250,10 +1250,6 @@ 1250 1250 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1251 1251 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1252 1252 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1253 - "mileageCalcMethod": 0, 1254 - "mileageCoeff": 0, 1255 - "locationByCellId": true, 1256 - "dottedLineTrackWhenNoCoords": true, 1257 1257 "counters": ~/~/ счетчики 1258 1258 { 1259 1259 "mileage": "" , ~/~/ пробег ... ... @@ -1282,88 +1282,13 @@ 1282 1282 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1283 1283 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1284 1284 } 1285 -"drivers": [ ~/~/ Водители 1286 - { 1287 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1288 - "isDefault": true 1289 - } 1290 - ], 1291 - "commandTemplates": [ ~/~/ Шаблон команды 1292 - { 1293 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1294 - "name": "string", 1295 - "command": "string", 1296 - "retries": 0 1297 - } 1298 - ], 1299 -"sensors": [ ~/~/ Датчики 1300 - { 1301 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1302 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1303 - "type": 0, ~/~/ Тип датчика 1304 - "name": "string", ~/~/ Имя датчика 1305 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1306 - "inputNumber": 0, ~/~/ Номер входа 1307 - "pseudonym": "string", ~/~/ Псевдоним 1308 - "medianDegree": 0, ~/~/ Медианная фильтрация 1309 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1310 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1311 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1312 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1313 - { 1314 - "grades": [ ~/~/ Таблица тарировки 1 1315 - { 1316 - "input": 0, ~/~/ Входящее значение 1317 - "output": 0 ~/~/ Выходящее значение 1318 - } 1319 - ], 1320 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1321 - } 1322 - ], 1323 - "showInTooltip": true, ~/~/ Отображать в подсказке 1324 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1325 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1326 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1327 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1328 - "expr": "string", ~/~/ Формула 1329 - "children": [ ~/~/ массив дочерних датчиков 1330 - "string" 1331 - ], 1332 - "customParams": { ~/~/ прочие произвольные параметры 1333 - "additionalProp1": "string", 1334 - "additionalProp2": "string", 1335 - "additionalProp3": "string" 1336 - }, 1337 -~/~/ Характерные для произвольного: 1338 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1339 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1340 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1341 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1342 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1343 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1344 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1345 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1346 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1347 -~/~/ "ValueOn": "Вкл.", 1348 -~/~/ "ValueOff": "Выкл." 1349 - "summaryMaxValue": 0 ~/~/ Макс. значение 1350 - } 1351 - ], 1352 - "customFields": [ ~/~/ Произвольные поля 1353 - { 1354 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1355 - "name": "string", 1356 - "value": "string", 1357 - "forClient": true, 1358 - "forTooltip": true, 1359 - "forReport": true 1360 - } 1361 - ] 1362 -} 1363 1363 802 +(% style="color:#000000" %) } 803 + 1364 1364 (% style="color:#000000" %)Ответ: 1365 1365 1366 -(% style="color:#000000" %){(%%) 806 +(% style="color:#000000" %){ 807 + 1367 1367 "vehicleId": "", ~/~/ID ТС 1368 1368 "parentId": "", ~/~/Guid владельца ТС 1369 1369 "name": "", ~/~/Имя объекта ... ... @@ -1401,6 +1401,8 @@ 1401 1401 "kind": "", ~/~/ Вид периодичности по времени 1402 1402 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1403 1403 } 845 + 846 +(% style="text-align:left" %) 1404 1404 (% style="color:#000000" %)} 1405 1405 1406 1406 **Валидация:** ... ... @@ -1415,9 +1415,9 @@ 1415 1415 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 1416 ))) 1417 1417 1418 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).861 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1419 1419 1420 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 863 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 1421 1421 1422 1422 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 1423 1423 ... ... @@ -1459,7 +1459,8 @@ 1459 1459 (% style="color:#000000" %)Ответ: 1460 1460 1461 1461 (% style="color:#000000" %){ 1462 - "vehicleId": "" ~/~/ идентификатор объекта 905 + 906 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1463 1463 "name": "" ~/~/ наименование объекта 1464 1464 "imei": "" ~/~/ IMEI объекта 1465 1465 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1496,7 +1496,7 @@ 1496 1496 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1497 1497 ))) 1498 1498 1499 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 943 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1500 1500 1501 1501 (% style="color:#000000" %)Метод запроса: **POST** 1502 1502 ... ... @@ -1518,11 +1518,13 @@ 1518 1518 "data": "", ~/~/ Данные 1519 1519 "overwrite": false, ~/~/ Флаг перезаписи 1520 1520 "stage": "", ~/~/ Состояние, может быть null 965 + 1521 1521 (% style="color:#000000" %)} 1522 1522 1523 1523 (% style="color:#000000" %)Ответ: 1524 1524 1525 -(% style="color:#000000" %){(%%) 970 +(% style="color:#000000" %){ 971 + 1526 1526 "status": "", ~/~/ значение статуса 1527 1527 "date": "", ~/~/ Дата смены статуса 1528 1528 "description": "", ~/~/ Описание ... ... @@ -1529,25 +1529,10 @@ 1529 1529 "data": "", ~/~/ Данные 1530 1530 "overwrite": false, ~/~/ Флаг перезаписи 1531 1531 "stage": "", ~/~/ Состояние 978 + 979 +(% style="text-align:left" %) 1532 1532 (% style="color:#000000" %) } 1533 1533 1534 -== **Отправить команду на терминал** == 1535 - 1536 -(% class="box successmessage" %) 1537 -((( 1538 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1539 -))) 1540 - 1541 -Команда для отправки на тс. 1542 - 1543 -{ 1544 -"id": "", ~/~/идентификатор произвольного поля 1545 -"command": "", ~/~/ Текст команды 1546 -"retries": "", ~/~/ Количество попыток 1547 -"idTemplate": "" ~/~/ ID шаблона команды 1548 -} 1549 - 1550 - 1551 1551 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1552 1552 1553 1553 (% class="box warningmessage" %) ... ... @@ -1555,7 +1555,7 @@ 1555 1555 (% lang="en-US" %)**PUT /api/v3/vehicles** 1556 1556 ))) 1557 1557 1558 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 989 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1559 1559 1560 1560 (% style="color:#000000" %)Метод запроса: **PUT** 1561 1561 ... ... @@ -1565,16 +1565,18 @@ 1565 1565 1566 1566 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1567 1567 1568 -(% style="color:#000000" %){ 1569 - "vehicleId": , ~/~/ ID объекта 1570 - "parentId": "" , ~/~/ ID клиента 1571 - "name": "" , ~/~/ имя ТС 1572 - "imei": "" , ~/~/ IMEI 1573 - "deviceTypeId": "" , ~/~/ ID типа устройства 1574 - "modelId": "" , ~/~/ ID модели 1575 - "unitId": "" , ~/~/ ID подразделения 1576 - "sim1": "" , ~/~/ Номер SIM 1 1577 - "sim2": "" , ~/~/ Номер SIM2 999 +(% style="color:#000000" %){ 1000 + 1001 +((( 1002 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1003 + "parentId": "", ~/~/ ID клиента 1004 + "name": "", ~/~/ имя ТС 1005 + "imei": "", ~/~/ IMEI 1006 + "deviceTypeId": "", ~/~/ ID типа устройства 1007 + "modelId": "", ~/~/ , ID модели 1008 + "unitId": "", ~/~/ подразделения 1009 + "sim1": "", ~/~/ SIM 1 1010 + "sim2": "", ~/~/ SIM2 (%%) 1578 1578 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1579 1579 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1580 1580 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1587,123 +1587,45 @@ 1587 1587 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1588 1588 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1589 1589 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1023 +(% style="color:#000000" %) "counters": 1024 + { 1025 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1026 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1027 + "mileage": "", ~/~/ пробег, в метрах 1028 + "motohours": "" ~/~/ моточасы, в секундах 1029 + } 1030 + "cmsv6Parameters": ~/~/ параметры CMSv6 1031 + { 1032 + "id": "", ~/~/ идентификатор 1033 + "enabled": true, ~/~/ флаг включения 1034 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1035 + "login": "", ~/~/ имя учетной записи 1036 + "password": "", ~/~/ пароль учетной записи 1037 + } 1038 + "inspectionTasks": ~/~/ задания на ТО 1039 + { 1040 + "id": "", ~/~/ ID задания 1041 + "enabled": false, ~/~/ Признак включения 1042 + "name": "", ~/~/ Имя задания 1043 + "description": "", ~/~/ Описание задания 1044 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1045 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1046 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1047 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1048 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1049 + "kind": "", ~/~/ Вид периодичности по времени 1050 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1051 + } 1052 +))) 1590 1590 1591 - "mileageCalcMethod": 0, 1592 - "mileageCoeff": 0, 1593 - "locationByCellId": true, 1594 - "dottedLineTrackWhenNoCoords": true, 1595 - "counters": ~/~/ счетчики 1596 - { 1597 - "mileage": "" , ~/~/ пробег 1598 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1599 - "motohours": "" , ~/~/ моточасы 1600 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1601 - }, 1602 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1603 - "enabled": true, ~/~/ флаг включения 1604 - "id": "" , ~/~/ идентификатор 1605 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1606 - "login": "" , ~/~/ имя учетной записи 1607 - "password": "" ~/~/ пароль учетной записи 1608 - }, 1609 - "inspectionTasks": ~/~/ задания на ТО 1610 - { 1611 - "enabled": "" , ~/~/ Признак включения 1612 - "name": "" , ~/~/ Имя задания 1613 - "description": "" , ~/~/ Описание задания 1614 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1615 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1616 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1617 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1618 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1619 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1620 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1621 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1622 - } 1054 +(% style="color:#000000" %)} 1623 1623 1624 -"drivers": [ ~/~/ Водители 1625 - { 1626 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1627 - "isDefault": true 1628 - } 1629 - ], 1630 - "commandTemplates": [ ~/~/ Шаблон команды 1631 - { 1632 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1633 - "name": "string", 1634 - "command": "string", 1635 - "retries": 0 1636 - } 1637 - ], 1638 -"sensors": [ ~/~/ Датчики 1639 - { 1640 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1641 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1642 - "type": 0, ~/~/ Тип датчика 1643 - "name": "string", ~/~/ Имя датчика 1644 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1645 - "inputNumber": 0, ~/~/ Номер входа 1646 - "pseudonym": "string", ~/~/ Псевдоним 1647 - "medianDegree": 0, ~/~/ Медианная фильтрация 1648 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1649 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1650 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1651 - "gradesTables": [ ~/~/ Массив таблиц тарировки 1652 - { 1653 - "grades": [ ~/~/ Таблица тарировки 1 1654 - { 1655 - "input": 0, ~/~/ Входящее значение 1656 - "output": 0 ~/~/ Выходящее значение 1657 - } 1658 - ], 1659 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1660 - } 1661 - ], 1662 - "showInTooltip": true, ~/~/ Отображать в подсказке 1663 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 1664 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1665 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1666 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1667 - "expr": "string", ~/~/ Формула 1668 - "children": [ ~/~/ массив дочерних датчиков 1669 - "string" 1670 - ], 1671 - "customParams": { ~/~/ прочие произвольные параметры 1672 - "additionalProp1": "string", 1673 - "additionalProp2": "string", 1674 - "additionalProp3": "string" 1675 - }, 1676 -~/~/ Характерные для произвольного: 1677 -~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1678 -~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1679 -~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1680 -~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1681 -~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1682 -~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1683 -~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1684 -~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1685 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1686 -~/~/ "ValueOn": "Вкл.", 1687 -~/~/ "ValueOff": "Выкл." 1688 - "summaryMaxValue": 0 ~/~/ Макс. значение 1689 - } 1690 - ], 1691 - "customFields": [ ~/~/ Произвольные поля 1692 - { 1693 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1694 - "name": "string", 1695 - "value": "string", 1696 - "forClient": true, 1697 - "forTooltip": true, 1698 - "forReport": true 1699 - } 1700 - ] 1701 -} 1702 - 1703 1703 (% style="color:#000000" %)Ответ: 1704 1704 1705 1705 (% lang="en-US" style="text-align:left" %) 1706 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1059 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1060 + 1061 +(% lang="en-US" style="text-align:left" %) 1707 1707 "vehicleId": "", ~/~/ ID ТС 1708 1708 "parentId": "", ~/~/ ID клиента 1709 1709 "name": "", ~/~/ имя ТС ... ... @@ -1744,9 +1744,11 @@ 1744 1744 "kind": "", ~/~/ Вид периодичности по времени 1745 1745 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1746 1746 } 1102 + 1103 +(% lang="en-US" style="text-align:left" %) 1747 1747 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1748 1748 1749 -** Валидация:**1106 +**валидация:** 1750 1750 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1751 1751 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1752 1752 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. ... ... @@ -1758,7 +1758,7 @@ 1758 1758 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1759 1759 ))) 1760 1760 1761 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1118 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1762 1762 1763 1763 (% style="color:#000000" %)Метод запроса: **DELETE** 1764 1764 ... ... @@ -1780,19 +1780,22 @@ 1780 1780 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1781 1781 ))) 1782 1782 1783 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1140 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1784 1784 1785 1785 (% style="color:#000000" %)Метод запроса: **GET** 1786 1786 1787 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1144 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1788 1788 1789 1789 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1790 1790 1791 1791 (% style="color:#000000" %)Ответ: 1792 1792 1793 -(% style="color:#000000" %){(%%) 1150 +(% style="color:#000000" %){ 1151 + 1794 1794 "deviceTypeId" : "", ~/~/ ID типа устройства 1795 1795 "deviceTypeName" : "" ~/~/ Название типа устройства 1154 + 1155 +(% style="text-align:left" %) 1796 1796 (% style="color:#000000" %)} 1797 1797 1798 1798 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1804,7 +1804,7 @@ 1804 1804 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1805 1805 ))) 1806 1806 1807 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1167 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1808 1808 1809 1809 (% style="color:#000000" %)Метод запроса: **GET** 1810 1810 ... ... @@ -1814,13 +1814,16 @@ 1814 1814 1815 1815 (% style="color:#000000" %)Ответ: 1816 1816 1817 -(% style="color:#000000" %){(%%) 1177 +(% style="color:#000000" %){ 1178 + 1818 1818 "id": "", ~/~/ ID типа датчика 1819 1819 "name": "", ~/~/ Название 1820 1820 "description": "", ~/~/ Описание 1182 + 1183 +(% style="text-align:left" %) 1821 1821 (% style="color:#000000" %)} 1822 1822 1823 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **С ообщения**(%%) =1186 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 1824 1824 1825 1825 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1826 1826 ... ... @@ -1830,7 +1830,7 @@ 1830 1830 ))) 1831 1831 1832 1832 (% style="text-align: left;" %) 1833 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1196 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1834 1834 1835 1835 (% style="text-align: left;" %) 1836 1836 Метод запроса **POST** ... ... @@ -1861,2571 +1861,7 @@ 1861 1861 } 1862 1862 ] 1863 1863 1864 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1865 1865 1866 -(% class="box infomessage" style="text-align: left;" %) 1867 -((( 1868 -**POST /api/v3/terminalMessages/mapping** 1869 -))) 1870 - 1871 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1872 - 1873 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1874 - 1875 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1876 - 1877 -{ 1878 - "protocolType": 0, 1879 - "params": ["string"] 1880 -} 1881 - 1882 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1883 -|protocolType|ID типа протокола 1884 -|params|((( 1885 -Массив наименований параметров в сообщении 1886 -))) 1887 - 1888 -Ответ: 1889 - 1890 -{ 1891 - "protocolType": 0, 1892 - "mapping": { 1893 - "additionalProp1": { 1894 - "inputType": 0, 1895 - "inputNumber": 0 1896 - }, 1897 - "additionalProp2": { 1898 - "inputType": 0, 1899 - "inputNumber": 0 1900 - } 1901 - } 1902 -} 1903 - 1904 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1905 -|protocolType|Тип протокола 1906 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1907 -|inputNumber|((( 1908 -Номер входа 1909 -))) 1910 - 1911 -(% class="wikigeneratedid" %) 1912 -Перечень 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/]] 1913 - 1914 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1915 - 1916 -(% class="box infomessage" %) 1917 -((( 1918 -**POST /api/v3/terminalMessages** 1919 -))) 1920 - 1921 -Метод возвращает список сообщений терминала объекта за выбранный период. 1922 - 1923 -(% style="text-align: left;" %) 1924 -Метод запроса **POST** 1925 - 1926 -(% style="text-align: left;" %) 1927 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1928 - 1929 -(% style="text-align: left;" %) 1930 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1931 - 1932 -{ 1933 - "vehicleId": 0, ~/~/ id объекта 1934 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1935 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1936 -} 1937 - 1938 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1939 -|vehicleId|ID объекта 1940 -|from|Дата и время начала периода запроса 1941 -|to|Дата и время окончания периода запроса 1942 - 1943 -Ответ: 1944 - 1945 -[ 1946 - { 1947 - "messages": [ 1948 - { 1949 - "deviceTime": "2023-11-29T07:40:44.052Z", 1950 - "serverTime": "2023-11-29T07:40:44.052Z", 1951 - "speed": 0, 1952 - "altitude": 0, 1953 - "latitude": 0, 1954 - "longitude": 0, 1955 - "satellites": 0, 1956 - "course": 0, 1957 - "voltage": 0, 1958 - "parameters": { 1959 - "additionalProp1": "string", 1960 - "additionalProp2": "string", 1961 - "additionalProp3": "string" 1962 - }, 1963 - "photoCount": 0, 1964 - "lbsCorrectedCoords": true, 1965 - "protocolType": 0 1966 - } 1967 - ] 1968 - } 1969 -] 1970 - 1971 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1972 -|deviceTime|Время сообщения терминала 1973 -|serverTime|Время когда сообщение поступило на сервер 1974 -|speed|Скорость 1975 -|altitude|Высота над уровнем моря 1976 -|latitude|Широта 1977 -|longitude|Долгота 1978 -|satellites|Кол-во спутников 1979 -|course|Курс 1980 -|voltage|Бортовое напряжение 1981 -|parameters|Список параметров и их значений 1982 -|photoCount|Количество фото 1983 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1984 -|protocolType|ID типа протокола 1985 - 1986 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1987 - 1988 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1989 - 1990 -(% class="box infomessage" %) 1991 -((( 1992 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1993 -))) 1994 - 1995 -(% style="color:#000000" %)Метод запроса: **POST** 1996 - 1997 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1998 - 1999 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2000 - 2001 -(% style="text-align:left" %) 2002 -Тело запроса: 2003 - 2004 -{ 2005 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2006 - "vehicleIds": [0], ~/~/ Список ID объектов 2007 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2008 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2009 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2010 -} 2011 - 2012 -Ответ: 2013 - 2014 -[ 2015 - { 2016 - "vehicleId": 0, ~/~/ ID объекта 2017 - "name": "string", ~/~/ Имя ТС 2018 - "periods": [ ~/~/ Периоды 2019 - { 2020 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2021 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2022 - "mileageBegin": 0, ~/~/ Пробег на начало периода 2023 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 2024 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 2025 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2026 - } 2027 - ] 2028 - } 2029 -] 2030 - 2031 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2032 - 2033 -(% class="box infomessage" %) 2034 -((( 2035 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2036 -))) 2037 - 2038 -(% style="color:#000000" %)Метод запроса: **POST** 2039 - 2040 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2041 - 2042 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2043 - 2044 -(% style="text-align:left" %) 2045 -Тело запроса: 2046 - 2047 -{ 2048 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2049 - "vehicleIds": [0], ~/~/ Список ID объектов 2050 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2051 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2052 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2053 -} 2054 - 2055 -Ответ: 2056 - 2057 -[ 2058 - { 2059 - "vehicleId": 0, ~/~/ ID объекта 2060 - "name": "string", ~/~/ Имя ТС 2061 - "periods": [ ~/~/ Периоды 2062 - { 2063 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2064 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2065 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2066 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2067 - "fuelConsumption": 0, ~/~/ Расход топлива 2068 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2069 - } 2070 - ] 2071 - } 2072 -] 2073 - 2074 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2075 - 2076 -(% class="box infomessage" %) 2077 -((( 2078 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2079 -))) 2080 - 2081 -(% style="color:#000000" %)Метод запроса: **POST** 2082 - 2083 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2084 - 2085 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2086 - 2087 -(% style="text-align:left" %) 2088 -Тело запроса: 2089 - 2090 -{ 2091 - "vehicleIds": [0], ~/~/ Список ID объектов 2092 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2093 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2094 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2095 -} 2096 - 2097 -Ответ: 2098 - 2099 -[ 2100 - { 2101 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2102 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2103 - "vehicleId": 0, ~/~/ ID объекта 2104 - "name": "string", ~/~/ Имя объекта 2105 - "model": "string", ~/~/ Модель объекта 2106 - "fuels": [ ~/~/ Массив данным по заправкам и сливам 2107 - { 2108 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2109 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2110 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2111 - "valueFuel": 0, ~/~/ Количество 2112 - "fuelStart": 0, ~/~/ Уровень топлива на начало события 2113 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2114 - } 2115 - ] 2116 - } 2117 -] 2118 - 2119 - 2120 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2121 - 2122 -(% class="box infomessage" %) 2123 -((( 2124 -**POST /api/v3/vehicles/moveStop** 2125 -))) 2126 - 2127 -Метод запроса: **POST** 2128 - 2129 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2130 - 2131 -В заголовках запроса: X-Auth: Токен авторизации 2132 - 2133 - 2134 -Тело запроса: 2135 - 2136 -{ 2137 - "vehicleIds": [ ], ~/~/ Список ID объектов 2138 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2139 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2140 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2141 -} 2142 - 2143 -Ответ: 2144 - 2145 -[ 2146 - { 2147 - "vehicleId": 0, ~/~/ ID объекта 2148 - "vehicleName": "string", ~/~/ Имя объекта 2149 - "moves": [ ~/~/ Событие движения 2150 - { 2151 - "mileage": 0, ~/~/ Пробег, км 2152 - "eventId": 0, ~/~/ Идентификатор события 2153 - "eventName": "string", ~/~/ Название события 2154 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2155 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2156 - "duration": 0 ~/~/ Продолжительность события, секунд 2157 - } 2158 - ], 2159 - "stops": [ ~/~/ События стоянок 2160 - { 2161 - "address": "string", ~/~/ Адрес события 2162 - "eventId": 0, ~/~/ Идентификатор события 2163 - "eventName": "string", ~/~/ Название события 2164 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2165 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2166 - "duration": 0 ~/~/ Продолжительность события, секунд 2167 - } 2168 - ] 2169 - } 2170 -] 2171 - 2172 - 2173 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2174 - 2175 -(% class="box infomessage" %) 2176 -((( 2177 -**POST /api/v3/vehicles/getlastdata** 2178 -))) 2179 - 2180 -Метод запроса: **POST** 2181 - 2182 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2183 - 2184 -В заголовках запроса: X-Auth: Токен авторизации 2185 - 2186 - 2187 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2188 - 2189 -Ответ: 2190 - { 2191 - "vehicleId": 0, ~/~/Идентификатор объекта. 2192 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2193 - "vehicleNumber": "string",~/~/Номер объекта. 2194 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2195 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2196 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2197 - "speed": 0,~/~/Скорость объекта. 2198 - "course": 0,~/~/Курс движения [0;360] 2199 - "latitude": 0,~/~/Широта [-90°;90°]. 2200 - "longitude": 0,~/~/Долгота [-180°;180°]. 2201 - "address": "string",~/~/Адрес. 2202 - "geozones": [ ~/~/Сведения по геозонам. 2203 - { 2204 - "id": 0, 2205 - "name": "string" 2206 - } 2207 - 2208 - 2209 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2210 - 2211 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2212 - 2213 -(% class="box infomessage" %) 2214 -((( 2215 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2216 -))) 2217 - 2218 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2219 - 2220 -(% style="color:#000000" %)Метод запроса: **POST** 2221 - 2222 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2223 - 2224 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2225 - 2226 -(% style="text-align:left" %) 2227 -Тело запроса: 2228 - 2229 -(% style="text-align:left" %) 2230 -{ 2231 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2232 -} 2233 - 2234 -(% style="text-align:left" %) 2235 -Ответ: 2236 - 2237 -[ 2238 - { 2239 - "id": 0, ~/~/ Идентификатор объекта геозоны 2240 - "name": "string", ~/~/ Название объекта геозоны 2241 - "type": 0, ~/~/ Тип объекта геозоны 2242 - "fname": "string", ~/~/ Имя файла 2243 - "parentId": "string", ~/~/ Идентификатор клиента 2244 - "radius": 0, ~/~/ Радиус геообъекта 2245 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2246 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2247 - "description": "string", ~/~/ Описание 2248 - "area": 0, ~/~/ Площадь, м^^2^^ 2249 - "perimetr": 0, ~/~/ Периметр, м 2250 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2251 - } 2252 -] 2253 - 2254 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2255 - 2256 -(% class="box infomessage" %) 2257 -((( 2258 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2259 -))) 2260 - 2261 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2262 - 2263 -(% style="color:#000000" %)Метод запроса: **POST** 2264 - 2265 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2266 - 2267 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2268 - 2269 -(% style="text-align:left" %) 2270 -Тело запроса: 2271 - 2272 -{ 2273 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2274 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2275 - "ids": [ ], ~/~/ Массив id объектов 2276 - "byTime": 0, ~/~/ Объединение событий по времени 2277 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2278 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2279 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2280 -} 2281 - 2282 -Ответ: 2283 -[ 2284 - { 2285 - "geozoneId": 0, ~/~/ ID геообъекта 2286 - "geozoneName": "string", ~/~/ Название геообъекта 2287 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2288 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2289 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2290 - "vehicleId": 0, ~/~/ ID объекта 2291 - "vehicleName": "string" ~/~/ Имя объекта 2292 - } 2293 -] 2294 - 2295 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2296 - 2297 -(% class="box infomessage" %) 2298 -((( 2299 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2300 -))) 2301 - 2302 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2303 - 2304 -(% style="color:#000000" %)Метод запроса: **POST** 2305 - 2306 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2307 - 2308 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2309 - 2310 -(% style="text-align:left" %) 2311 -Тело запроса: 2312 - 2313 -{ 2314 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2315 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2316 - "ids": [ ], ~/~/ Массив id геообъектов 2317 - "byTime": 0, ~/~/ Объединение событий по времени 2318 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2319 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2320 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2321 -} 2322 - 2323 -Ответ: 2324 - 2325 -[ 2326 - { 2327 - "geozoneId": 0, ~/~/ ID геообъекта 2328 - "geozoneName": "string", ~/~/ Название геообъекта 2329 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2330 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2331 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2332 - "vehicleId": 0, ~/~/ ID объекта 2333 - "vehicleName": "string" ~/~/ Имя объекта 2334 - } 2335 -] 2336 - 2337 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2338 - 2339 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2340 - 2341 -(% class="box infomessage" %) 2342 -((( 2343 -**POST /api/v3/notifications/find** 2344 -))) 2345 - 2346 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2347 - 2348 -(% style="text-align: left;" %) 2349 -Метод запроса **POST** 2350 - 2351 -(% style="text-align: left;" %) 2352 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2353 - 2354 -(% style="text-align: left;" %) 2355 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2356 - 2357 -{ 2358 - "parentId": "" ~/~/ id клиента 2359 -} 2360 - 2361 -Ответ: 2362 - 2363 -[ 2364 - { 2365 - "id": 0, ~/~/ ID уведомления 2366 - "name": "string", ~/~/ Название уведомления 2367 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2368 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2369 - "userId": "", ~/~/ Пользователь, создавший уведомление 2370 - "parentId": "", ~/~/ Идентификатор клиента 2371 - "parentName": "string" ~/~/ Имя клиента 2372 - } 2373 -] 2374 - 2375 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2376 - 2377 -(% class="box infomessage" %) 2378 -((( 2379 -**GET /api/v3/notifications/{id}** 2380 -))) 2381 - 2382 -Метод возвращает данные правил формирования выбранного уведомления. 2383 - 2384 -(% style="text-align: left;" %) 2385 -Метод запроса **GET** 2386 - 2387 -(% style="text-align: left;" %) 2388 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2389 - 2390 -(% style="text-align: left;" %) 2391 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 2392 - 2393 -(% style="text-align: left;" %) 2394 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2395 - 2396 -(% style="text-align: left;" %) 2397 -(% style="color:#000000" %)Ответ: 2398 - 2399 -(% style="text-align: left;" %) 2400 -(% style="color:#000000" %){ 2401 - "id": 0, ~/~/ (%%)id уведомления 2402 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2403 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2404 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2405 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2406 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2407 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2408 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2409 -(% style="color:#000000" %) 0 2410 - ], 2411 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2412 -(% style="color:#000000" %) 0 2413 - ], 2414 - "fieldids": [ ~/~/ (%%)Список id полей для анализа 2415 -(% style="color:#000000" %) 0 2416 - ], 2417 - "settings": { ~/~/ Список параметров уведомления 2418 - "additionalProp1": "string", 2419 - "additionalProp2": "string", 2420 - "additionalProp3": "string" 2421 - }, 2422 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2423 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2424 -(% style="color:#000000" %) "" 2425 - ], 2426 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2427 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2428 -(% style="color:#000000" %) "string" 2429 - ], 2430 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2431 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2432 -(% style="color:#000000" %) { 2433 - "id": 0, ~/~/ (%%)Идентификатор участника чата 2434 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2435 -(% style="color:#000000" %) } 2436 - ], 2437 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2438 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2439 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2440 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2441 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2442 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2443 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2444 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2445 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2446 -(% style="color:#000000" %)} 2447 - 2448 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2449 - 2450 -(% class="box warningmessage" %) 2451 -((( 2452 -**PUT /api/v3/notifications/** 2453 -))) 2454 - 2455 -Метод позволяет отредактировать уведомление. 2456 - 2457 -Метод запроса **PUT** 2458 - 2459 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2460 - 2461 -В заголовках запроса: X-Auth: Токен авторизации 2462 - 2463 -Тело запроса: 2464 -{ 2465 - "id": 0, ~/~/ id уведомления 2466 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2467 - "userId": "", ~/~/ Пользователь, создавший уведомление 2468 - "parentId": "", ~/~/ Идентификатор клиента 2469 - "parentName": "string", ~/~/ Имя клиента 2470 - "name": "string", ~/~/ Название уведомления 2471 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2472 - "vehicleIds": [ ~/~/ Список id объектов для анализа 2473 - 0 2474 - ], 2475 - "geoids": [ ~/~/ Список id геообъектов для анализа 2476 - 0 2477 - ], 2478 - "fieldids": [ ~/~/ Список id полей для анализа 2479 - 0 2480 - ], 2481 - "settings": { ~/~/ Список параметров уведомления 2482 - "additionalProp1": "string", 2483 - "additionalProp2": "string", 2484 - "additionalProp3": "string" 2485 - }, 2486 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2487 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2488 - "" 2489 - ], 2490 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2491 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2492 - "string" 2493 - ], 2494 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2495 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2496 - { 2497 - "id": 0, ~/~/ Идентификатор участника чата 2498 - "info": "string" ~/~/ Дополнительные сведения 2499 - } 2500 - ], 2501 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2502 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2503 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2504 - "kind": 0, ~/~/ Определяет вид уведомления 2505 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2506 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2507 - "timezone": 0, ~/~/ Сдвиг часового пояса 2508 - "validity": 0, ~/~/ Срок действия в днях (1-90) 2509 - "autoProlongation": true ~/~/ Автопродление срока действия 2510 -} 2511 - 2512 -Ответ: 2513 - 2514 -Success 2515 - 2516 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2517 - 2518 -(% class="box errormessage" %) 2519 -((( 2520 -**DELETE /api/v3/notifications/{id}** 2521 -))) 2522 - 2523 -Метод позволяет удалить выбранное уведомление. 2524 - 2525 -Метод запроса **DELETE** 2526 - 2527 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2528 - 2529 -Передаваемый параметр: {id} - id уведомления 2530 - 2531 -В заголовках запроса: X-Auth: Токен авторизации 2532 - 2533 -Ответ: 2534 - 2535 -Success 2536 - 2537 - 2538 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2539 - 2540 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2541 - 2542 -(% class="box infomessage" %) 2543 -((( 2544 -**POST /api/v3/Drivers/find** 2545 -))) 2546 - 2547 -Передается параметр: parentId - ID клиента-родителя 2548 - 2549 -Ответ: 2550 - 2551 -[ 2552 - { 2553 - "name": "string", ~/~/ Определяет наименование 2554 - "description": "string", ~/~/ Определяет описание 2555 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 2556 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 2557 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2558 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2559 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2560 - "deleted": true ~/~/ Признак удаления 2561 - } 2562 -] 2563 - 2564 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2565 - 2566 -(% class="box infomessage" %) 2567 -((( 2568 -**GET /api/v3/Drivers/{driverGuid}** 2569 -))) 2570 - 2571 -Передается параметр: ID водителя 2572 - 2573 -Ответ: 2574 - 2575 -{ 2576 - "name": "string", ~/~/ Определяет наименование 2577 - "description": "string", ~/~/ Определяет описание 2578 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 2579 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 2580 - "exclusive": true, ~/~/ Определяет признак "Исключительный" 2581 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 2582 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 2583 - "deleted": true ~/~/ Признак удаления 2584 -} 2585 - 2586 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2587 - 2588 -(% class="box successmessage" %) 2589 -((( 2590 -**POST /api/v3/Drivers** 2591 -))) 2592 - 2593 -Запрос: 2594 - 2595 -{ 2596 - "name": "string", 2597 - "description": "string", 2598 - "hiredate": "2023-06-30T12:50:54.020Z", 2599 - "chopdate": "2023-06-30T12:50:54.020Z", 2600 - "exclusive": true, 2601 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2602 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2603 - "deleted": true 2604 -} 2605 - 2606 -Ответ: 2607 - 2608 -{ 2609 - "name": "string", 2610 - "description": "string", 2611 - "hiredate": "2023-06-30T12:50:54.051Z", 2612 - "chopdate": "2023-06-30T12:50:54.051Z", 2613 - "exclusive": true, 2614 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2615 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2616 - "deleted": true 2617 -} 2618 - 2619 - 2620 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2621 - 2622 -(% class="box warningmessage" %) 2623 -((( 2624 -**PUT /api/v3/Drivers** 2625 -))) 2626 - 2627 -Запрос: 2628 - 2629 -{ 2630 - "name": "string", 2631 - "description": "string", 2632 - "hiredate": "2023-06-30T12:50:27.910Z", 2633 - "chopdate": "2023-06-30T12:50:27.910Z", 2634 - "exclusive": true, 2635 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2636 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2637 - "deleted": true 2638 -} 2639 - 2640 -Ответ: 2641 - 2642 -{ 2643 - "name": "string", 2644 - "description": "string", 2645 - "hiredate": "2023-06-30T12:50:27.929Z", 2646 - "chopdate": "2023-06-30T12:50:27.929Z", 2647 - "exclusive": true, 2648 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2649 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2650 - "deleted": true 2651 -} 2652 - 2653 - 2654 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2655 - 2656 -(% class="box errormessage" %) 2657 -((( 2658 -**DELETE /api/v3/Drivers/{driverGuid}** 2659 -))) 2660 - 2661 -Передается параметр: ID водителя 2662 - 2663 -Ответ: 2664 - 2665 -Success 2666 - 2667 - 2668 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 2669 - 2670 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 2671 - 2672 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2673 - 2674 -(% class="box infomessage" %) 2675 -((( 2676 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2677 -))) 2678 - 2679 -Запрос: 2680 - 2681 -{ 2682 - "Ids": [ 2683 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2684 - ], 2685 - "BeginTime": "2023-06-30T12:49:04.365Z", 2686 - "EndTime": "2023-06-30T12:49:04.365Z" 2687 -} 2688 - 2689 -Ответ: 2690 - 2691 -[ 2692 - { 2693 - "VehicleId": 0, 2694 - "CreateTime": "2023-06-30T09:52:31.240Z", 2695 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2696 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2697 - "BeginTime": "2023-06-30T09:52:31.240Z", 2698 - "EndTime": "2023-06-30T09:52:31.240Z" 2699 - } 2700 -] 2701 - 2702 - 2703 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2704 - 2705 -(% class="box infomessage" %) 2706 -((( 2707 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2708 -))) 2709 - 2710 -Запрос: 2711 - 2712 -{ 2713 - "Ids": [ 2714 - 0 2715 - ], 2716 - "BeginTime": "2023-06-30T12:48:39.419Z", 2717 - "EndTime": "2023-06-30T12:48:39.419Z" 2718 -} 2719 - 2720 -Ответ: 2721 - 2722 -[ 2723 - { 2724 - "VehicleId": 0, 2725 - "CreateTime": "2023-06-30T09:54:01.631Z", 2726 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2727 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2728 - "BeginTime": "2023-06-30T09:54:01.631Z", 2729 - "EndTime": "2023-06-30T09:54:01.631Z" 2730 - } 2731 -] 2732 - 2733 - 2734 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2735 - 2736 -(% class="box successmessage" %) 2737 -((( 2738 -**POST /api/v3/DriversVehiclesAssignments** 2739 -))) 2740 - 2741 -Передается массив назначений 2742 - 2743 -Запрос: 2744 - 2745 -[ 2746 - { 2747 - "VehicleId": 0, ~/~/ Идентификатор объекта 2748 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 2749 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2750 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 2751 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2752 - } 2753 -] 2754 - 2755 -Ответ: 2756 - 2757 -[ 2758 - { 2759 - "VehicleId": 0, 2760 - "CreateTime": "2023-06-30T11:04:46.903Z", 2761 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2762 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2763 - "BeginTime": "2023-06-30T11:04:46.903Z", 2764 - "EndTime": "2023-06-30T11:04:46.903Z" 2765 - } 2766 -] 2767 - 2768 - 2769 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2770 - 2771 -(% class="box warningmessage" %) 2772 -((( 2773 -**PUT /api/v3/DriversVehiclesAssignments** 2774 -))) 2775 - 2776 -Запрос: 2777 - 2778 -[ 2779 - { 2780 - "VehicleId": 0, 2781 - "CreateTime": "2023-06-30T11:14:08.117Z", 2782 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2783 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2784 - "BeginTime": "2023-06-30T11:14:08.117Z", 2785 - "EndTime": "2023-06-30T11:14:08.117Z" 2786 - } 2787 -] 2788 - 2789 -Ответ: 2790 - 2791 -[ 2792 - { 2793 - "VehicleId": 0, 2794 - "CreateTime": "2023-06-30T11:14:53.349Z", 2795 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2796 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2797 - "BeginTime": "2023-06-30T11:14:53.349Z", 2798 - "EndTime": "2023-06-30T11:14:53.349Z" 2799 - } 2800 -] 2801 - 2802 - 2803 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2804 - 2805 -(% class="box errormessage" %) 2806 -((( 2807 -**DELETE /api/v3/DriversVehiclesAssignments** 2808 -))) 2809 - 2810 -Запрос: 2811 - 2812 -[ 2813 - "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2814 -] 2815 - 2816 -Ответ: 2817 - 2818 -Success 2819 - 2820 - 2821 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 2822 - 2823 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2824 - 2825 -(% class="box infomessage" %) 2826 -((( 2827 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2828 -))) 2829 - 2830 -Запрос: 2831 - 2832 -{ 2833 - "Ids": [ 2834 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2835 - ], 2836 - "BeginTime": "2023-06-30T12:47:12.162Z", 2837 - "EndTime": "2023-06-30T12:47:12.162Z" 2838 -} 2839 - 2840 -Ответ: 2841 - 2842 -[ 2843 - { 2844 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2845 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2846 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2847 - "BeginTime": "2023-06-30T11:19:40.703Z", 2848 - "EndTime": "2023-06-30T11:19:40.703Z" 2849 - } 2850 -] 2851 - 2852 - 2853 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2854 - 2855 -(% class="box infomessage" %) 2856 -((( 2857 -**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2858 -))) 2859 - 2860 -Запрос: 2861 - 2862 -{ 2863 - "Ids": [ 2864 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2865 - ], 2866 - "BeginTime": "2023-06-30T12:47:12.162Z", 2867 - "EndTime": "2023-06-30T12:47:12.162Z" 2868 -} 2869 - 2870 -Ответ: 2871 - 2872 -[ 2873 - { 2874 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 2875 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2876 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2877 - "BeginTime": "2023-06-30T11:19:40.703Z", 2878 - "EndTime": "2023-06-30T11:19:40.703Z" 2879 - } 2880 -] 2881 - 2882 - 2883 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2884 - 2885 -(% class="box successmessage" %) 2886 -((( 2887 -**POST /api/v3/DriversRfidsAssignments** 2888 -))) 2889 - 2890 -Запрос: 2891 - 2892 -[ 2893 - { 2894 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2895 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2896 - "BeginTime": "2023-06-30T11:27:08.635Z", 2897 - "EndTime": "2023-06-30T11:27:08.635Z" 2898 - } 2899 -] 2900 - 2901 -Ответ: 2902 - 2903 -[ 2904 - { 2905 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2906 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2907 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2908 - "BeginTime": "2023-06-30T11:27:08.677Z", 2909 - "EndTime": "2023-06-30T11:27:08.677Z" 2910 - } 2911 -] 2912 - 2913 - 2914 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2915 - 2916 -(% class="box warningmessage" %) 2917 -((( 2918 -**PUT /api/v3/DriversRfidsAssignments** 2919 -))) 2920 - 2921 -Запрос: 2922 - 2923 -[ 2924 - { 2925 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2926 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2927 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2928 - "BeginTime": "2023-06-30T11:28:43.330Z", 2929 - "EndTime": "2023-06-30T11:28:43.330Z" 2930 - } 2931 -] 2932 - 2933 -Ответ: 2934 - 2935 -[ 2936 - { 2937 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2938 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2939 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2940 - "BeginTime": "2023-06-30T11:28:43.331Z", 2941 - "EndTime": "2023-06-30T11:28:43.331Z" 2942 - } 2943 -] 2944 - 2945 - 2946 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2947 - 2948 -(% class="box errormessage" %) 2949 -((( 2950 -**DELETE /api/v3/DriversRfidsAssignments** 2951 -))) 2952 - 2953 -Запрос: 2954 - 2955 -[ 2956 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2957 -] 2958 - 2959 -Ответ: 2960 - 2961 -Success 2962 - 2963 - 2964 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 2965 - 2966 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2967 - 2968 -(% class="box infomessage" %) 2969 -((( 2970 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2971 -))) 2972 - 2973 -Запрос: 2974 - 2975 -{ 2976 - "Ids": [ 2977 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2978 - ], 2979 - "BeginTime": "2023-06-30T12:45:10.852Z", 2980 - "EndTime": "2023-06-30T12:45:10.852Z" 2981 -} 2982 - 2983 -Ответ: 2984 - 2985 -[ 2986 - { 2987 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2988 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2989 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2990 - "BeginTime": "2023-06-30T11:58:04.695Z", 2991 - "EndTime": "2023-06-30T11:58:04.695Z" 2992 - } 2993 -] 2994 - 2995 - 2996 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2997 - 2998 -(% class="box infomessage" %) 2999 -((( 3000 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3001 -))) 3002 - 3003 -Запрос: 3004 - 3005 -{ 3006 - "Ids": [ 3007 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3008 - ], 3009 - "BeginTime": "2023-06-30T12:45:10.852Z", 3010 - "EndTime": "2023-06-30T12:45:10.852Z" 3011 -} 3012 - 3013 -Ответ: 3014 - 3015 -[ 3016 - { 3017 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3018 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3019 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3020 - "BeginTime": "2023-06-30T11:58:04.695Z", 3021 - "EndTime": "2023-06-30T11:58:04.695Z" 3022 - } 3023 -] 3024 - 3025 - 3026 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3027 - 3028 -(% class="box successmessage" %) 3029 -((( 3030 -**POST /api/v3/DriversFuelCardsAssignments** 3031 -))) 3032 - 3033 -Запрос: 3034 - 3035 -[ 3036 - { 3037 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3038 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3039 - "BeginTime": "2023-06-30T12:09:53.175Z", 3040 - "EndTime": "2023-06-30T12:09:53.175Z" 3041 - } 3042 -] 3043 - 3044 -Ответ: 3045 - 3046 -[ 3047 - { 3048 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3049 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3050 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3051 - "BeginTime": "2023-06-30T12:09:53.201Z", 3052 - "EndTime": "2023-06-30T12:09:53.201Z" 3053 - } 3054 -] 3055 - 3056 - 3057 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3058 - 3059 -(% class="box warningmessage" %) 3060 -((( 3061 -**PUT /api/v3/DriversFuelCardsAssignments** 3062 -))) 3063 - 3064 -Запрос: 3065 - 3066 -[ 3067 - { 3068 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3069 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3070 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3071 - "BeginTime": "2023-06-30T12:09:53.201Z", 3072 - "EndTime": "2023-06-30T12:09:53.201Z" 3073 - } 3074 -] 3075 - 3076 -Ответ: 3077 - 3078 -[ 3079 - { 3080 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3081 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3082 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3083 - "BeginTime": "2023-06-30T12:09:53.201Z", 3084 - "EndTime": "2023-06-30T12:09:53.201Z" 3085 - } 3086 -] 3087 - 3088 - 3089 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3090 - 3091 -(% class="box errormessage" %) 3092 -((( 3093 -**DELETE /api/v3/DriversFuelCardsAssignments** 3094 -))) 3095 - 3096 -Запрос: 3097 - 3098 -[ 3099 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3100 -] 3101 - 3102 -Ответ: 3103 - 3104 -Success 3105 - 3106 - 3107 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3108 - 3109 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3110 - 3111 -(% class="box infomessage" %) 3112 -((( 3113 -**POST /api/v3/Trailers** 3114 -))) 3115 - 3116 -Пример запроса: 3117 - 3118 -{ 3119 - "startDate": "2023-11-14T10:48:03.671Z", 3120 - "endDate": "2023-11-14T10:48:03.671Z", 3121 - "ids": [ 0 ], 3122 - "timezone": 0 3123 -} 3124 - 3125 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3126 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3127 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3128 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3129 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3130 - 3131 -Пример ответа: 3132 - 3133 -[ 3134 - { 3135 - "SD": "2023-11-14T10:48:03.717Z", 3136 - "ED": "2023-11-14T10:48:03.717Z", 3137 - "id": 0, 3138 - "SLat": 0, 3139 - "SLon": 0, 3140 - "ELat": 0, 3141 - "ELon": 0, 3142 - "mileage": 0 3143 - "Duration": 0 3144 - "Address": "string", 3145 - "Address2": "string", 3146 - "name": "string", 3147 - "rid": "string", 3148 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3149 - "trailer": { 3150 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3151 - "Number": "string", 3152 - "Description": "string", 3153 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3154 - "ExternalID": "string", 3155 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3156 - "CreateTime": "2023-11-14T10:48:03.717Z", 3157 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3158 - "IsDeleted": true 3159 - }, 3160 - "filesCount": 0, 3161 - } 3162 -] 3163 - 3164 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3165 -|SD|Дата и время начала события 3166 -|ED|Дата и время окончания события 3167 -|id|ID объекта 3168 -|SLat|Широта начальной координаты 3169 -|SLon|Долгота начальной координаты 3170 -|ELat|Широта конечной координаты 3171 -|ELon|Долгота конечной координаты 3172 -|mileage|Пробег 3173 -|Duration|Продолжительность 3174 -|Address|Адрес начального местоположения 3175 -|Address2|Адрес конечного местоположения 3176 -|name|Имя радиометки 3177 -|rid|Номер радиометки 3178 -|rguid|ID радиометки 3179 -|trailer|Информация об агрегате 3180 -|ModelGuid|ID агрегата 3181 -|Number|Название/номер агрегата 3182 -|Description|Текст примечания агрегата 3183 - 3184 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3185 - 3186 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3187 - 3188 -(% class="box infomessage" %) 3189 -((( 3190 -**POST /api/v3/Rfids/find** 3191 -))) 3192 - 3193 -Запрос: 3194 - 3195 -{ 3196 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3197 -} 3198 - 3199 -Ответ: 3200 - 3201 -[ 3202 - { 3203 - "name": "string", 3204 - "number": 0, 3205 - "period": 0, 3206 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3207 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3208 - } 3209 -] 3210 - 3211 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3212 -|parentId|ID клиента 3213 -|name|Название карты-метки 3214 -|number|Номер 3215 -|period|Период запросов в секундах (работает только для агрегатов) 3216 -|id|ID карты-метки 3217 - 3218 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3219 - 3220 -(% class="box infomessage" %) 3221 -((( 3222 -**GET /api/v3/Rfids/{rfidGuid}** 3223 -))) 3224 - 3225 -Передаем параметр rfidGuid - идентификатор карты-метки 3226 - 3227 -Ответ: 3228 - 3229 -[ 3230 - { 3231 - "name": "string", 3232 - "number": 0, 3233 - "period": 0, 3234 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3235 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3236 - } 3237 -] 3238 - 3239 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3240 -|name|Название карты-метки 3241 -|number|Номер 3242 -|period|Период запросов в секундах (работает только для агрегатов) 3243 -|id|ID карты-метки 3244 -|parentId|ID клиента 3245 - 3246 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3247 - 3248 -(% class="box successmessage" %) 3249 -((( 3250 -**POST /api/v3/Rfids** 3251 -))) 3252 - 3253 -Запрос: 3254 - 3255 -{ 3256 - "name": "string", 3257 - "number": 0, 3258 - "period": 0, 3259 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3260 -} 3261 - 3262 -Ответ: 3263 - 3264 -{ 3265 - "name": "string", 3266 - "number": 0, 3267 - "period": 0, 3268 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3269 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3270 -} 3271 - 3272 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3273 -|name|Название карты-метки 3274 -|number|Номер 3275 -|period|Период запросов в секундах (работает только для агрегатов) 3276 -|id|ID карты-метки 3277 -|parentId|ID клиента 3278 - 3279 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3280 - 3281 -(% class="box warningmessage" %) 3282 -((( 3283 -**PUT /api/v3/Rfids** 3284 -))) 3285 - 3286 -Запрос: 3287 - 3288 -{ 3289 - "name": "string", 3290 - "number": 0, 3291 - "period": 0, 3292 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3293 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3294 -} 3295 - 3296 -Ответ: 3297 - 3298 -{ 3299 - "name": "string", 3300 - "number": 0, 3301 - "period": 0, 3302 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3303 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3304 -} 3305 - 3306 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3307 -|name|Название карты-метки 3308 -|number|Номер 3309 -|period|Период запросов в секундах (работает только для агрегатов) 3310 -|id|ID карты-метки 3311 -|parentId|ID клиента 3312 - 3313 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3314 - 3315 -(% class="box errormessage" %) 3316 -((( 3317 -**DELETE /api/v3/Rfids/{rfidGuid}** 3318 -))) 3319 - 3320 -Передаем параметр **rfidGuid** - идентификатор карты-метки 3321 - 3322 -Ответ: 3323 - 3324 -Success 3325 - 3326 - 3327 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3328 - 3329 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3330 - 3331 -(% class="box infomessage" %) 3332 -((( 3333 -**GET /api/v3/Billing/client/balance/{clientId}** 3334 -))) 3335 - 3336 -Параметр запроса: **clientId **- идентификатор клиента. 3337 - 3338 -Ответ: 3339 - 3340 -{ 3341 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3342 - "Balance": 0 3343 -} 3344 - 3345 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3346 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3347 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3348 - 3349 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3350 - 3351 -(% class="box infomessage" %) 3352 -((( 3353 -**GET /api/v3/Billing/client/constraint/{clientId}** 3354 -))) 3355 - 3356 -Параметр запроса: **clientId **- идентификатор клиента. 3357 - 3358 -Ответ: 3359 - 3360 -{ 3361 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3362 - "CalculationType": 0, 3363 - "PermissibleBalance": 0, 3364 - "DefermentDays": 0, 3365 - "SendUiNotifications": true, 3366 - "SendEmailNotifications": true, 3367 - "IsPrivate": true, 3368 -} 3369 - 3370 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3371 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3372 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3373 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3374 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3375 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3376 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3377 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3378 - 3379 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3380 - 3381 -(% class="box infomessage" %) 3382 -((( 3383 -**GET /api/v3/Billing/client/plan/{clientId}** 3384 -))) 3385 - 3386 -Параметры запроса: 3387 - 3388 -**clientId **- идентификатор клиента. 3389 - 3390 -**planId **- идентификатор тарифного плана. 3391 - 3392 -Ответ: 3393 - 3394 -{ 3395 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3396 - "Plan": { **~/~/ Описание тарифного плана** 3397 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3398 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3399 - "Name": "string", 3400 - "IsArchived": true, 3401 - "Constraint": { 3402 - "CalculationType": 0, 3403 - "PermissibleBalance": 0, 3404 - "DefermentDays": 0 3405 - }, 3406 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3407 - { 3408 - "Feature": "string", 3409 - "IsFactual": true, 3410 - "Limit": 0, 3411 - "Price": 0, 3412 - "PeriodValue": 0, 3413 - "PeriodType": 0 3414 - } 3415 - ] 3416 - }, 3417 - "DebitDate": "2023-10-18T12:46:24.213Z", 3418 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3419 - { 3420 - "Feature": "string", 3421 - "IsEnabled": true, 3422 - "IsPrivate": true, 3423 - "IsFactual": true, 3424 - "Limit": 0, 3425 - "Price": 0, 3426 - "DebitDate": "2023-10-18T12:46:24.213Z", 3427 - "PeriodValue": 0, 3428 - "PeriodType": 0 3429 - } 3430 - ] 3431 -} 3432 - 3433 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3434 -|ClientId|Идентификатор клиента 3435 -|Id|Идентификатор тарифного плана 3436 -|OwnerId|Идентификатор клиента-владельца 3437 -|Name|Наименование тарифного плана 3438 -|IsArchived|Признак, определяющий архивный тарифный план 3439 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3440 -|PermissibleBalance|Допустимый баланс 3441 -|DefermentDays|Отсрочка, количество дней 3442 -|Feature|Код услуги 3443 -|IsEnabled|Признак, определяющий активирована ли услуга 3444 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3445 -|IsFactual|Признак, определяющий расчёт по факту 3446 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3447 -|Price|Цена за единицу. 3448 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3449 -|PeriodValue|Значение периода. 3450 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3451 - 3452 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3453 - 3454 -(% class="box infomessage" %) 3455 -((( 3456 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3457 -))) 3458 - 3459 -Параметр запроса: **clientId **- идентификатор клиента. 3460 - 3461 -Ответ: 3462 - 3463 -[ 3464 - { 3465 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3466 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3467 - "Name": "string", 3468 - "IsArchived": true, 3469 - "Constraint": { 3470 - "CalculationType": 0, 3471 - "PermissibleBalance": 0, 3472 - "DefermentDays": 0 3473 - }, 3474 - "Features": [ 3475 - { 3476 - "Feature": "string", 3477 - "IsFactual": true, 3478 - "Limit": 0, 3479 - "Price": 0, 3480 - "PeriodValue": 0, 3481 - "PeriodType": 0 3482 - } 3483 - ] 3484 - } 3485 -] 3486 - 3487 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3488 -|ClientId|Идентификатор клиента 3489 -|Id|Идентификатор тарифного плана 3490 -|OwnerId|Идентификатор клиента-владельца 3491 -|Name|Наименование тарифного плана 3492 -|IsArchived|Признак, определяющий архивный тарифный план 3493 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3494 -|PermissibleBalance|Допустимый баланс 3495 -|DefermentDays|Отсрочка, количество дней 3496 -|Feature|Код услуги 3497 -|IsFactual|Признак, определяющий расчёт по факту 3498 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3499 -|Price|Цена за единицу. 3500 -|PeriodValue|Значение периода. 3501 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3502 - 3503 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3504 - 3505 -(% class="box infomessage" %) 3506 -((( 3507 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3508 -))) 3509 - 3510 -Параметр запроса: **clientId **- идентификатор клиента. 3511 - 3512 -Ответ: 3513 - 3514 -[ 3515 - { 3516 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3517 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3518 - "Name": "string", 3519 - "IsArchived": true, 3520 - "Constraint": { 3521 - "CalculationType": 0, 3522 - "PermissibleBalance": 0, 3523 - "DefermentDays": 0 3524 - }, 3525 - "Features": [ 3526 - { 3527 - "Feature": "string", 3528 - "IsFactual": true, 3529 - "Limit": 0, 3530 - "Price": 0, 3531 - "PeriodValue": 0, 3532 - "PeriodType": 0 3533 - } 3534 - ] 3535 - } 3536 -] 3537 - 3538 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3539 -|ClientId|Идентификатор клиента 3540 -|Id|Идентификатор тарифного плана 3541 -|OwnerId|Идентификатор клиента-владельца 3542 -|Name|Наименование тарифного плана 3543 -|IsArchived|Признак, определяющий архивный тарифный план 3544 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3545 -|PermissibleBalance|Допустимый баланс 3546 -|DefermentDays|Отсрочка, количество дней 3547 -|Feature|Код услуги 3548 -|IsFactual|Признак, определяющий расчёт по факту 3549 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3550 -|Price|Цена за единицу. 3551 -|PeriodValue|Значение периода. 3552 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3553 - 3554 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3555 - 3556 -(% class="box warningmessage" %) 3557 -((( 3558 -**PUT /api/v3/Billing/client/balance** 3559 -))) 3560 - 3561 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3562 - 3563 -Тело запроса: 3564 - 3565 -{ 3566 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3567 - "Balance": 0 3568 -} 3569 - 3570 -Ответ: Success 3571 - 3572 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3573 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3574 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3575 - 3576 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3577 - 3578 -(% class="box warningmessage" %) 3579 -((( 3580 -**PUT /api/v3/billing/client/balance/deposit** 3581 -))) 3582 - 3583 -Создает операцию **Пополнение **с указанной суммой 3584 - 3585 -Тело запроса: 3586 - 3587 -{ 3588 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3589 - "Balance": 0 3590 -} 3591 - 3592 -Ответ: Success 3593 - 3594 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3595 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3596 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3597 - 3598 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3599 - 3600 -Создает операцию **Списание **с указанной суммой 3601 - 3602 -(% class="box warningmessage" %) 3603 -((( 3604 -**PUT /api/v3/billing/client/balance/withdraw** 3605 -))) 3606 - 3607 -Тело запроса: 3608 - 3609 -{ 3610 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3611 - "Balance": 0 3612 -} 3613 - 3614 -Ответ: Success 3615 - 3616 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3617 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3618 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3619 - 3620 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3621 - 3622 -(% class="box warningmessage" %) 3623 -((( 3624 -**PUT /api/v3/Billing/client/constraint** 3625 -))) 3626 - 3627 -Тело запроса: 3628 - 3629 -{ 3630 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3631 - "CalculationType": 0, 3632 - "PermissibleBalance": 0, 3633 - "DefermentDays": 0, 3634 - "SendUiNotifications": true, 3635 - "SendEmailNotifications": true, 3636 - "IsPrivate": true, 3637 -} 3638 - 3639 -Ответ: Success 3640 - 3641 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3642 -|ClientId|Идентификатор клиента 3643 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3644 -|PermissibleBalance|Допустимый баланс 3645 -|DefermentDays|((( 3646 -Отсрочка, количество дней 3647 -))) 3648 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3649 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3650 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3651 - 3652 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3653 - 3654 -(% class="box warningmessage" %) 3655 -((( 3656 -**PUT /api/v3/Billing/client/plan** 3657 -))) 3658 - 3659 -Тело запроса: 3660 - 3661 -{ 3662 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3663 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3664 - "Features": [ 3665 - { 3666 - "Feature": "string", 3667 - "IsEnabled": true, 3668 - "IsFactual": true, 3669 - "Limit": 0, 3670 - "Price": 0, 3671 - "DebitDate": "2023-10-18T13:26:58.987Z", 3672 - "PeriodValue": 0, 3673 - "PeriodType": 0 3674 - } 3675 - ] 3676 -} 3677 - 3678 -Ответ: Success 3679 - 3680 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3681 -|ClientId|Идентификатор клиента 3682 -|PlanId|Идентификатор тарифного плана 3683 -|Feature|Код услуги 3684 -|IsEnabled|Признак, определяющий активирована ли услуга 3685 -|IsFactual|Признак, определяющий расчёт по факту 3686 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3687 -|Price|Цена за единицу. 3688 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3689 -|PeriodValue|Значение периода. 3690 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3691 - 3692 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3693 - 3694 -(% class="box warningmessage" %) 3695 -((( 3696 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3697 -))) 3698 - 3699 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3700 - 3701 -(% class="box infomessage" %) 3702 -((( 3703 -**POST /api/v3/vehicles/import/{agentId}** 3704 -))) 3705 - 3706 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3707 - 3708 -В пути указывается **agentId** - id клиента. 3709 - 3710 -**Заголовок** 3711 - 3712 -**X-Auth: [токен авторизации]** 3713 - 3714 -**Параметры** 3715 - 3716 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3717 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3718 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3719 - 3720 -В теле использовать тип **form-data,** тип значения** file** 3721 - 3722 -**Ключи** 3723 - 3724 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3725 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3726 -|csv|В значении передаем файл датчиков, формат **csv** 3727 - 3728 -Ответ: 3729 - 3730 -{ 3731 - "vehicleId": 0, 3732 - "name": "string", 3733 - "errors": ["string"] 3734 -} 3735 - 3736 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3737 -|vehicleId|ID созданного объекта 3738 -|name|Имя созданного объекта 3739 -|errors|Ошибки и их описание 3740 - 3741 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3742 - 3743 -(% class="box infomessage" %) 3744 -((( 3745 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3746 -))) 3747 - 3748 -(% class="wikigeneratedid" %) 3749 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3750 - 3751 -(% class="wikigeneratedid" %) 3752 -В пути указывается **vehicleId **- id объекта. 3753 - 3754 -**Заголовок** 3755 - 3756 -**X-Auth: [токен авторизации]** 3757 - 3758 -В теле использовать тип **form-data.** 3759 - 3760 -Ключи: 3761 - 3762 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3763 -|**history**|В значении передавать файл с историей 3764 - 3765 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3766 - 3767 -Ответ: 3768 - 3769 -{ 3770 - "results": [ 3771 - { 3772 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3773 - "vehicleId": 0, 3774 - "errors": [ 3775 - "string" 3776 - ], 3777 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3778 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3779 - "producedCount": 0, 3780 - "msgCount": 0 3781 - } 3782 - ] 3783 -} 3784 - 3785 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3786 -|results|Результаты импорта в разрезе ТС 3787 -|vehicleGuid|Guid ТС 3788 -|vehicleId|ID ТС 3789 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3790 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3791 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3792 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3793 -|msgCount|Кол-во обработанных сообщений всего 3794 - 3795 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3796 - 3797 -(% class="box infomessage" %) 3798 -((( 3799 -**GET /api/v3/vehicles/import/history/status** 3800 -))) 3801 - 3802 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3803 - 3804 -Ответ: 3805 - 3806 -{ 3807 - "activity": true, 3808 - "progress": 0, 3809 - "message": "string" 3810 -} 3811 - 3812 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3813 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3814 -|progress|Guid ТС 3815 - 3816 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3817 - 3818 -(% class="box infomessage" %) 3819 -((( 3820 -**POST /api/v3/vehicles/export** 3821 -))) 3822 - 3823 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3824 - 3825 -Тело запроса: 3826 - 3827 -[ 3828 - id 3829 -] 3830 - 3831 -Ответ: Success 200, получаете файлы с настройками. 3832 - 3833 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3834 - 3835 -(% class="box infomessage" %) 3836 -((( 3837 -**POST /api/v3/vehicles/export/history** 3838 -))) 3839 - 3840 -Метод возвращает список сообщений терминала объекта за выбранный период. 3841 - 3842 -Тело запроса: 3843 - 3844 -{ 3845 - "vehicleId": 0, 3846 - "asArchive": true, 3847 - "from": "2023-09-27T12:17:45.973Z", 3848 - "to": "2023-09-27T12:17:45.973Z" 3849 -} 3850 - 3851 -Ответ: 3852 - 3853 -Получаете файл. Сообщение: Code 200/Success 3854 - 3855 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3856 -|vehicleId|ID объекта 3857 -|asArchive|true - Архивировать файл, False - не архивировать 3858 -|from|Дата и время начала запроса 3859 -|to|Дата и время окончания запроса 3860 - 3861 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3862 - 3863 -(% class="box infomessage" %) 3864 -((( 3865 -**GET /api/v3/vehicles/export/history/status** 3866 -))) 3867 - 3868 -Метод возвращает список сообщений терминала объекта за выбранный период. 3869 - 3870 -Ответ: 3871 - 3872 -{ 3873 - "activity": true, 3874 - "progress": 0, 3875 - "message": "string" 3876 -} 3877 - 3878 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3879 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3880 -|progress|Прогресс экспорта, от 0 до 100% 3881 -|message|Текст описывающий статус 3882 - 3883 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3884 - 3885 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3886 - 3887 -(% class="box infomessage" %) 3888 -((( 3889 -**POST /api/v3/EcoDriving/rating** 3890 -))) 3891 - 3892 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3893 - 3894 -Тело запроса: 3895 - 3896 -{ 3897 - "vehicleIds": [vehicleId], 3898 - "from": "2023-11-22T09:29:48.051Z", 3899 - "to": "2023-11-22T09:29:48.051Z" 3900 -} 3901 - 3902 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3903 -|vehicleIds|Массив ID объектов 3904 -|from|Дата начала запроса 3905 -|to|Дата окончания запроса 3906 - 3907 -Ответ: 3908 - 3909 -{ 3910 - "items": [ 3911 - { 3912 - "from": "2023-11-22T09:29:48.052Z", 3913 - "to": "2023-11-22T09:29:48.052Z", 3914 - "vehicleId": 0, 3915 - "vehicleName": "string", 3916 - "vehicleModel": "string", 3917 - "penalty": 0, 3918 - "score": 0, 3919 - "totalViolations": 0, 3920 - "violationsByType": { 3921 - "overspeedingViolations": 0, 3922 - "accelerationViolations": 0, 3923 - "brakingViolations": 0, 3924 - "turningViolations": 0, 3925 - "dangerousDrivingViolations": 0, 3926 - "sensorViolations": 0 3927 - }, 3928 - "moveTime": 0, 3929 - "mileage": 0, 3930 - "tripsCount": 0, 3931 - "trips": [ 3932 - { 3933 - "penalty": 0, 3934 - "score": 0, 3935 - "violationsCount": 0, 3936 - "violationsByType": { 3937 - "overspeedingViolations": 0, 3938 - "accelerationViolations": 0, 3939 - "brakingViolations": 0, 3940 - "turningViolations": 0, 3941 - "dangerousDrivingViolations": 0, 3942 - "sensorViolations": 0 3943 - }, 3944 - "moveTime": 0, 3945 - "mileage": 0, 3946 - "motohours": 0, 3947 - "maxSpeed": 0, 3948 - "startAddress": "string", 3949 - "endAddress": "string", 3950 - "drivers": [ 3951 - { 3952 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3953 - "driverName": "string", 3954 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3955 - } 3956 - ] 3957 - } 3958 - ] 3959 - } 3960 - ] 3961 -} 3962 - 3963 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3964 -|from|Дата начала запроса 3965 -|to|Дата окончания 3966 -|vehicleId|ID объекта 3967 -|vehicleName|Имя объекта 3968 -|vehicleModel|Модель объекта 3969 -|penalty|Сумма штрафных баллов 3970 -|score|Оценка 3971 -|totalViolations|Суммарное количество нарушений 3972 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3973 -|overspeedingViolations|Превышение скорости 3974 -|accelerationViolations|Ускорение 3975 -|brakingViolations|Торможение 3976 -|turningViolations|Резкий поворот 3977 -|dangerousDrivingViolations|Резкое вождение 3978 -|sensorViolations|Нарушение по датчику 3979 -|moveTime|Время в движении 3980 -|mileage|Пробег 3981 -|tripsCount|Количество рейсов 3982 -|motohours|Моточасы 3983 -|maxSpeed|Максимальная скорость 3984 -|startAddress|Адрес начала рейса 3985 -|endAddress|Адрес окончания рейса 3986 -|drivers|Список водителей, которые были на объекте в течениии рейса 3987 -|driverGuid|Guid водителя 3988 -|driverName|Имя водителя 3989 -|driverRfid|Номер Карты-метки 3990 - 3991 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3992 - 3993 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 3994 - 3995 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 3996 - 3997 -(% class="box infomessage" %) 3998 -((( 3999 -POST /api/v3/fuelcards/transactions 4000 -))) 4001 - 4002 -Метод запроса: POST 4003 - 4004 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4005 -\\В заголовках запроса: X-Auth: Токен авторизации 4006 - 4007 -Параметры в теле запроса (JSON): 4008 - 4009 -{ 4010 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4011 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4012 - "ids": [ 4013 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4014 - ], 4015 - "timezone": 0 ~/~/Таймзона 4016 -} 4017 - 4018 - 4019 -Ответ: 4020 - { 4021 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4022 - "driver": "string", ~/~/Водители, привязанные к ТК 4023 - "object": "string", ~/~/Наименование ТС 4024 - "amount": 0, ~/~/Количество топлива 4025 - "amountDut": 0, ~/~/Количество по ДУТ 4026 - "amountDiff": 0, ~/~/Разница, л 4027 - "amountDiffPerc": 0, ~/~/Разница, % 4028 - "summa": 0, ~/~/Стоимость, руб 4029 - "serviceName": "string", ~/~/Тип топлива 4030 - "price": 0, ~/~/Цена за литр, руб 4031 - "cardName": "string", ~/~/Наименование ТК 4032 - "cardNum": "string", ~/~/Номер ТК 4033 - "operator": "string", ~/~/Оператор ТК 4034 - "address": "string" ~/~/Адрес АЗС 4035 - } 4036 - 4037 - 4038 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4039 - 4040 - 4041 -== **Получение полных данных о ретрансляторе** == 4042 - 4043 -(% class="box infomessage" %) 4044 -((( 4045 -**GET ** **/api/v3/retranslations/{id}** 4046 -))) 4047 - 4048 -Идентификатор запроса: ID 4049 - 4050 - 4051 -Пример ответа: 4052 - 4053 -{ 4054 -"description": "", ~/~/ Определяет описание 4055 -"subscriberId": "", ~/~/ Подписчик 4056 -"protocolType": 0, ~/~/ Тип протокола 4057 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4058 -"address": "string", ~/~/ Адрес события 4059 -"objects": [ ~/~/Объекты для ретрансляции 4060 -{ 4061 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4062 -"name": "", ~/~/ Наименование объекта ретрансляции 4063 -"imei": "", ~/~/ IMEI объекта 4064 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4065 -} 4066 - ], 4067 -"id": "", ~/~/ идентификатор пользователя 4068 -"parentId": "", ~/~/Guid родителя 4069 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4070 -} 4071 - 4072 - 4073 -== **Удаление данных ретранслятора** == 4074 - 4075 -(% class="box infomessage" %) 4076 -((( 4077 -**DELETE** **/api/v3/retranslations/{id}** 4078 -))) 4079 - 4080 -Параметр запроса: ID 4081 - 4082 - 4083 -== **Создание ретранслятора** == 4084 - 4085 -(% class="box infomessage" %) 4086 -((( 4087 -**POST ** **/api/v3/retranslations/{id}** 4088 -))) 4089 - 4090 -Запрос: 4091 - 4092 -{ 4093 -"description": "", ~/~/ Описание 4094 -"subscriberId": "", ~/~/ Подписчик 4095 -"protocolType": 0, ~/~/ Тип протокола 4096 -"address": "", ~/~/ Адрес ретрансляции 4097 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4098 -"objects": [ ~/~/Объекты для ретрансляции 4099 -{ 4100 -"id": "", ~/~/ идентификатор пользователя 4101 -"imei": "", ~/~/IMEI объекта 4102 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4103 -} 4104 - ] 4105 -} 4106 - 4107 - 4108 -Ответ: 4109 - 4110 -{ 4111 -"description": "string", ~/~/ Определяет описание 4112 -"subscriberId": "", ~/~/ идентификатор запроса 4113 -"protocolType": 0, ~/~/ Тип протокола 4114 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4115 -"address": "", ~/~/ Адрес события 4116 -"objects": [ ~/~/Объекты для ретрансляции 4117 -{ 4118 -"id": "", ~/~/ идентификатор пользователя 4119 -"name": "string", ~/~/ Название уведомления 4120 -"imei": "string", ~/~/IMEI объекта 4121 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4122 -} 4123 - ], 4124 -"id": "", ~/~/ идентификатор пользователя 4125 -"parentId": "", ~/~/ Guid идентификатор родителя 4126 -"deleted": true ~/~/ Признак удаления 4127 -} 4128 - 4129 - 4130 -== **Редактирование ретранслятора** == 4131 - 4132 -(% class="box infomessage" %) 4133 -((( 4134 -**PUT** **/api/v3/retranslations** 4135 -))) 4136 - 4137 -Пример запроса: 4138 - 4139 -{ 4140 -"id": "", ~/~/ идентификатор пользователя 4141 -"description": "string", ~/~/ Определяет описание 4142 -"subscriberId": "", ~/~/ идентификатор запроса 4143 -"protocolType": 0, ~/~/ Тип протокола 4144 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4145 -"address": "string", ~/~/ Адрес события 4146 -"objects": ~/~/Объекты для ретрансляции 4147 -[ 4148 -{ 4149 -"id": "", ~/~/ идентификатор пользователя 4150 -"imei": "", ~/~/IMEI объекта 4151 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4152 -} 4153 - ] 4154 -} 4155 - 4156 - 4157 -Пример ответа: 4158 - 4159 -{ 4160 -"description": "", ~/~/ Определяет описание 4161 -"subscriberId": "", ~/~/ идентификатор запроса 4162 -"protocolType": 0, ~/~/ Тип протокола 4163 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4164 -"address": "string", ~/~/ Адрес события 4165 -"objects": [ ~/~/Объекты для ретрансляции 4166 -{ 4167 -"id": "", ~/~/ идентификатор пользователя 4168 -"name": "string", ~/~/ Название уведомления 4169 -"imei": "", ~/~/IMEI объекта 4170 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4171 -} 4172 - ], 4173 -"id": "", ~/~/ идентификатор пользователя 4174 -"parentId": "", ~/~/ Guid идентификатор родителя 4175 -"deleted": true ~/~/ Признак удаления 4176 -} 4177 - 4178 - 4179 -== **Получение списка ретранслятора клиента** == 4180 - 4181 -(% class="box infomessage" %) 4182 -((( 4183 -**POST /api/v3/retranslations/find** 4184 -))) 4185 - 4186 -Пример запроса: 4187 - 4188 -{ 4189 -"id": "", ~/~/ идентификатор пользователя 4190 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4191 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4192 -} 4193 - 4194 -Ответ: 4195 - 4196 -[ 4197 -{ 4198 -"description": "", ~/~/ Определяет описание 4199 -"subscriberId": "", ~/~/ идентификатор запроса 4200 -"protocolType": 0, ~/~/ Тип протокола 4201 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4202 -"address": "string", ~/~/ Адрес события 4203 -"id": "", ~/~/ идентификатор пользователя 4204 -"parentId": "", ~/~/ Guid идентификатор родителя 4205 -"deleted": true ~/~/ Признак удаления 4206 -} 4207 -] 4208 - 4209 - 4210 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4211 - 4212 -== **API для отчета по выгрузке комбайнов** == 4213 - 4214 -(% class="box infomessage" %) 4215 -((( 4216 -POST **/api/v3/Reports/harvesterUnloading** 4217 -))) 4218 - 4219 -Пример запроса: 4220 - 4221 -{ 4222 - "byTime": 0, ~/~/ Объединение событий по времени 4223 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4224 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4225 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4226 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4227 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4228 - 0 4229 - ], 4230 - "from": "", ~/~/ Дата и время начало запроса 4231 - "to": "", ~/~/ Дата и время окончания запроса 4232 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4233 -} 4234 - 4235 -Пример ответа: 4236 - 4237 -[ 4238 - { 4239 - "harvesterName": "", ~/~/Комбайн, номер 4240 - "harvesterId": 0, ~/~/Комбайн, id 4241 -"harvesterModel": "", ~/~/ Модель комбайна 4242 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4243 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4244 - "events": [ ~/~/Список событий в разрезе комбайна 4245 - { 4246 - "driverId": "", ~/~/Идентификатор водителя 4247 - "driverName": "", ~/~/Водитель комбайна, ФИО 4248 - "RFID": "", ~/~/ идентификатор карты-метки 4249 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4250 - "vehicleId": 0, ~/~/идентификатор объекта 4251 - "vehicleName": "string", ~/~/ Имя объекта 4252 - "modelName": "string", ~/~/ Имя модели объекта 4253 - "nearestVehicles": [ ~/~/Объекты рядом 4254 - { 4255 - "vehicleId": 0, ~/~/идентификатор объекта 4256 - "vehicleName": "string" ~/~/ Имя объекта 4257 - } 4258 - ], 4259 - "fields": [ ~/~/Поля, где происходила выгрузка 4260 - { 4261 - "id": 0, ~/~/ идентификатор пользователя 4262 - "name": "string" ~/~/ имя пользователя 4263 - } 4264 - ], 4265 - "event": "string", ~/~/Событие 4266 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4267 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4268 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4269 - "cultureName": "string", ~/~/ название культуры 4270 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4271 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4272 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4273 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4274 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4275 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4276 - "issued": 0, ~/~/Выдано, бункеров 4277 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4278 - "latitude": 0, ~/~/Широта 4279 - "longitude": 0, ~/~/ Долгота 4280 - "litresAway": 0, ~/~/Отдано, л 4281 - "m3Away": 0 ~/~/Отдано, м3 4282 - } 4283 - ] 4284 - } 4285 -] 4286 - 4287 - 4288 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4289 - 4290 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4291 - 4292 - 4293 -(% class="box infomessage" %) 4294 -((( 4295 -GET api/v3/Vehicles/recyclebin/all 4296 -))) 4297 - 4298 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4299 - 4300 -Параметр запроса: {parentId} - идентификатор агента 4301 - 4302 -В заголовках запроса: X-Auth: Токен авторизации 4303 - 4304 -Ответ: 4305 - 4306 -[ 4307 - { 4308 - "recordTime": "", ~/~/Время записи 4309 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4310 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4311 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4312 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4313 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4314 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4315 - "items": [ ~/~/ 4316 -nullable: true ~/~/Детали 4317 - { 4318 - "name": "string", ~/~/наименование столбца 4319 - "value": "string" ~/~/содержание столбца 4320 - } 4321 - ] 4322 - }, 4323 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4324 - "string" 4325 - ] 4326 - } 4327 -] 4328 - 4329 - 4330 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4331 - 4332 -(% class="box infomessage" %) 4333 -((( 4334 -POST/api/v3/Vehicles/recyclebin/erase 4335 -))) 4336 - 4337 -В заголовках запроса: X-Auth: Токен авторизации 4338 - 4339 -Пример запроса: 4340 - 4341 -[ 4342 -0 4343 -] 4344 - 4345 - 4346 -Пример ответа: 4347 - 4348 -[ 4349 -{ 4350 - "recordTime": "", ~/~/Время записи 4351 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4352 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4353 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4354 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4355 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4356 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4357 - "items": [ ~/~/Детали 4358 - { 4359 - "name": "", ~/~/Имя свойства 4360 - "value": "" ~/~/Значение свойства 4361 - } 4362 - ] 4363 - }, 4364 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4365 - "" 4366 - ] 4367 - } 4368 -] 4369 - 4370 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4371 - 4372 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4373 - 4374 -(% class="box infomessage" %) 4375 -((( 4376 -POST/api/v3/Vehicles/recyclebin/restore 4377 -))) 4378 - 4379 -В заголовках запроса: X-Auth: Токен авторизации 4380 - 4381 -Параметры в теле запроса (JSON): 4382 - 4383 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4384 - 4385 -В заголовках запроса: X-Auth: Токен авторизации 4386 - 4387 - 4388 -Пример запроса: 4389 - 4390 -((( 4391 -[ 4392 -))) 4393 - 4394 -((( 4395 - 0 4396 -))) 4397 - 4398 -((( 4399 -] 4400 -))) 4401 - 4402 - 4403 -Пример ответа: 4404 - 4405 -[ 4406 -{ 4407 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4408 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4409 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4410 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4411 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4412 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4413 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4414 - "items": [ ~/~/Детали 4415 - { 4416 - "name": "string", ~/~/Имя свойства 4417 - "value": "string" ~/~/Значение свойства 4418 - } 4419 - ] 4420 - }, 4421 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4422 - "string" 4423 - ] 4424 - } 4425 -] 4426 - 4427 - 4428 - 4429 4429 (% class="box" lang="en-US" style="text-align: center;" %) 4430 4430 ((( 4431 4431 (% 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,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB - Content