Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/17 16:44
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Artem - Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Public API|API - Content
-
... ... @@ -10,7 +10,7 @@ 10 10 11 11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__(токен авторизации, получаемый методом__**auth/login**__).13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 ... ... @@ -20,27 +20,20 @@ 20 20 (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 21 ))) 22 22 23 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 24 24 ((( 25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)** POST25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 26 ))) 27 27 28 28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** POST**30 +(% style="color:#000000" %)Метод запроса: **GET** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]] 33 33 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 - 38 -(% style="color:#000000" %){ 39 - "login": "testuser", 40 - "password": "testuser" 41 -}(%%) 42 - 43 - 36 +(% lang="en-US" %) 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -47,8 +47,8 @@ 47 47 (% style="color:#000000" %){ 48 48 49 49 (% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": " (%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000"%)", ~/~/ токен авторизации51 - "User": " testuser" , ~/~/ имя пользователя43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 + "User": "" , ~/~/ имя пользователя 52 52 53 53 (% lang="en-US" %) 54 54 } ... ... @@ -61,7 +61,7 @@ 61 61 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 62 62 ))) 63 63 64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 65 65 66 66 (% style="color:#000000" %)Метод запроса: **GET** 67 67 ... ... @@ -83,7 +83,7 @@ 83 83 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 84 84 ))) 85 85 86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 87 87 88 88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 89 89 ... ... @@ -107,7 +107,7 @@ 107 107 "name": "", ~/~/ наименование клиента 108 108 "fullName": "", ~/~/ полное наименование клиента 109 109 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 110 - "status": "", ~/~/ статус клиента (0-Новый,1-Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)103 + "status": "", ~/~/ статус клиента 111 111 } 112 112 113 113 ... ... @@ -121,7 +121,7 @@ 121 121 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 122 122 ))) 123 123 124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 125 125 126 126 (% style="color:#000000" %)Метод запроса: **POST** 127 127 ... ... @@ -137,9 +137,9 @@ 137 137 "position": "", ~/~/ должность 138 138 "phone": "", ~/~/ телефон 139 139 "organization": "", ~/~/ организация 140 - "login": "", ~/~/ логин (обязателен)141 - "password": "", ~/~/ пароль (обязателен) 142 - "email": "", ~/~/ email (обязателен)133 + "login": "", ~/~/ логин 134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 135 + "email": "", ~/~/ email 143 143 "description": "", ~/~/ описание 144 144 "isEnabled": "", ~/~/ признак включения 145 145 "parentId": "", ~/~/ Guid родительского агента ... ... @@ -148,7 +148,7 @@ 148 148 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 149 149 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 150 150 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 151 - "groups": ["",""], ~/~/ группы пользователя,перечисление названия групп(data-row)144 + "groups": "" , ~/~/ группы пользователя, названия групп 152 152 } 153 153 154 154 (% style="text-align:left" %) ... ... @@ -174,7 +174,7 @@ 174 174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 175 175 "kind": "" , ~/~/ тип аутентификации 176 176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 177 - "groups": (% style="color:#000000"%)["",""](% style="color:#000000; font-weight:normal" %),~/~/ ролипользователя,перечислены названия групп170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 178 178 179 179 (% style="text-align:left" %) 180 180 (% style="color:#000000; font-weight:normal" %)} ... ... @@ -187,7 +187,7 @@ 187 187 188 188 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 189 189 190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **« __Просмотр пользователей__»**.183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 191 191 192 192 (% style="color:#000000" %)Метод запроса: **POST** 193 193 ... ... @@ -227,188 +227,12 @@ 227 227 (% style="color:#000000" %)} 228 228 229 229 230 -(% class="box successmessage" %) 231 -((( 232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}** 233 -))) 234 - 235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 236 - 237 -(% style="color:#000000" %)Метод запроса: **GET** 238 - 239 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 240 - 241 -(% style="color:#000000" %)Ответ: 242 - 243 -((( 244 -((( 245 -{ 246 -))) 247 -))) 248 - 249 -((( 250 -((( 251 - "id": "", ~/~/ GUID пользователя 252 -))) 253 -))) 254 - 255 -((( 256 -((( 257 - "lastName": "", ~/~/ Фамилия 258 -))) 259 -))) 260 - 261 -((( 262 -((( 263 - "firstName": "", ~/~/ Имя 264 -))) 265 -))) 266 - 267 -((( 268 -((( 269 - "position": "", ~/~/ Должность 270 -))) 271 -))) 272 - 273 -((( 274 -((( 275 - "phone": "", ~/~/ Номер телефона 276 -))) 277 -))) 278 - 279 -((( 280 -((( 281 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 282 -))) 283 -))) 284 - 285 -((( 286 -((( 287 - "parentName": "", Наименование клиента, которому принадлежит пользователь 288 -))) 289 -))) 290 - 291 -((( 292 -((( 293 - "organization": "", ~/~/ Организация 294 -))) 295 -))) 296 - 297 -((( 298 -((( 299 - "login": "", ~/~/ Логин пользователя 300 -))) 301 -))) 302 - 303 -((( 304 -((( 305 - "email": "", ~/~/ Адрес электронной почты 306 -))) 307 -))) 308 - 309 -((( 310 -((( 311 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 312 -))) 313 -))) 314 - 315 -((( 316 -((( 317 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 318 -))) 319 -))) 320 - 321 -((( 322 -((( 323 - "description": "", ~/~/ Описание 324 -))) 325 -))) 326 - 327 -((( 328 -((( 329 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 330 -))) 331 -))) 332 - 333 -((( 334 -((( 335 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 336 -))) 337 -))) 338 - 339 -((( 340 -((( 341 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 342 -))) 343 -))) 344 - 345 -((( 346 -((( 347 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 348 -))) 349 -))) 350 - 351 -((( 352 -((( 353 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 354 -))) 355 -))) 356 - 357 -((( 358 -((( 359 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 360 -))) 361 -))) 362 - 363 -((( 364 -((( 365 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 366 -))) 367 -))) 368 - 369 -((( 370 -((( 371 - "groups": [], ~/~/ Список ролей пользователя 372 -))) 373 -))) 374 - 375 -((( 376 -((( 377 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 378 -))) 379 -))) 380 - 381 -((( 382 -((( 383 - "authDevices": [ ], ~/~/ Список авторизованных устройств 384 -))) 385 -))) 386 - 387 -((( 388 -((( 389 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 390 -))) 391 -))) 392 - 393 -((( 394 -((( 395 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 396 -))) 397 -))) 398 - 399 -((( 400 -((( 401 -} 402 -))) 403 -))) 404 - 405 - 406 406 (% class="box warningmessage" %) 407 407 ((( 408 408 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 409 409 ))) 410 410 411 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 412 412 413 413 (% style="color:#000000" %)Метод запроса: **PUT** 414 414 ... ... @@ -429,10 +429,10 @@ 429 429 "position": "" , ~/~/ должность 430 430 "phone": "" , ~/~/ телефон 431 431 "organization": "" , ~/~/ организация 432 - "login": "" , ~/~/ логин (%style="color:#000000"%)(Если null - менять не надо)(%%)433 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"password": "" , ~/~/ пароль (Если null - менять434 - "email": "" , ~/~/ email (%style="color:#000000"%)(Если null - менять не надо)(%%)435 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"description": "" , ~/~/ описание249 + "login": "" , ~/~/ логин 250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 251 + "email": "" , ~/~/ email 252 + "description": "" , ~/~/ описание 436 436 "isEnabled": "" , ~/~/ признак включения 437 437 "parentId": "" , ~/~/ Guid родительского агента 438 438 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) ... ... @@ -479,7 +479,7 @@ 479 479 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 480 480 ))) 481 481 482 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 483 483 484 484 (% style="color:#000000" %)Метод запроса: **PUT** 485 485 ... ... @@ -503,69 +503,12 @@ 503 503 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 504 504 505 505 506 -(% class="box warningmessage" %) 507 -((( 508 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 509 -))) 510 - 511 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 512 - 513 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 514 - 515 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 516 - 517 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 518 - 519 - [ 520 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 521 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 522 - ] 523 - 524 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 525 - 526 - 527 -(% class="box warningmessage" %) 528 -((( 529 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable** 530 -))) 531 - 532 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 533 - 534 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 535 - 536 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 537 - 538 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 539 - 540 - [ 541 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 542 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 543 - ] 544 - 545 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 546 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 547 - 548 -((( 549 -В теле ответа: 550 -{ 551 - "errorMessages": [ 552 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 553 - ], 554 - "users": [ 555 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 556 - ] 557 -} 558 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 559 -"users" - массив id пользователей, которых не удалось включить или отключить. 560 - 561 -))) 562 - 563 563 (% class="box errormessage" %) 564 564 ((( 565 565 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 566 566 ))) 567 567 568 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 569 569 570 570 (% style="color:#000000" %)Метод запроса: **DELETE** 571 571 ... ... @@ -591,7 +591,7 @@ 591 591 592 592 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 593 593 594 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 595 595 596 596 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 597 597 ... ... @@ -607,149 +607,22 @@ 607 607 608 608 (% style="color:#000000" %)Ответ: 609 609 610 -((( 611 -{ 612 -))) 370 +(% style="color:#000000" %){ 613 613 614 -((( 615 - "vehicleId": "", ~/~/ ID объекта 616 -))) 372 + "vehicleId": "" , ~/~/ идентификатор объекта 373 + "name": "" , ~/~/ имя объекта 374 + "imei": "" , ~/~/ IMEI объекта 375 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 376 + "deviceTypeName": "" , ~/~/ наименование устройства объекта 377 + "parentId": "" , ~/~/ идентификатор клиента-родителя 378 + "parentName": "" , ~/~/ наименование клиента-родителя, 379 + "modelId": "" , ~/~/ идентификатор модели объекта 380 + "modelName": "" , ~/~/ наименование модели объекта, 381 + "unitId": "" , ~/~/ идентификатор подразделения 382 + "unitName": "" , ~/~/ наименование подразделения 383 + "status": "" , ~/~/ статус объекта 617 617 618 -((( 619 - "name": "", ~/~/ Имя объекта 620 -))) 621 - 622 -((( 623 - "imei": "", ~/~/ IMEI объекта 624 -))) 625 - 626 -((( 627 - "deviceTypeId": , ~/~/ ID типа устройства 628 -))) 629 - 630 -((( 631 - "deviceTypeName": "", ~/~/ Название типа устройства 632 -))) 633 - 634 -((( 635 - "sim1": "", ~/~/ Номер SIM1 636 -))) 637 - 638 -((( 639 - "parentId": "", Номер SIM2 640 -))) 641 - 642 -((( 643 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 644 -))) 645 - 646 -((( 647 - "modelId": "", ID модели объекта 648 -))) 649 - 650 -((( 651 - "modelName": "", Имя модели объекта 652 -))) 653 - 654 -((( 655 - "createdAt": "", Дата создания объекта 656 -))) 657 - 658 -((( 659 - "mileageCalcMethod": "", Выбранный метод расчета пробега 660 -))) 661 - 662 -((( 663 - "counters": { ~/~/ Нормы 664 -))) 665 - 666 -((( 667 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 668 -))) 669 - 670 -((( 671 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 672 -))) 673 - 674 -((( 675 - "mileage": "", ~/~/ Пробег по нормам в метрах 676 -))) 677 - 678 -((( 679 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 680 -))) 681 - 682 -((( 683 - }, 684 -))) 685 - 686 -((( 687 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 688 -))) 689 - 690 -((( 691 - { 692 -))) 693 - 694 -((( 695 - "id": "", ~/~/ ID задания 696 -))) 697 - 698 -((( 699 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 700 -))) 701 - 702 -((( 703 - "name": "", ~/~/ Наименование задания 704 -))) 705 - 706 -((( 707 - "description": "", ~/~/ Описание задания 708 -))) 709 - 710 -((( 711 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 712 -))) 713 - 714 -((( 715 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 716 -))) 717 - 718 -((( 719 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 720 -))) 721 - 722 -((( 723 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 724 -))) 725 - 726 -((( 727 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 728 -))) 729 - 730 -((( 731 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 732 -))) 733 - 734 -((( 735 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 736 -))) 737 - 738 -((( 739 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 740 -))) 741 - 742 -((( 743 - } 744 -))) 745 - 746 -((( 747 - ] 748 -))) 749 - 750 -((( 751 751 } 752 -))) 753 753 754 754 (% style="text-align:left" %) 755 755 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -763,7 +763,7 @@ 763 763 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 764 764 ))) 765 765 766 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**, //Content-Type//:__**application/json**__; //charset//=__**utf-8**__).399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 767 767 768 768 (% style="color:#000000" %)Метод запроса: **POST** 769 769 ... ... @@ -785,22 +785,12 @@ 785 785 "sim2": "" , ~/~/ Номер SIM2 786 786 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 787 787 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 788 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 789 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 790 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 791 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 792 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 793 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 794 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 795 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 798 - "counters": ~/~/ счетчики 799 - { 800 - "mileage": "" , ~/~/ пробег 801 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 802 - "motohours": "" , ~/~/ моточасы 803 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "" , ~/~/ пробег 424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 + "motohours": "" , ~/~/ моточасы 426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 804 804 }, 805 805 "cmsv6Parameters": { ~/~/ параметры CMSv6 806 806 "enabled": true, ~/~/ флаг включения ... ... @@ -871,12 +871,7 @@ 871 871 (% style="text-align:left" %) 872 872 (% style="color:#000000" %)} 873 873 874 -**Валидация:** 875 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 878 879 - 880 880 (% class="box successmessage" %) 881 881 ((( 882 882 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -884,7 +884,7 @@ 884 884 885 885 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 886 886 887 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 888 888 889 889 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 890 890 ... ... @@ -912,13 +912,13 @@ 912 912 913 913 (% class="western" style="color:#000000" %)##{## 914 914 915 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 916 916 "name": null, ~/~/ Имя ТС (string, опционально) 917 917 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 918 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 919 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 920 "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 922 922 (% style="color:#000000" %)} 923 923 924 924 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -940,21 +940,23 @@ 940 940 "modelName": "" ~/~/ наименование модели объекта 941 941 "unitId": "" ~/~/ идентификатор подразделения 942 942 "unitName": "" ~/~/ наименование подразделения 943 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 944 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 945 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 946 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 561 + "status": "" ~/~/ статус объекта 562 + "createdAt": "" ~/~/ дата создания объектов (%%) 947 947 (% style="color:#000000" %)} 948 948 949 949 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 950 950 567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 951 951 569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 570 + 571 + 952 952 (% class="box successmessage" %) 953 953 ((( 954 954 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 955 955 ))) 956 956 957 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 958 958 959 959 (% style="color:#000000" %)Метод запроса: **POST** 960 960 ... ... @@ -999,7 +999,7 @@ 999 999 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 1000 1000 ))) 1001 1001 1002 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1003 1003 1004 1004 (% style="color:#000000" %)Метод запроса: **PUT** 1005 1005 ... ... @@ -1011,7 +1011,6 @@ 1011 1011 1012 1012 (% style="color:#000000" %){ 1013 1013 1014 -((( 1015 1015 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1016 1016 "parentId": "", ~/~/ ID клиента 1017 1017 "name": "", ~/~/ имя ТС ... ... @@ -1020,25 +1020,15 @@ 1020 1020 "modelId": "", ~/~/ , ID модели 1021 1021 "unitId": "", ~/~/ подразделения 1022 1022 "sim1": "", ~/~/ SIM 1 1023 - "sim2": "", ~/~/ SIM2 (%%) 1024 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1025 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1026 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1027 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1028 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1029 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1030 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1031 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1032 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1033 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1034 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1035 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1036 -(% style="color:#000000" %) "counters": 642 + "sim2": "", ~/~/ SIM2 643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 645 + "counters": 1037 1037 { 1038 1038 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1039 1039 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1040 - "mileage": "",~/~/пробег,вметрах1041 - "motohours": "" ~/~/моточасы,всекундах649 + "mileage": «», пробег 650 + "motohours": «» моточасы 1042 1042 } 1043 1043 "cmsv6Parameters": ~/~/ параметры CMSv6 1044 1044 { ... ... @@ -1062,7 +1062,6 @@ 1062 1062 "kind": "", ~/~/ Вид периодичности по времени 1063 1063 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1064 1064 } 1065 -))) 1066 1066 1067 1067 (% style="color:#000000" %)} 1068 1068 ... ... @@ -1116,18 +1116,13 @@ 1116 1116 (% lang="en-US" style="text-align:left" %) 1117 1117 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1118 1118 1119 -**валидация:** 1120 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1121 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1122 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1123 1123 1124 - 1125 1125 (% class="box errormessage" %) 1126 1126 ((( 1127 1127 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1128 1128 ))) 1129 1129 1130 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1131 1131 1132 1132 (% style="color:#000000" %)Метод запроса: **DELETE** 1133 1133 ... ... @@ -1151,7 +1151,7 @@ 1151 1151 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1152 1152 ))) 1153 1153 1154 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1155 1155 1156 1156 (% style="color:#000000" %)Метод запроса: **GET** 1157 1157 ... ... @@ -1180,7 +1180,7 @@ 1180 1180 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 1181 1181 ))) 1182 1182 1183 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1184 1184 1185 1185 (% style="color:#000000" %)Метод запроса: **GET** 1186 1186