Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/03/12 10:28
<
>
отредактировано Артем Шемяков
на 2022/09/02 10:00
на 2022/09/02 10:00
отредактировано Артем Шемяков
на 2022/09/02 09:45
на 2022/09/02 09:45
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -44,7 +44,7 @@ 44 44 "User": "" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 -} 47 + } 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 ... ... @@ -101,7 +101,7 @@ 101 101 "fullName": "", ~/~/ полное наименование клиента 102 102 "agentInfoType": "", ~/~/ тип клиента1 103 103 "status": "", ~/~/ статус клиента 104 -} 104 + } 105 105 106 106 107 107 (% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] ... ... @@ -145,7 +145,7 @@ 145 145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 147 "groups": "" , ~/~/ группы пользователя, названия групп 148 -} 148 + } 149 149 150 150 (% style="text-align:left" %) 151 151 (% style="color:#000000; font-weight:normal" %)Ответ: ... ... @@ -173,7 +173,7 @@ 173 173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 174 174 175 175 (% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %)} 176 +(% style="color:#000000; font-weight:normal" %) } 177 177 178 178 179 179 (% class="box successmessage" %) ... ... @@ -198,7 +198,7 @@ 198 198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 200 200 201 -(% style="color:#000000" %)} 201 +(% style="color:#000000" %) } 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 ... ... @@ -218,7 +218,7 @@ 218 218 "status": "1", ~/~/ статус пользователя 219 219 "astLogged": "", ~/~/ дата/время последней авторизации 220 220 221 -(% style="color:#000000" %)} 221 +(% style="color:#000000" %) } 222 222 223 223 224 224 (% class="box warningmessage" %) ... ... @@ -261,16 +261,16 @@ 261 261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 262 262 263 263 (% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 265 265 266 266 (% lang="en-US" style="text-align:left" %) 267 267 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 268 268 269 269 (% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 271 271 272 272 (% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 274 274 "lastName": "" , ~/~/ фамилия 275 275 "firstName": "" , ~/~/ имя 276 276 "position": "" , ~/~/ должность ... ... @@ -286,10 +286,10 @@ 286 286 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 287 "kind": "" , ~/~/ тип аутентификации 288 288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 290 290 291 291 (% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 293 293 294 294 295 295 (% class="box warningmessage" %) ... ... @@ -315,7 +315,7 @@ 315 315 "description": "" , ~/~/ описание 316 316 "data": "" , ~/~/ данные, связанные со сменой статуса 317 317 318 -(% style="color:#000000" %)} 318 + (% style="color:#000000" %)} 319 319 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** ... ... @@ -383,7 +383,7 @@ 383 383 "unitName": "" , ~/~/ наименование подразделения 384 384 "status": "" , ~/~/ статус объекта 385 385 386 -} 386 + } 387 387 388 388 (% style="text-align:left" %) 389 389 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -425,7 +425,7 @@ 425 425 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 426 426 "motohours": "" , ~/~/ моточасы 427 427 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 428 - 428 + }, 429 429 "cmsv6Parameters": { ~/~/ параметры CMSv6 430 430 "enabled": true, ~/~/ флаг включения 431 431 "id": "" , ~/~/ идентификатор ... ... @@ -432,7 +432,7 @@ 432 432 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 433 "login": "" , ~/~/ имя учетной записи 434 434 "password": "" ~/~/ пароль учетной записи 435 - 435 + }, 436 436 "inspectionTasks": ~/~/ задания на ТО 437 437 { 438 438 "enabled": "" , ~/~/ Признак включения ... ... @@ -470,7 +470,7 @@ 470 470 "motohoursEnabled": true, 471 471 "mileage": "", 472 472 "motohours": 345.0 473 - 473 + }, 474 474 "cmsv6Parameters": { ~/~/Параметры CmsV6 475 475 "id": null, 476 476 "enabled": true, ~/~/флаг включения ... ... @@ -477,7 +477,7 @@ 477 477 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 478 478 "login": "", ~/~/ имя учетной записи 479 479 "password": "" ~/~/ пароль учетной записи 480 - 480 + }, 481 481 "inspectionTasks": { ~/~/ задания на ТО 482 482 "id": "", ~/~/ ID задачи 483 483 "enabled": false, ~/~/ Признак включения ... ... @@ -490,7 +490,7 @@ 490 490 "periodicCondition": "", ~/~/ Условие периодичности по времени 491 491 "kind": "", ~/~/ Вид периодичности по времени 492 492 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 493 - } 493 + } 494 494 495 495 (% style="text-align:left" %) 496 496 (% style="color:#000000" %)} ... ... @@ -594,7 +594,7 @@ 594 594 "overwrite": false, ~/~/ Флаг перезаписи 595 595 "stage": "", ~/~/ Состояние, может быть null 596 596 597 -(% style="color:#000000" %)} 597 + (% style="color:#000000" %)} 598 598 599 599 (% style="color:#000000" %)Ответ: 600 600 ... ... @@ -608,7 +608,7 @@ 608 608 "stage": "", ~/~/ Состояние 609 609 610 610 (% style="text-align:left" %) 611 -(% style="color:#000000" %) 611 +(% style="color:#000000" %)} 612 612 613 613 614 614 (% class="box warningmessage" %) ... ... @@ -626,7 +626,7 @@ 626 626 627 627 (% style="color:#000000" %)Параметры в теле запроса (JSON): 628 628 629 -(% style="color:#000000" %){ 629 +(% style="color:#000000" %) { 630 630 631 631 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 632 632 "parentId": "", ~/~/ ID клиента ... ... @@ -667,7 +667,7 @@ 667 667 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 668 668 "kind": "", ~/~/ Вид периодичности по времени 669 669 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 670 - 670 + } 671 671 672 672 (% style="color:#000000" %)} 673 673 ... ... @@ -674,54 +674,9 @@ 674 674 (% style="color:#000000" %)Ответ: 675 675 676 676 (% lang="en-US" style="text-align:left" %) 677 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 677 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 678 678 679 -(% lang="en-US" style="text-align:left" %) 680 - "vehicleId": "", ~/~/ ID ТС 681 - "parentId": "", ~/~/ ID клиента 682 - "name": "", ~/~/ имя ТС 683 - "imei": "", ~/~/ IMEI 684 - "deviceTypeId": "", ~/~/ типа устройства 685 - "modelId": "", ~/~/ ID модели 686 - "unitId": "", ~/~/ ID подразделения 687 - "sim1": "", ~/~/ SIM 1 688 - "sim2": "", ~/~/ SIM2 689 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 690 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 691 - "counters": 692 - { 693 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 694 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 695 - "mileage": "", ~/~/ пробег 696 - "motohours": "", ~/~/ моточасы 697 - } 698 - "cmsv6Parameters": ~/~/ параметры CMSv6 699 - { 700 - "id": ~/~/ идентификатор 701 - "enabled": true, ~/~/ флаг включения 702 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 703 - "login": "", ~/~/ имя учетной записи 704 - "password": "", ~/~/ пароль учетной записи 705 - } 706 - "inspectionTasks": ~/~/ задания на ТО 707 - { 708 - "id": "", ~/~/ ID задания 709 - "enabled": false, ~/~/ Признак включения 710 - "name": "", ~/~/ Имя задания 711 - "description": "", ~/~/ Описание задания 712 - "mileageCondition": "", ~/~/ Условие по пробегу 713 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 714 - "motohoursCondition": "", ~/~/ Условие по моточасам 715 - "lastMotohours": "", ~/~/ Моточасы 716 - "periodicCondition": "", ~/~/ Условие периодичности по времени 717 - "kind": "", ~/~/ Вид периодичности по времени 718 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 719 - } 720 720 721 -(% lang="en-US" style="text-align:left" %) 722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 723 - 724 - 725 725 (% class="box errormessage" %) 726 726 ((( 727 727 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -759,15 +759,16 @@ 759 759 760 760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 761 761 762 -(% style="color:#000000" %)Ответ: 717 +(% style="color:#000000" %)Ответ: [ 763 763 764 -(% style="color:#000000" %){ 719 +(% class="western" %) 720 +{{{ { 721 + "deviceTypeId" : "", // ID типа устройства 722 + "deviceTypeName" : "" // Название типа устройства 723 + },}}} 765 765 766 - "deviceTypeId" : "", ~/~/ ID типа устройства 767 - "deviceTypeName" : "" ~/~/ Название типа устройства 768 - 769 769 (% style="text-align:left" %) 770 -(% style="color:#000000" %) }726 +(% style="color:#000000" %)…** **] 771 771 772 772 773 773 (% class="box" style="text-align: center;" %) ... ... @@ -788,16 +788,19 @@ 788 788 789 789 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 790 790 791 -(% style="color:#000000" %)Ответ: 747 +(% style="color:#000000" %)Ответ: [ 792 792 793 -(% style="color:#000000" %){ 749 +(% class="western" style="margin-bottom:19px" %) 750 +{{{ {}}} 794 794 795 - "id": "", ~/~/ ID типа датчика 796 - "name": "", ~/~/ Название 797 - "description": "", ~/~/ Описание 752 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 798 798 754 +(% class="western" %) 755 +{{{ "description": "" // Описание 756 + },}}} 757 + 799 799 (% style="text-align:left" %) 800 -(% style="color:#000000" %) }759 +(% style="color:#000000" %)… ] 801 801 802 802 803 803 (% class="box" lang="en-US" style="text-align: center;" %)