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
-
... ... @@ -1,43 +1,39 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 == Описание ГЛОНАССSoft Public API 3.0 == 3 3 4 +== == 4 4 5 -{{toc/}} 6 +(% class="box" style="text-align: center;" %) 7 +((( 8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 9 +))) 6 6 7 - 8 -=== (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**(%%) === 9 - 10 10 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 12 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__(токен авторизации, получаемый методом__**auth/login**__).13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**). 13 13 14 14 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 15 15 16 16 17 -==== (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**(%%) ==== 18 +(% class="box" style="text-align: center;" %) 19 +((( 20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 +))) 18 18 19 - 20 -(% class="box successmessage" %) 23 +(% class="box infomessage" %) 21 21 ((( 22 - (% 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** 23 23 ))) 24 24 25 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 26 26 27 -(% style="color:#000000" %)Метод запроса: ** POST**30 +(% style="color:#000000" %)Метод запроса: **GET** 28 28 29 -(% 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]] 30 30 31 31 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 32 32 33 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 34 - 35 -(% style="color:#000000" %){ 36 - "login": "testuser", 37 - "password": "testuser" 38 -}(%%) 39 - 40 - 36 +(% lang="en-US" %) 41 41 (% style="color:#000000" %)**Ответ:** 42 42 43 43 (% lang="en-US" %) ... ... @@ -44,8 +44,8 @@ 44 44 (% style="color:#000000" %){ 45 45 46 46 (% lang="en-US" %) 47 -(% style="color:#000000" %) "AuthId": " (%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000"%)", ~/~/ токен авторизации48 - "User": " testuser" , ~/~/ имя пользователя43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 + "User": "" , ~/~/ имя пользователя 49 49 50 50 (% lang="en-US" %) 51 51 } ... ... @@ -58,7 +58,7 @@ 58 58 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 59 59 ))) 60 60 61 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 62 62 63 63 (% style="color:#000000" %)Метод запроса: **GET** 64 64 ... ... @@ -80,7 +80,7 @@ 80 80 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 81 81 ))) 82 82 83 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 84 84 85 85 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 86 86 ... ... @@ -104,152 +104,10 @@ 104 104 "name": "", ~/~/ наименование клиента 105 105 "fullName": "", ~/~/ полное наименование клиента 106 106 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 107 - "status": "", ~/~/ статус клиента (0-Новый,1-Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)103 + "status": "", ~/~/ статус клиента 108 108 } 109 109 110 110 111 -(% class="box successmessage" %) 112 -((( 113 -**Добавление клиента — POST /api/v3/agents ** 114 -))) 115 - 116 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 117 - 118 -Метод запроса: **POST** 119 - 120 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 121 - 122 -В заголовках запроса: X-Auth: Токен авторизации 123 - 124 -Параметры в теле запроса (JSON): 125 - 126 -{ 127 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 128 - "name": "string", ~/~/ имя 129 - "fullName": "string", ~/~/ полное наименование 130 - "isForeign": true, ~/~/ иностранный контрагент 131 - "district": "string", ~/~/ округ 132 - "region": "string", ~/~/ регион 133 - "city": "string", ~/~/ город 134 - "inn": "string", ~/~/ ИНН 135 - "kpp": "string", ~/~/ КПП 136 - "address": "string", ~/~/ юридический адрес 137 - "addressFact": "string", ~/~/ фактический адрес 138 - "email": "string", ~/~/ email 139 - "director": "string", ~/~/ ФИО руководителя 140 - "bankName": "string", ~/~/ банк 141 - "bankBIK": "string", ~/~/ БИК 142 - "bankRS": "string", ~/~/ номер счёта 143 - "bankKS": "string" ~/~/ корр. счёт 144 -} 145 - 146 - 147 -Ответ: 148 - 149 -{ 150 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 151 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 152 - "name": "string", ~/~/ имя 153 - "fullName": "string", ~/~/ полное наименование 154 - "isForeign": true, ~/~/ иностранный контрагент 155 - "district": "string", ~/~/ округ 156 - "region": "string", ~/~/ регион 157 - "city": "string", ~/~/ город 158 - "inn": "string", ~/~/ ИНН 159 - "kpp": "string", ~/~/ КПП 160 - "address": "string", ~/~/ юридический адрес 161 - "addressFact": "string", ~/~/ фактический адрес 162 - "email": "string", ~/~/ email 163 - "director": "string", ~/~/ ФИО руководителя 164 - "bankName": "string", ~/~/ банк 165 - "bankBIK": "string", ~/~/ БИК 166 - "bankRS": "string", ~/~/ номер счёта 167 - "bankKS": "string" ~/~/ корр. счёт 168 -} 169 - 170 - 171 -(% class="box warningmessage" %) 172 -((( 173 -**Редактирование клиента — PUT /api/v3/agents** 174 -))) 175 - 176 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 177 - 178 -Метод запроса: **PUT** 179 - 180 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 181 - 182 -В заголовках запроса: X-Auth: Токен авторизации 183 - 184 - 185 -Параметры в теле запроса (JSON): 186 - 187 -{ 188 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 189 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 190 - "name": "string", ~/~/ имя 191 - "fullName": "string", ~/~/ полное наименование 192 - "isForeign": true, ~/~/ иностранный контрагент 193 - "district": "string", ~/~/ округ 194 - "region": "string", ~/~/ регион 195 - "city": "string", ~/~/ город 196 - "inn": "string", ~/~/ ИНН 197 - "kpp": "string", ~/~/ КПП 198 - "address": "string", ~/~/ юридический адрес 199 - "addressFact": "string", ~/~/ фактический адрес 200 - "email": "string", ~/~/ email 201 - "director": "string", ~/~/ ФИО руководителя 202 - "bankName": "string", ~/~/ банк 203 - "bankBIK": "string", ~/~/ БИК 204 - "bankRS": "string", ~/~/ номер счёта 205 - "bankKS": "string" ~/~/ корр. счёт 206 -} 207 - 208 - 209 -Ответ: 210 - 211 -{ 212 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 213 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 214 - "name": "string", ~/~/ имя 215 - "fullName": "string", ~/~/ полное наименование 216 - "isForeign": true, ~/~/ иностранный контрагент 217 - "district": "string", ~/~/ округ 218 - "region": "string", ~/~/ регион 219 - "city": "string", ~/~/ город 220 - "inn": "string", ~/~/ ИНН 221 - "kpp": "string", ~/~/ КПП 222 - "address": "string", ~/~/ юридический адрес 223 - "addressFact": "string", ~/~/ фактический адрес 224 - "email": "string", ~/~/ email 225 - "director": "string", ~/~/ ФИО руководителя 226 - "bankName": "string", ~/~/ банк 227 - "bankBIK": "string", ~/~/ БИК 228 - "bankRS": "string", ~/~/ номер счёта 229 - "bankKS": "string" ~/~/ корр. счёт 230 -} 231 - 232 - 233 -(% class="box errormessage" %) 234 -((( 235 -**Удаление клиента — DELETE /api/v3/agents/{clientId}** 236 -))) 237 - 238 - 239 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 240 - 241 -Метод запроса: **DELETE** 242 - 243 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 244 - 245 -Параметр запроса: **{clientId}** - Guid пользователя 246 - 247 -В заголовках запроса: X-Auth: Токен авторизации 248 - 249 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 250 - 251 - 252 - 253 253 (% class="box" style="text-align: center;" %) 254 254 ((( 255 255 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -260,7 +260,7 @@ 260 260 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 261 261 ))) 262 262 263 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 264 264 265 265 (% style="color:#000000" %)Метод запроса: **POST** 266 266 ... ... @@ -276,9 +276,9 @@ 276 276 "position": "", ~/~/ должность 277 277 "phone": "", ~/~/ телефон 278 278 "organization": "", ~/~/ организация 279 - "login": "", ~/~/ логин (обязателен)280 - "password": "", ~/~/ пароль (обязателен) 281 - "email": "", ~/~/ email (обязателен)133 + "login": "", ~/~/ логин 134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 135 + "email": "", ~/~/ email 282 282 "description": "", ~/~/ описание 283 283 "isEnabled": "", ~/~/ признак включения 284 284 "parentId": "", ~/~/ Guid родительского агента ... ... @@ -287,7 +287,7 @@ 287 287 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 288 288 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 289 289 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 290 - "groups": ["",""], ~/~/ группы пользователя,перечисление названия групп(data-row)144 + "groups": "" , ~/~/ группы пользователя, названия групп 291 291 } 292 292 293 293 (% style="text-align:left" %) ... ... @@ -313,7 +313,7 @@ 313 313 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 314 314 "kind": "" , ~/~/ тип аутентификации 315 315 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 316 - "groups": (% style="color:#000000"%)["",""](% style="color:#000000; font-weight:normal" %),~/~/ ролипользователя,перечислены названия групп170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 317 317 318 318 (% style="text-align:left" %) 319 319 (% style="color:#000000; font-weight:normal" %)} ... ... @@ -326,7 +326,7 @@ 326 326 327 327 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 328 328 329 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **« __Просмотр пользователей__»**.183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 330 330 331 331 (% style="color:#000000" %)Метод запроса: **POST** 332 332 ... ... @@ -366,60 +366,12 @@ 366 366 (% style="color:#000000" %)} 367 367 368 368 369 -(% class="box successmessage" %) 370 -((( 371 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}** 372 -))) 373 - 374 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 375 - 376 -(% style="color:#000000" %)Метод запроса: **GET** 377 - 378 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 379 - 380 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 381 - 382 -(% style="color:#000000" %)Ответ: 383 - 384 -((( 385 -((( 386 -{ 387 - "id": "", ~/~/ GUID пользователя 388 - "lastName": "", ~/~/ Фамилия 389 - "firstName": "", ~/~/ Имя 390 - "position": "", ~/~/ Должность 391 - "phone": "", ~/~/ Номер телефона 392 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 393 - "parentName": "", Наименование клиента, которому принадлежит пользователь 394 - "organization": "", ~/~/ Организация 395 - "login": "", ~/~/ Логин пользователя 396 - "email": "", ~/~/ Адрес электронной почты 397 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 398 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 399 - "description": "", ~/~/ Описание 400 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 401 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 402 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 403 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 404 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 405 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 406 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 407 - "groups": [], ~/~/ Список ролей пользователя 408 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 409 - "authDevices": [ ], ~/~/ Список авторизованных устройств 410 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 411 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 412 -} 413 -))) 414 -))) 415 - 416 - 417 417 (% class="box warningmessage" %) 418 418 ((( 419 419 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 420 420 ))) 421 421 422 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 423 423 424 424 (% style="color:#000000" %)Метод запроса: **PUT** 425 425 ... ... @@ -427,8 +427,6 @@ 427 427 428 428 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 429 429 430 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 431 - 432 432 (% lang="en-US" style="text-align:left" %) 433 433 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 434 434 ... ... @@ -442,10 +442,10 @@ 442 442 "position": "" , ~/~/ должность 443 443 "phone": "" , ~/~/ телефон 444 444 "organization": "" , ~/~/ организация 445 - "login": "" , ~/~/ логин (%style="color:#000000"%)(Если null - менять не надо)(%%)446 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"password": "" , ~/~/ пароль (Если null - менять447 - "email": "" , ~/~/ email (%style="color:#000000"%)(Если null - менять не надо)(%%)448 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"description": "" , ~/~/ описание249 + "login": "" , ~/~/ логин 250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 251 + "email": "" , ~/~/ email 252 + "description": "" , ~/~/ описание 449 449 "isEnabled": "" , ~/~/ признак включения 450 450 "parentId": "" , ~/~/ Guid родительского агента 451 451 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) ... ... @@ -492,7 +492,7 @@ 492 492 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 493 493 ))) 494 494 495 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 496 496 497 497 (% style="color:#000000" %)Метод запроса: **PUT** 498 498 ... ... @@ -516,69 +516,12 @@ 516 516 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 517 517 518 518 519 -(% class="box warningmessage" %) 520 -((( 521 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable** 522 -))) 523 - 524 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 525 - 526 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 527 - 528 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 529 - 530 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 531 - 532 - [ 533 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 534 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 535 - ] 536 - 537 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 538 - 539 - 540 -(% class="box warningmessage" %) 541 -((( 542 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable** 543 -))) 544 - 545 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 546 - 547 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 548 - 549 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 550 - 551 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 552 - 553 - [ 554 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 555 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 556 - ] 557 - 558 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 559 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 560 - 561 -((( 562 -В теле ответа: 563 -{ 564 - "errorMessages": [ 565 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 566 - ], 567 - "users": [ 568 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 569 - ] 570 -} 571 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 572 -"users" - массив id пользователей, которых не удалось включить или отключить. 573 - 574 -))) 575 - 576 576 (% class="box errormessage" %) 577 577 ((( 578 578 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 579 579 ))) 580 580 581 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 582 582 583 583 (% style="color:#000000" %)Метод запроса: **DELETE** 584 584 ... ... @@ -604,7 +604,7 @@ 604 604 605 605 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 606 606 607 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 608 608 609 609 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 610 610 ... ... @@ -620,44 +620,22 @@ 620 620 621 621 (% style="color:#000000" %)Ответ: 622 622 623 -((( 624 -{ 625 - "vehicleId": "", ~/~/ ID объекта 626 - "name": "", ~/~/ Имя объекта 627 - "imei": "", ~/~/ IMEI объекта 628 - "deviceTypeId": , ~/~/ ID типа устройства 629 - "deviceTypeName": "", ~/~/ Название типа устройства 630 - "sim1": "", ~/~/ Номер SIM1 631 - "parentId": "", Номер SIM2 632 - "parentName": "", Наименование клиента-родителя 633 - "modelId": "", ID модели объекта 634 - "modelName": "", Имя модели объекта 635 - "createdAt": "", Дата создания объекта 636 - "mileageCalcMethod": "", Выбранный метод расчета пробега 637 - "counters": { ~/~/ Нормы 638 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 639 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 640 - "mileage": "", ~/~/ Пробег по нормам в метрах 641 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 642 - }, 643 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 644 - { 645 - "id": "", ~/~/ ID задания 646 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 647 - "name": "", ~/~/ Наименование задания 648 - "description": "", ~/~/ Описание задания 649 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 650 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 651 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 652 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 653 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 654 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 655 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 656 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 657 - } 658 - ] 370 +(% style="color:#000000" %){ 371 + 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": "" , ~/~/ статус объекта 384 + 659 659 } 660 -))) 661 661 662 662 (% style="text-align:left" %) 663 663 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -671,7 +671,7 @@ 671 671 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 672 672 ))) 673 673 674 -(% 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**). 675 675 676 676 (% style="color:#000000" %)Метод запроса: **POST** 677 677 ... ... @@ -693,22 +693,12 @@ 693 693 "sim2": "" , ~/~/ Номер SIM2 694 694 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 695 695 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 696 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 697 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 698 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 699 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 700 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 701 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 702 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 703 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 704 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 705 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 706 - "counters": ~/~/ счетчики 707 - { 708 - "mileage": "" , ~/~/ пробег 709 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 710 - "motohours": "" , ~/~/ моточасы 711 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "" , ~/~/ пробег 424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 + "motohours": "" , ~/~/ моточасы 426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 712 712 }, 713 713 "cmsv6Parameters": { ~/~/ параметры CMSv6 714 714 "enabled": true, ~/~/ флаг включения ... ... @@ -779,12 +779,7 @@ 779 779 (% style="text-align:left" %) 780 780 (% style="color:#000000" %)} 781 781 782 -**Валидация:** 783 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 784 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 785 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 786 786 787 - 788 788 (% class="box successmessage" %) 789 789 ((( 790 790 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** ... ... @@ -792,7 +792,7 @@ 792 792 793 793 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 794 794 795 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 796 796 797 797 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 798 798 ... ... @@ -818,17 +818,17 @@ 818 818 819 819 (% style="color:#000000" %)Параметры в теле запроса (JSON): 820 820 821 -{ 822 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 823 - "name": null, ~/~/ Имя ТС (string, опционально) 824 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 825 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 826 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 827 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 828 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 829 - "customFields": null ~/~/ значение любого из произвольных полей ТС 830 -} 531 +(% class="western" style="color:#000000" %)##{## 831 831 533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 534 + "name": null, ~/~/ Имя ТС (string, опционально) 535 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 536 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 537 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 538 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 540 +(% style="color:#000000" %)} 541 + 832 832 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 833 833 834 834 (% style="color:#000000" %)Ответ: ... ... @@ -848,30 +848,23 @@ 848 848 "modelName": "" ~/~/ наименование модели объекта 849 849 "unitId": "" ~/~/ идентификатор подразделения 850 850 "unitName": "" ~/~/ наименование подразделения 851 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 852 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 853 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 854 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 855 - "customFields": [ 856 - { 857 - "id": "", ~/~/ идентификатор произвольного поля 858 - "name": "", ~/~/ имя произвольного поля 859 - "value": "", ~/~/ значение произвольного поля 860 - "forClient": true, ~/~/ право на отображение у клиента 861 - "forTooltip": false, ~/~/ право на отображение в подсказке 862 - "forReport": false ~/~/ право на отображение в отчетах 863 - }(%%) 561 + "status": "" ~/~/ статус объекта 562 + "createdAt": "" ~/~/ дата создания объектов (%%) 864 864 (% style="color:#000000" %)} 865 865 866 866 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 867 867 567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 868 868 569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 570 + 571 + 869 869 (% class="box successmessage" %) 870 870 ((( 871 871 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 872 872 ))) 873 873 874 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 875 875 876 876 (% style="color:#000000" %)Метод запроса: **POST** 877 877 ... ... @@ -916,7 +916,7 @@ 916 916 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 917 917 ))) 918 918 919 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 920 920 921 921 (% style="color:#000000" %)Метод запроса: **PUT** 922 922 ... ... @@ -928,7 +928,6 @@ 928 928 929 929 (% style="color:#000000" %){ 930 930 931 -((( 932 932 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 933 933 "parentId": "", ~/~/ ID клиента 934 934 "name": "", ~/~/ имя ТС ... ... @@ -937,25 +937,15 @@ 937 937 "modelId": "", ~/~/ , ID модели 938 938 "unitId": "", ~/~/ подразделения 939 939 "sim1": "", ~/~/ SIM 1 940 - "sim2": "", ~/~/ SIM2 (%%) 941 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 942 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 943 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 944 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 945 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 946 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 947 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 948 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 949 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 950 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 951 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 952 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 953 -(% style="color:#000000" %) "counters": 642 + "sim2": "", ~/~/ SIM2 643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 645 + "counters": 954 954 { 955 955 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 956 956 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 957 - "mileage": "",~/~/пробег,вметрах958 - "motohours": "" ~/~/моточасы,всекундах649 + "mileage": «», пробег 650 + "motohours": «» моточасы 959 959 } 960 960 "cmsv6Parameters": ~/~/ параметры CMSv6 961 961 { ... ... @@ -979,7 +979,6 @@ 979 979 "kind": "", ~/~/ Вид периодичности по времени 980 980 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 981 981 } 982 -))) 983 983 984 984 (% style="color:#000000" %)} 985 985 ... ... @@ -1033,18 +1033,13 @@ 1033 1033 (% lang="en-US" style="text-align:left" %) 1034 1034 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1035 1035 1036 -**валидация:** 1037 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1038 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1039 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1040 1040 1041 - 1042 1042 (% class="box errormessage" %) 1043 1043 ((( 1044 1044 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1045 1045 ))) 1046 1046 1047 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1048 1048 1049 1049 (% style="color:#000000" %)Метод запроса: **DELETE** 1050 1050 ... ... @@ -1068,7 +1068,7 @@ 1068 1068 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1069 1069 ))) 1070 1070 1071 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1072 1072 1073 1073 (% style="color:#000000" %)Метод запроса: **GET** 1074 1074 ... ... @@ -1097,7 +1097,7 @@ 1097 1097 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 1098 1098 ))) 1099 1099 1100 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1101 1101 1102 1102 (% style="color:#000000" %)Метод запроса: **GET** 1103 1103