Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- 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 infomessage" %)23 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,7 +40,6 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,6 +55,12 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 98 - "agentId": "", ~/~/идентификатор клиента(%%)99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)104 - "isForeign": true/false, ~/~/ Иностранный контрагент105 - "district": "string", ~/~/ округ106 - "region": "string", ~/~/ регион107 - "city": "string", ~/~/ город108 - "inn": "string", ~/~/ ИНН клиента109 - "kpp": "string", ~/~/ КПП клиента110 - "address": "string", ~/~/ юридический адрес111 - "addressFact": "string", ~/~/ фактический адрес112 - "email": "string", ~/~/ почта113 - "director": "string", ~/~/ ФИО руководителя114 - "bankName": "string", ~/~/ Банк115 - "bankBIK": "string", ~/~/ БИК116 - "bankRS": "string", ~/~/ Номер счета117 - "bankKS": "string" ~/~/ Корр. счет102 + "agentId": "", (%%) 103 + "parentId": "", 104 + "parentName": "string", 105 + "name": "string", 106 + "fullName": "string", 107 + "agentInfoType": 0, 108 + "isForeign": true/false, 109 + "district": "string", 110 + "region": "string", 111 + "city": "string", 112 + "inn": "string", 113 + "kpp": "string", 114 + "address": "string", 115 + "addressFact": "string", 116 + "email": "string", 117 + "director": "string", 118 + "bankName": "string", 119 + "bankBIK": "string", 120 + "bankRS": "string", 121 + "bankKS": "string" 118 118 } 119 119 124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 145 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,25 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", ~/~/ идентификатор клиента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 - Отказ)174 + "agentId": "",(% style="color:#000000" %) (%%) 175 + "parentId": "", 176 + "parentName": "string", 177 + "name": "string", 178 + "fullName": "string", 179 + "agentInfoType": 0, 180 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 183 + 184 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 185 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 186 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 188 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 189 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 190 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 191 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 192 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 211 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 257 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 258 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 259 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 260 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 261 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 262 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 263 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 264 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 265 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 266 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 267 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 268 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 269 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 270 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 271 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 272 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 273 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 274 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 275 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 276 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 277 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -363,7 +363,6 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -392,6 +392,7 @@ 392 392 (% style="text-align:left" %) 393 393 (% style="color:#000000; font-weight:normal" %)} 394 394 450 + 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 397 (% class="box infomessage" %) ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 787 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 884 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 885 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 887 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 888 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 889 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 890 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 891 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 892 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 893 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 894 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 895 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 896 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 951 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 952 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 954 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 955 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 956 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 957 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 958 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 959 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 960 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 961 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 962 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 963 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 964 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -1841,61 +1841,6 @@ 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1845 - 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 2955 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 2956 + 2957 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 2958 + 2959 +(% class="box infomessage" %) 2960 +((( 2961 +**POST /api/v3/Trailers** 2962 +))) 2963 + 2964 +Пример запроса: 2965 + 2966 +{ 2967 + "startDate": "2023-11-14T10:48:03.671Z", 2968 + "endDate": "2023-11-14T10:48:03.671Z", 2969 + "ids": [ 0 ], 2970 + "timezone": 0 2971 +} 2972 + 2973 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2974 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 2975 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 2976 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 2977 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 2978 + 2979 +Пример ответа: 2980 + 2981 +[ 2982 + { 2983 + "SD": "2023-11-14T10:48:03.717Z", 2984 + "ED": "2023-11-14T10:48:03.717Z", 2985 + "id": 0, 2986 + "SLat": 0, 2987 + "SLon": 0, 2988 + "ELat": 0, 2989 + "ELon": 0, 2990 + "mileage": 0 2991 + "Duration": 0 2992 + "Address": "string", 2993 + "Address2": "string", 2994 + "name": "string", 2995 + "rid": "string", 2996 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2997 + "trailer": { 2998 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 + "Number": "string", 3000 + "Description": "string", 3001 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3002 + "ExternalID": "string", 3003 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3004 + "CreateTime": "2023-11-14T10:48:03.717Z", 3005 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3006 + "IsDeleted": true 3007 + }, 3008 + "filesCount": 0, 3009 + } 3010 +] 3011 + 3012 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3013 +|SD|Дата и время начала события 3014 +|ED|Дата и время окончания события 3015 +|id|ID объекта 3016 +|SLat|Широта начальной координаты 3017 +|SLon|Долгота начальной координаты 3018 +|ELat|Широта конечной координаты 3019 +|ELon|Долгота конечной координаты 3020 +|mileage|Пробег 3021 +|Duration|Продолжительность 3022 +|Address|Адрес начального местоположения 3023 +|Address2|Адрес конечного местоположения 3024 +|name|Имя радиометки 3025 +|rid|Номер радиометки 3026 +|rguid|ID радиометки 3027 +|trailer|Информация об агрегате 3028 +|ModelGuid|ID агрегата 3029 +|Number|Название/номер агрегата 3030 +|Description|Текст примечания агрегата 3031 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,18 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3053 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3059 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3060 +|parentId|ID клиента 3061 +|name|Название карты-метки 3062 +|number|Номер 3063 +|period|Период запросов в секундах (работает только для агрегатов) 3064 +|id|ID карты-метки 2958 2958 2959 2959 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2960 2960 ... ... @@ -2971,13 +2971,18 @@ 2971 2971 { 2972 2972 "name": "string", 2973 2973 "number": 0, 2974 - "period": 0, ~/~/ Частота трансляции радиометки3081 + "period": 0, 2975 2975 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 2976 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2977 - "deleted": true 2978 2978 } 2979 2979 ] 2980 2980 3087 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3088 +|name|Название карты-метки 3089 +|number|Номер 3090 +|period|Период запросов в секундах (работает только для агрегатов) 3091 +|id|ID карты-метки 3092 +|parentId|ID клиента 2981 2981 2982 2982 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2983 2983 ... ... @@ -2993,7 +2993,6 @@ 2993 2993 "number": 0, 2994 2994 "period": 0, 2995 2995 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2996 - "deleted": true 2997 2997 } 2998 2998 2999 2999 Ответ: ... ... @@ -3004,9 +3004,14 @@ 3004 3004 "period": 0, 3005 3005 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 3006 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3007 - "deleted": true 3008 3008 } 3009 3009 3120 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3121 +|name|Название карты-метки 3122 +|number|Номер 3123 +|period|Период запросов в секундах (работает только для агрегатов) 3124 +|id|ID карты-метки 3125 +|parentId|ID клиента 3010 3010 3011 3011 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3012 3012 ... ... @@ -3023,7 +3023,6 @@ 3023 3023 "period": 0, 3024 3024 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3025 3025 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3026 - "deleted": true 3027 3027 } 3028 3028 3029 3029 Ответ: ... ... @@ -3034,9 +3034,14 @@ 3034 3034 "period": 0, 3035 3035 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3036 3036 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3037 - "deleted": true 3038 3038 } 3039 3039 3154 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3155 +|name|Название карты-метки 3156 +|number|Номер 3157 +|period|Период запросов в секундах (работает только для агрегатов) 3158 +|id|ID карты-метки 3159 +|parentId|ID клиента 3040 3040 3041 3041 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3042 3042 ... ... @@ -3045,7 +3045,7 @@ 3045 3045 **DELETE /api/v3/Rfids/{rfidGuid}** 3046 3046 ))) 3047 3047 3048 -Передаем параметр rfidGuid - идентификатор карты-метки 3168 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3049 3049 3050 3050 Ответ: 3051 3051 ... ... @@ -3052,6 +3052,670 @@ 3052 3052 Success 3053 3053 3054 3054 3175 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3176 + 3177 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3178 + 3179 +(% class="box infomessage" %) 3180 +((( 3181 +**GET /api/v3/Billing/client/balance/{clientId}** 3182 +))) 3183 + 3184 +Параметр запроса: **clientId **- идентификатор клиента. 3185 + 3186 +Ответ: 3187 + 3188 +{ 3189 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3190 + "Balance": 0 3191 +} 3192 + 3193 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3194 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3195 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3196 + 3197 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3198 + 3199 +(% class="box infomessage" %) 3200 +((( 3201 +**GET /api/v3/Billing/client/constraint/{clientId}** 3202 +))) 3203 + 3204 +Параметр запроса: **clientId **- идентификатор клиента. 3205 + 3206 +Ответ: 3207 + 3208 +{ 3209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3210 + "CalculationType": 0, 3211 + "PermissibleBalance": 0, 3212 + "DefermentDays": 0, 3213 + "SendUiNotifications": true, 3214 + "SendEmailNotifications": true, 3215 + "IsPrivate": true, 3216 +} 3217 + 3218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3219 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3220 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3221 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3222 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3223 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3224 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3225 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3226 + 3227 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3228 + 3229 +(% class="box infomessage" %) 3230 +((( 3231 +**GET /api/v3/Billing/client/plan/{clientId}** 3232 +))) 3233 + 3234 +Параметры запроса: 3235 + 3236 +**clientId **- идентификатор клиента. 3237 + 3238 +**planId **- идентификатор тарифного плана. 3239 + 3240 +Ответ: 3241 + 3242 +{ 3243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3244 + "Plan": { **~/~/ Описание тарифного плана** 3245 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3246 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3247 + "Name": "string", 3248 + "IsArchived": true, 3249 + "Constraint": { 3250 + "CalculationType": 0, 3251 + "PermissibleBalance": 0, 3252 + "DefermentDays": 0 3253 + }, 3254 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3255 + { 3256 + "Feature": "string", 3257 + "IsFactual": true, 3258 + "Limit": 0, 3259 + "Price": 0, 3260 + "PeriodValue": 0, 3261 + "PeriodType": 0 3262 + } 3263 + ] 3264 + }, 3265 + "DebitDate": "2023-10-18T12:46:24.213Z", 3266 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3267 + { 3268 + "Feature": "string", 3269 + "IsEnabled": true, 3270 + "IsPrivate": true, 3271 + "IsFactual": true, 3272 + "Limit": 0, 3273 + "Price": 0, 3274 + "DebitDate": "2023-10-18T12:46:24.213Z", 3275 + "PeriodValue": 0, 3276 + "PeriodType": 0 3277 + } 3278 + ] 3279 +} 3280 + 3281 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3282 +|ClientId|Идентификатор клиента 3283 +|Id|Идентификатор тарифного плана 3284 +|OwnerId|Идентификатор клиента-владельца 3285 +|Name|Наименование тарифного плана 3286 +|IsArchived|Признак, определяющий архивный тарифный план 3287 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3288 +|PermissibleBalance|Допустимый баланс 3289 +|DefermentDays|Отсрочка, количество дней 3290 +|Feature|Код услуги 3291 +|IsEnabled|Признак, определяющий активирована ли услуга 3292 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3293 +|IsFactual|Признак, определяющий расчёт по факту 3294 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3295 +|Price|Цена за единицу. 3296 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3297 +|PeriodValue|Значение периода. 3298 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3299 + 3300 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3301 + 3302 +(% class="box infomessage" %) 3303 +((( 3304 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3305 +))) 3306 + 3307 +Параметр запроса: **clientId **- идентификатор клиента. 3308 + 3309 +Ответ: 3310 + 3311 +[ 3312 + { 3313 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3314 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3315 + "Name": "string", 3316 + "IsArchived": true, 3317 + "Constraint": { 3318 + "CalculationType": 0, 3319 + "PermissibleBalance": 0, 3320 + "DefermentDays": 0 3321 + }, 3322 + "Features": [ 3323 + { 3324 + "Feature": "string", 3325 + "IsFactual": true, 3326 + "Limit": 0, 3327 + "Price": 0, 3328 + "PeriodValue": 0, 3329 + "PeriodType": 0 3330 + } 3331 + ] 3332 + } 3333 +] 3334 + 3335 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3336 +|ClientId|Идентификатор клиента 3337 +|Id|Идентификатор тарифного плана 3338 +|OwnerId|Идентификатор клиента-владельца 3339 +|Name|Наименование тарифного плана 3340 +|IsArchived|Признак, определяющий архивный тарифный план 3341 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3342 +|PermissibleBalance|Допустимый баланс 3343 +|DefermentDays|Отсрочка, количество дней 3344 +|Feature|Код услуги 3345 +|IsFactual|Признак, определяющий расчёт по факту 3346 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3347 +|Price|Цена за единицу. 3348 +|PeriodValue|Значение периода. 3349 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3350 + 3351 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3352 + 3353 +(% class="box infomessage" %) 3354 +((( 3355 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3356 +))) 3357 + 3358 +Параметр запроса: **clientId **- идентификатор клиента. 3359 + 3360 +Ответ: 3361 + 3362 +[ 3363 + { 3364 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3365 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3366 + "Name": "string", 3367 + "IsArchived": true, 3368 + "Constraint": { 3369 + "CalculationType": 0, 3370 + "PermissibleBalance": 0, 3371 + "DefermentDays": 0 3372 + }, 3373 + "Features": [ 3374 + { 3375 + "Feature": "string", 3376 + "IsFactual": true, 3377 + "Limit": 0, 3378 + "Price": 0, 3379 + "PeriodValue": 0, 3380 + "PeriodType": 0 3381 + } 3382 + ] 3383 + } 3384 +] 3385 + 3386 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3387 +|ClientId|Идентификатор клиента 3388 +|Id|Идентификатор тарифного плана 3389 +|OwnerId|Идентификатор клиента-владельца 3390 +|Name|Наименование тарифного плана 3391 +|IsArchived|Признак, определяющий архивный тарифный план 3392 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3393 +|PermissibleBalance|Допустимый баланс 3394 +|DefermentDays|Отсрочка, количество дней 3395 +|Feature|Код услуги 3396 +|IsFactual|Признак, определяющий расчёт по факту 3397 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3398 +|Price|Цена за единицу. 3399 +|PeriodValue|Значение периода. 3400 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3401 + 3402 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3403 + 3404 +(% class="box warningmessage" %) 3405 +((( 3406 +**PUT /api/v3/Billing/client/balance** 3407 +))) 3408 + 3409 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3410 + 3411 +Тело запроса: 3412 + 3413 +{ 3414 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3415 + "Balance": 0 3416 +} 3417 + 3418 +Ответ: Success 3419 + 3420 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3421 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3422 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3423 + 3424 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3425 + 3426 +(% class="box warningmessage" %) 3427 +((( 3428 +**PUT /api/v3/billing/client/balance/deposit** 3429 +))) 3430 + 3431 +Создает операцию **Пополнение **с указанной суммой 3432 + 3433 +Тело запроса: 3434 + 3435 +{ 3436 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3437 + "Balance": 0 3438 +} 3439 + 3440 +Ответ: Success 3441 + 3442 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3443 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3444 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3445 + 3446 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3447 + 3448 +Создает операцию **Списание **с указанной суммой 3449 + 3450 +(% class="box warningmessage" %) 3451 +((( 3452 +**PUT /api/v3/billing/client/balance/withdraw** 3453 +))) 3454 + 3455 +Тело запроса: 3456 + 3457 +{ 3458 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3459 + "Balance": 0 3460 +} 3461 + 3462 +Ответ: Success 3463 + 3464 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3465 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3466 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3467 + 3468 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3469 + 3470 +(% class="box warningmessage" %) 3471 +((( 3472 +**PUT /api/v3/Billing/client/constraint** 3473 +))) 3474 + 3475 +Тело запроса: 3476 + 3477 +{ 3478 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3479 + "CalculationType": 0, 3480 + "PermissibleBalance": 0, 3481 + "DefermentDays": 0, 3482 + "SendUiNotifications": true, 3483 + "SendEmailNotifications": true, 3484 + "IsPrivate": true, 3485 +} 3486 + 3487 +Ответ: Success 3488 + 3489 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3490 +|ClientId|Идентификатор клиента 3491 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3492 +|PermissibleBalance|Допустимый баланс 3493 +|DefermentDays|((( 3494 +Отсрочка, количество дней 3495 +))) 3496 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3497 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3498 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3499 + 3500 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3501 + 3502 +(% class="box warningmessage" %) 3503 +((( 3504 +**PUT /api/v3/Billing/client/plan** 3505 +))) 3506 + 3507 +Тело запроса: 3508 + 3509 +{ 3510 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3511 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3512 + "Features": [ 3513 + { 3514 + "Feature": "string", 3515 + "IsEnabled": true, 3516 + "IsFactual": true, 3517 + "Limit": 0, 3518 + "Price": 0, 3519 + "DebitDate": "2023-10-18T13:26:58.987Z", 3520 + "PeriodValue": 0, 3521 + "PeriodType": 0 3522 + } 3523 + ] 3524 +} 3525 + 3526 +Ответ: Success 3527 + 3528 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3529 +|ClientId|Идентификатор клиента 3530 +|PlanId|Идентификатор тарифного плана 3531 +|Feature|Код услуги 3532 +|IsEnabled|Признак, определяющий активирована ли услуга 3533 +|IsFactual|Признак, определяющий расчёт по факту 3534 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3535 +|Price|Цена за единицу. 3536 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3537 +|PeriodValue|Значение периода. 3538 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3539 + 3540 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3541 + 3542 +(% class="box warningmessage" %) 3543 +((( 3544 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3545 +))) 3546 + 3547 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3548 + 3549 +(% class="box infomessage" %) 3550 +((( 3551 +**POST /api/v3/vehicles/import/{agentId}** 3552 +))) 3553 + 3554 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3555 + 3556 +В пути указывается **agentId** - id клиента. 3557 + 3558 +**Заголовок** 3559 + 3560 +**X-Auth: [токен авторизации]** 3561 + 3562 +**Параметры** 3563 + 3564 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3565 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3566 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3567 + 3568 +В теле использовать тип **form-data,** тип значения** file** 3569 + 3570 +**Ключи** 3571 + 3572 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3573 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3574 +|csv|В значении передаем файл датчиков, формат **csv** 3575 + 3576 +Ответ: 3577 + 3578 +{ 3579 + "vehicleId": 0, 3580 + "name": "string", 3581 + "errors": ["string"] 3582 +} 3583 + 3584 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3585 +|vehicleId|ID созданного объекта 3586 +|name|Имя созданного объекта 3587 +|errors|Ошибки и их описание 3588 + 3589 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3590 + 3591 +(% class="box infomessage" %) 3592 +((( 3593 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3594 +))) 3595 + 3596 +(% class="wikigeneratedid" %) 3597 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3598 + 3599 +(% class="wikigeneratedid" %) 3600 +В пути указывается **vehicleId **- id объекта. 3601 + 3602 +**Заголовок** 3603 + 3604 +**X-Auth: [токен авторизации]** 3605 + 3606 +В теле использовать тип **form-data.** 3607 + 3608 +Ключи: 3609 + 3610 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3611 +|**history**|В значении передавать файл с историей 3612 + 3613 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3614 + 3615 +Ответ: 3616 + 3617 +{ 3618 + "results": [ 3619 + { 3620 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3621 + "vehicleId": 0, 3622 + "errors": [ 3623 + "string" 3624 + ], 3625 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3626 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3627 + "producedCount": 0, 3628 + "msgCount": 0 3629 + } 3630 + ] 3631 +} 3632 + 3633 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3634 +|results|Результаты импорта в разрезе ТС 3635 +|vehicleGuid|Guid ТС 3636 +|vehicleId|ID ТС 3637 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3638 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3639 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3640 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3641 +|msgCount|Кол-во обработанных сообщений всего 3642 + 3643 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3644 + 3645 +(% class="box infomessage" %) 3646 +((( 3647 +**GET /api/v3/vehicles/import/history/status** 3648 +))) 3649 + 3650 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3651 + 3652 +Ответ: 3653 + 3654 +{ 3655 + "activity": true, 3656 + "progress": 0, 3657 + "message": "string" 3658 +} 3659 + 3660 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3661 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3662 +|progress|Guid ТС 3663 + 3664 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3665 + 3666 +(% class="box infomessage" %) 3667 +((( 3668 +**POST /api/v3/vehicles/export** 3669 +))) 3670 + 3671 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3672 + 3673 +Тело запроса: 3674 + 3675 +[ 3676 + id 3677 +] 3678 + 3679 +Ответ: Success 200, получаете файлы с настройками. 3680 + 3681 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3682 + 3683 +(% class="box infomessage" %) 3684 +((( 3685 +**POST /api/v3/vehicles/export/history** 3686 +))) 3687 + 3688 +Метод возвращает список сообщений терминала объекта за выбранный период. 3689 + 3690 +Тело запроса: 3691 + 3692 +{ 3693 + "vehicleId": 0, 3694 + "asArchive": true, 3695 + "from": "2023-09-27T12:17:45.973Z", 3696 + "to": "2023-09-27T12:17:45.973Z" 3697 +} 3698 + 3699 +Ответ: 3700 + 3701 +Получаете файл. Сообщение: Code 200/Success 3702 + 3703 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3704 +|vehicleId|ID объекта 3705 +|asArchive|true - Архивировать файл, False - не архивировать 3706 +|from|Дата и время начала запроса 3707 +|to|Дата и время окончания запроса 3708 + 3709 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3710 + 3711 +(% class="box infomessage" %) 3712 +((( 3713 +**GET /api/v3/vehicles/export/history/status** 3714 +))) 3715 + 3716 +Метод возвращает список сообщений терминала объекта за выбранный период. 3717 + 3718 +Ответ: 3719 + 3720 +{ 3721 + "activity": true, 3722 + "progress": 0, 3723 + "message": "string" 3724 +} 3725 + 3726 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3727 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3728 +|progress|Прогресс экспорта, от 0 до 100% 3729 +|message|Текст описывающий статус 3730 + 3731 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3732 + 3733 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) == 3734 + 3735 +(% class="box infomessage" %) 3736 +((( 3737 +**POST /api/v3/EcoDriving/rating** 3738 +))) 3739 + 3740 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3741 + 3742 +Тело запроса: 3743 + 3744 +{ 3745 + "vehicleIds": [vehicleId], 3746 + "from": "2023-11-22T09:29:48.051Z", 3747 + "to": "2023-11-22T09:29:48.051Z" 3748 +} 3749 + 3750 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3751 +|vehicleIds|Массив ID объектов 3752 +|from|Дата начала запроса 3753 +|to|Дата окончания запроса 3754 + 3755 +Ответ: 3756 + 3757 +{ 3758 + "items": [ 3759 + { 3760 + "from": "2023-11-22T09:29:48.052Z", 3761 + "to": "2023-11-22T09:29:48.052Z", 3762 + "vehicleId": 0, 3763 + "vehicleName": "string", 3764 + "vehicleModel": "string", 3765 + "penalty": 0, 3766 + "score": 0, 3767 + "totalViolations": 0, 3768 + "violationsByType": { 3769 + "overspeedingViolations": 0, 3770 + "accelerationViolations": 0, 3771 + "brakingViolations": 0, 3772 + "turningViolations": 0, 3773 + "dangerousDrivingViolations": 0, 3774 + "sensorViolations": 0 3775 + }, 3776 + "moveTime": 0, 3777 + "mileage": 0, 3778 + "tripsCount": 0, 3779 + "trips": [ 3780 + { 3781 + "penalty": 0, 3782 + "score": 0, 3783 + "violationsCount": 0, 3784 + "violationsByType": { 3785 + "overspeedingViolations": 0, 3786 + "accelerationViolations": 0, 3787 + "brakingViolations": 0, 3788 + "turningViolations": 0, 3789 + "dangerousDrivingViolations": 0, 3790 + "sensorViolations": 0 3791 + }, 3792 + "moveTime": 0, 3793 + "mileage": 0, 3794 + "motohours": 0, 3795 + "maxSpeed": 0, 3796 + "startAddress": "string", 3797 + "endAddress": "string", 3798 + "drivers": [ 3799 + { 3800 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3801 + "driverName": "string", 3802 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3803 + } 3804 + ] 3805 + } 3806 + ] 3807 + } 3808 + ] 3809 +} 3810 + 3811 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3812 +|from|Дата начала запроса 3813 +|to|Дата окончания 3814 +|vehicleId|ID объекта 3815 +|vehicleName|Имя объекта 3816 +|vehicleModel|Модель объекта 3817 +|penalty|Сумма штрафных баллов 3818 +|score|Оценка 3819 +|totalViolations|Суммарное количество нарушений 3820 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3821 +|overspeedingViolations|Превышение скорости 3822 +|accelerationViolations|Ускорение 3823 +|brakingViolations|Торможение 3824 +|turningViolations|Резкий поворот 3825 +|dangerousDrivingViolations|Резкое вождение 3826 +|sensorViolations|Нарушение по датчику 3827 +|moveTime|Время в движении 3828 +|mileage|Пробег 3829 +|tripsCount|Количество рейсов 3830 +|motohours|Моточасы 3831 +|maxSpeed|Максимальная скорость 3832 +|startAddress|Адрес начала рейса 3833 +|endAddress|Адрес окончания рейса 3834 +|drivers|Список водителей, которые были на объекте в течениии рейса 3835 +|driverGuid|Guid водителя 3836 +|driverName|Имя водителя 3837 +|driverRfid|Номер Карты-метки 3838 + 3055 3055 (% class="box" lang="en-US" style="text-align: center;" %) 3056 3056 ((( 3057 3057 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB -
Content