Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,30 +1,31 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 2 +((( 3 +**Содержание страницы:** 4 +))) 3 3 4 - 5 5 {{toc/}} 6 6 7 7 8 -(% style="color:#000000; font-size:1 8.6667px" %)**Действующие ограничения**9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 9 9 10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 11 11 12 12 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 13 13 14 14 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 15 - 16 16 17 -(% class="box" style="text-align: center;" %) 18 -((( 19 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 20 -))) 17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 21 21 22 -(% class="box successmessage" %) 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 +(% class="box infomessage" %) 23 23 ((( 24 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 25 25 ))) 26 26 27 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 28 28 29 29 (% style="color:#000000" %)Метод запроса: **POST** 30 30 ... ... @@ -37,9 +37,9 @@ 37 37 (% style="color:#000000" %){ 38 38 "login": "testuser", 39 39 "password": "testuser" 40 -}(%%) 41 - 41 +} 42 42 43 + 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) ... ... @@ -54,13 +54,14 @@ 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 56 56 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 57 57 58 58 (% class="box infomessage" %) 59 59 ((( 60 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**62 +(% lang="en-US" %)**GET /api/v3/auth/check** 61 61 ))) 62 62 63 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 64 64 65 65 (% style="color:#000000" %)Метод запроса: **GET** 66 66 ... ... @@ -71,18 +71,58 @@ 71 71 (% lang="en-US" %) 72 72 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 73 73 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 74 74 75 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 76 76 ((( 77 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 78 78 ))) 79 79 85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 86 + 87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 88 + 89 +(% style="color:#000000" %)Метод запроса: **GET** 90 + 91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 92 + 93 +Запрос должен содержать данные параметра "**agentId**" 94 + 95 +(% style="color:#000000" %)Ответ: 96 +А 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" ~/~/ Корр. счет 118 + } 119 + 120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 + 80 80 (% class="box infomessage" %) 81 81 ((( 82 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 83 83 ))) 84 84 85 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 86 86 87 87 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 88 88 ... ... @@ -90,32 +90,36 @@ 90 90 91 91 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 92 92 93 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 94 94 95 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 96 96 97 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 98 98 99 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 100 100 101 101 (% style="color:#000000" %)Ответ: 102 102 103 -(% style="color:#000000" %){ 104 - "agentId": "", ~/~/ идентификатор клиента 105 - "parentId": "", ~/~/ идентификатор клиента-родителя 106 - "name": "", ~/~/ наименование клиента 107 - "fullName": "", ~/~/ полное наименование клиента 108 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 109 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 110 110 } 111 111 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 112 112 113 113 (% class="box successmessage" %) 114 114 ((( 115 -** Добавление клиента —POST /api/v3/agents **161 +**POST /api/v3/agents ** 116 116 ))) 117 117 118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).164 +Метод позволяет добавить клиента, указанного в запросе. 119 119 120 120 Метод запроса: **POST** 121 121 ... ... @@ -129,6 +129,7 @@ 129 129 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 130 130 "name": "string", ~/~/ имя 131 131 "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 132 132 "isForeign": true, ~/~/ иностранный контрагент 133 133 "district": "string", ~/~/ округ 134 134 "region": "string", ~/~/ регион ... ... @@ -153,6 +153,7 @@ 153 153 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 154 154 "name": "string", ~/~/ имя 155 155 "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 156 156 "isForeign": true, ~/~/ иностранный контрагент 157 157 "district": "string", ~/~/ округ 158 158 "region": "string", ~/~/ регион ... ... @@ -169,13 +169,14 @@ 169 169 "bankKS": "string" ~/~/ корр. счёт 170 170 } 171 171 220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 172 172 173 173 (% class="box warningmessage" %) 174 174 ((( 175 -** Редактирование клиента —PUT /api/v3/agents**224 +**PUT /api/v3/agents** 176 176 ))) 177 177 178 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).227 +Метод позволяет отредактировать клиента, указанного в запросе. 179 179 180 180 Метод запроса: **PUT** 181 181 ... ... @@ -191,6 +191,7 @@ 191 191 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 192 192 "name": "string", ~/~/ имя 193 193 "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 194 194 "isForeign": true, ~/~/ иностранный контрагент 195 195 "district": "string", ~/~/ округ 196 196 "region": "string", ~/~/ регион ... ... @@ -231,15 +231,15 @@ 231 231 "bankKS": "string" ~/~/ корр. счёт 232 232 } 233 233 284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 234 234 235 235 (% class="box errormessage" %) 236 236 ((( 237 -** Удаление клиента —DELETE /api/v3/agents/{clientId}**288 +**DELETE /api/v3/agents/{clientId}** 238 238 ))) 239 239 291 +Метод позволяет удалить клиента, указанного в строке запроса. 240 240 241 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 242 - 243 243 Метод запроса: **DELETE** 244 244 245 245 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** ... ... @@ -250,19 +250,16 @@ 250 250 251 251 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 252 252 303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 253 253 305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 254 254 255 -(% class="box" style="text-align: center;" %) 256 -((( 257 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 258 -))) 259 - 260 260 (% class="box successmessage" %) 261 261 ((( 262 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 263 263 ))) 264 264 265 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 266 266 267 267 (% style="color:#000000" %)Метод запроса: **POST** 268 268 ... ... @@ -272,7 +272,8 @@ 272 272 273 273 (% style="color:#000000" %)Параметры в теле запроса (JSON): 274 274 275 -(% style="color:#000000" %){ 322 +(% style="color:#000000" %) 323 +{ 276 276 "lastName": "", ~/~/ фамилия 277 277 "firstName": "", ~/~/ имя 278 278 "position": "", ~/~/ должность ... ... @@ -281,17 +281,41 @@ 281 281 "login": "", ~/~/ логин (обязателен) 282 282 "password": "", ~/~/ пароль (обязателен) 283 283 "email": "", ~/~/ email (обязателен) 284 - "description": "", ~/~/ описание 285 - "isEnabled": "", ~/~/ признак включения 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 286 286 "parentId": "", ~/~/ Guid родительского агента 287 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 288 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 289 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 290 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 291 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 292 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 339 + "doubleAuth": 340 + { 341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 343 + }, 344 + "groups": 345 + [ 346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 347 + ], 348 + "customGroups": 349 + [ 350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 + ], 352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 293 293 } 294 294 355 +{ 356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 + "lastName": "string", 358 + "firstName": "string", 359 + "position": "string", 360 + "phone": "string", 361 + "organization": "string", 362 + "login": "string", 363 + "password": "string", 364 + "email": "string", 365 + 366 + 295 295 (% style="text-align:left" %) 296 296 (% style="color:#000000; font-weight:normal" %)Ответ: 297 297 ... ... @@ -320,13 +320,14 @@ 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000; font-weight:normal" %)} 322 322 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 323 323 324 -(% class="box successmessage" %)397 +(% class="box infomessage" %) 325 325 ((( 326 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**399 +(% lang="en-US" %)**POST /api/v3/users/find** 327 327 ))) 328 328 329 -(% style="color:#000000" %) 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 330 330 331 331 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 332 332 ... ... @@ -367,13 +367,14 @@ 367 367 368 368 (% style="color:#000000" %)} 369 369 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 370 370 371 -(% class="box successmessage" %)445 +(% class="box infomessage" %) 372 372 ((( 373 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 374 374 ))) 375 375 376 -(% style="color:#000000" %) 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 377 377 378 378 (% style="color:#000000" %)Метод запроса: **GET** 379 379 ... ... @@ -400,8 +400,11 @@ 400 400 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 401 401 "description": "", ~/~/ Описание 402 402 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 403 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 404 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 405 405 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 406 406 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 407 407 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован ... ... @@ -415,13 +415,14 @@ 415 415 ))) 416 416 ))) 417 417 495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 418 418 419 419 (% class="box warningmessage" %) 420 420 ((( 421 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 422 422 ))) 423 423 424 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 425 425 426 426 (% style="color:#000000" %)Метод запроса: **PUT** 427 427 ... ... @@ -429,8 +429,6 @@ 429 429 430 430 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 431 431 432 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 433 - 434 434 (% lang="en-US" style="text-align:left" %) 435 435 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 436 436 ... ... @@ -445,7 +445,9 @@ 445 445 "phone": "" , ~/~/ телефон 446 446 "organization": "" , ~/~/ организация 447 447 "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 448 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 449 449 "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 450 450 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 451 451 "isEnabled": "" , ~/~/ признак включения ... ... @@ -452,9 +452,12 @@ 452 452 "parentId": "" , ~/~/ Guid родительского агента 453 453 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 454 454 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 455 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 456 - "kind": "" , ~/~/ тип аутентификации 457 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 458 458 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 459 459 460 460 (% lang="en-US" style="text-align:left" %) ... ... @@ -480,8 +480,12 @@ 480 480 "isEnabled": "" , ~/~/ признак включения 481 481 "parentId": "" , ~/~/ Guid родительского агента 482 482 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 483 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 484 - "kind": "" , ~/~/ тип аутентификации 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 485 485 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 486 486 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 487 487 ... ... @@ -488,13 +488,14 @@ 488 488 (% lang="en-US" style="text-align:left" %) 489 489 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 490 490 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 491 491 492 492 (% class="box warningmessage" %) 493 493 ((( 494 -(% style="color:#000000" %) **Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 495 495 ))) 496 496 497 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 498 498 499 499 (% style="color:#000000" %)Метод запроса: **PUT** 500 500 ... ... @@ -517,13 +517,14 @@ 517 517 (% style="text-align:left" %) 518 518 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 519 519 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 520 520 521 521 (% class="box warningmessage" %) 522 522 ((( 523 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**610 +**POST /api/v3/users/disable** 524 524 ))) 525 525 526 -Метода позволяет выполнить массовую блокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 527 527 528 528 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 529 529 ... ... @@ -538,13 +538,14 @@ 538 538 539 539 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 540 540 628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 541 541 542 542 (% class="box warningmessage" %) 543 543 ((( 544 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**632 +**POST /api/v3/users/enable** 545 545 ))) 546 546 547 -Метода позволяет выполнить массовую разблокировку пользователей (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 548 548 549 549 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 550 550 ... ... @@ -572,15 +572,16 @@ 572 572 } 573 573 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 574 574 "users" - массив id пользователей, которых не удалось включить или отключить. 575 - 576 576 ))) 577 577 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 578 578 (% class="box errormessage" %) 579 579 ((( 580 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 581 581 ))) 582 582 583 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 584 584 585 585 (% style="color:#000000" %)Метод запроса: **DELETE** 586 586 ... ... @@ -593,20 +593,18 @@ 593 593 (% style="text-align:left" %) 594 594 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 595 595 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 596 596 597 -(% class="box" style="text-align: center;" %) 598 -((( 599 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 600 -))) 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 601 601 602 602 (% class="box infomessage" %) 603 603 ((( 604 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 605 605 ))) 606 606 607 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 608 608 609 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 610 610 611 611 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 612 612 ... ... @@ -641,6 +641,8 @@ 641 641 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 642 642 "mileage": "", ~/~/ Пробег по нормам в метрах 643 643 "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 644 644 }, 645 645 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 646 646 { ... ... @@ -667,13 +667,14 @@ 667 667 (% style="text-align:left" %) 668 668 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 669 669 759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 670 670 671 671 (% class="box successmessage" %) 672 672 ((( 673 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**763 +(% lang="en-US" %)**POST /api/v3/vehicles** 674 674 ))) 675 675 676 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе. 677 677 678 678 (% style="color:#000000" %)Метод запроса: **POST** 679 679 ... ... @@ -786,15 +786,16 @@ 786 786 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 787 787 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 788 788 879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 789 789 790 -(% class="box successmessage" %)881 +(% class="box infomessage" %) 791 791 ((( 792 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**883 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 793 793 ))) 794 794 795 -(% style="color:#000000" %) 886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 796 796 797 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 798 798 799 799 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 800 800 ... ... @@ -831,7 +831,7 @@ 831 831 "customFields": null ~/~/ значение любого из произвольных полей ТС 832 832 } 833 833 834 -(% style="color:#000000" %) 925 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 835 835 836 836 (% style="color:#000000" %)Ответ: 837 837 ... ... @@ -867,13 +867,14 @@ 867 867 868 868 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 869 869 961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 870 870 871 871 (% class="box successmessage" %) 872 872 ((( 873 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**965 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 874 874 ))) 875 875 876 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 877 877 878 878 (% style="color:#000000" %)Метод запроса: **POST** 879 879 ... ... @@ -912,13 +912,14 @@ 912 912 (% style="text-align:left" %) 913 913 (% style="color:#000000" %) } 914 914 1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 915 915 916 916 (% class="box warningmessage" %) 917 917 ((( 918 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**1011 +(% lang="en-US" %)**PUT /api/v3/vehicles** 919 919 ))) 920 920 921 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе. 922 922 923 923 (% style="color:#000000" %)Метод запроса: **PUT** 924 924 ... ... @@ -1035,18 +1035,19 @@ 1035 1035 (% lang="en-US" style="text-align:left" %) 1036 1036 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1037 1037 1038 -** валидация:**1131 +**Валидация:** 1039 1039 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1040 1040 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1041 1041 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1042 1042 1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1043 1043 1044 1044 (% class="box errormessage" %) 1045 1045 ((( 1046 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1140 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1047 1047 ))) 1048 1048 1049 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса. 1050 1050 1051 1051 (% style="color:#000000" %)Метод запроса: **DELETE** 1052 1052 ... ... @@ -1059,18 +1059,16 @@ 1059 1059 (% style="text-align:left" %) 1060 1060 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1061 1061 1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1062 1062 1063 -(% class="box" lang="en-US" style="text-align: center;" %) 1064 -((( 1065 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1066 -))) 1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1067 1067 1068 1068 (% class="box infomessage" %) 1069 1069 ((( 1070 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1162 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 1071 1071 ))) 1072 1072 1073 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1074 1074 1075 1075 (% style="color:#000000" %)Метод запроса: **GET** 1076 1076 ... ... @@ -1088,24 +1088,22 @@ 1088 1088 (% style="text-align:left" %) 1089 1089 (% style="color:#000000" %)} 1090 1090 1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1091 1091 1092 -(% class="box" style="text-align: center;" %) 1093 -((( 1094 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 1095 -))) 1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1096 1096 1097 1097 (% class="box infomessage" %) 1098 1098 ((( 1099 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов датчиков**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**1189 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1100 1100 ))) 1101 1101 1102 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1103 1103 1104 1104 (% style="color:#000000" %)Метод запроса: **GET** 1105 1105 1106 1106 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1107 1107 1108 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1109 1109 1110 1110 (% style="color:#000000" %)Ответ: 1111 1111 ... ... @@ -1118,7 +1118,216 @@ 1118 1118 (% style="text-align:left" %) 1119 1119 (% style="color:#000000" %)} 1120 1120 1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1121 1121 1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1214 + 1215 +(% class="box infomessage" style="text-align: left;" %) 1216 +((( 1217 +**POST /api/v3/terminalMessages/count** 1218 +))) 1219 + 1220 +(% style="text-align: left;" %) 1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1222 + 1223 +(% style="text-align: left;" %) 1224 +Метод запроса **POST** 1225 + 1226 +(% style="text-align: left;" %) 1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1228 + 1229 +(% style="text-align: left;" %) 1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1231 + 1232 +(% style="text-align: left;" %) 1233 +{ 1234 + "vehicleIds": [ 1235 + id ~/~/ здесь передается список идентификаторов объектов 1236 + ], 1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1239 +} 1240 + 1241 +(% style="text-align: left;" %) 1242 +Ответ: 1243 + 1244 +(% style="text-align: left;" %) 1245 +[ 1246 + { 1247 + "vehicleId": 0, ~/~/ идентификатор объекта 1248 + "count": 0 ~/~/ количество сообщений за период 1249 + } 1250 +] 1251 + 1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 + 1254 +(% class="box infomessage" %) 1255 +((( 1256 +**POST /api/v3/terminalMessages** 1257 +))) 1258 + 1259 +Метод возвращает список сообщений терминала объекта за выбранный период. 1260 + 1261 +(% style="text-align: left;" %) 1262 +Метод запроса **POST** 1263 + 1264 +(% style="text-align: left;" %) 1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1266 + 1267 +(% style="text-align: left;" %) 1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1269 + 1270 +{ 1271 + "vehicleId": 0, ~/~/ id объекта 1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 +} 1275 + 1276 +Ответ: 1277 + 1278 +[ 1279 + { 1280 + "messages": [ 1281 + { 1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 + "speed": 0, ~/~/ Скорость, км/ч 1285 + "altitude": 0, ~/~/ Высота, м 1286 + "latitude": 0, ~/~/ Широта [-90°;90°] 1287 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 + "satellites": 0, ~/~/ Кол-во спутников 1289 + "voltage": 0, ~/~/ Напряжение 1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1291 + "additionalProp1": "string", 1292 + "additionalProp2": "string", 1293 + "additionalProp3": "string" 1294 + }, 1295 + "photoCount": 0 ~/~/ Кол-во фото 1296 + } 1297 + ] 1298 + } 1299 +] 1300 + 1301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1302 + 1303 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1304 + 1305 +(% class="box infomessage" %) 1306 +((( 1307 +**POST /api/v3/notifications/find** 1308 +))) 1309 + 1310 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1311 + 1312 +(% style="text-align: left;" %) 1313 +Метод запроса **POST** 1314 + 1315 +(% style="text-align: left;" %) 1316 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1317 + 1318 +(% style="text-align: left;" %) 1319 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1320 + 1321 +{ 1322 + "parentId": "" ~/~/ id клиента 1323 +} 1324 + 1325 +Ответ: 1326 + 1327 +[ 1328 + { 1329 + "id": 0, ~/~/ ID уведомления 1330 + "name": "string", ~/~/ Название уведомления 1331 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1332 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1333 + "userId": "", ~/~/ Пользователь, создавший уведомление 1334 + "parentId": "", ~/~/ Идентификатор клиента 1335 + "parentName": "string" ~/~/ Имя клиента 1336 + } 1337 +] 1338 + 1339 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1340 + 1341 +(% class="box infomessage" %) 1342 +((( 1343 +**GET /api/v3/notifications/{id}** 1344 +))) 1345 + 1346 +Метод возвращает данные правил формирования выбранного уведомления. 1347 + 1348 +(% style="text-align: left;" %) 1349 +Метод запроса **GET** 1350 + 1351 +(% style="text-align: left;" %) 1352 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]] 1353 + 1354 +(% style="text-align: left;" %) 1355 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 1356 + 1357 +(% style="text-align: left;" %) 1358 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1359 + 1360 +(% style="text-align: left;" %) 1361 +(% style="color:#000000" %)Ответ: 1362 + 1363 +(% style="text-align: left;" %) 1364 +(% style="color:#000000" %){ 1365 + "id": 0, ~/~/ (%%)id уведомления 1366 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1367 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1368 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1369 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1370 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1371 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1372 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1373 +(% style="color:#000000" %) 0 1374 + ], 1375 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1376 +(% style="color:#000000" %) 0 1377 + ], 1378 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 1379 +(% style="color:#000000" %) 0 1380 + ], 1381 + "settings": { ~/~/ Список параметров уведомления 1382 + "additionalProp1": "string", 1383 + "additionalProp2": "string", 1384 + "additionalProp3": "string" 1385 + }, 1386 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1387 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1388 +(% style="color:#000000" %) "" 1389 + ], 1390 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1391 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1392 +(% style="color:#000000" %) "string" 1393 + ], 1394 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1395 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1396 +(% style="color:#000000" %) { 1397 + "id": 0, ~/~/ (%%)Идентификатор участника чата 1398 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1399 +(% style="color:#000000" %) } 1400 + ], 1401 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1402 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1403 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1404 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1405 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1406 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1407 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1408 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1409 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1410 +(% style="color:#000000" %)} 1411 + 1412 +== (% style="color:#000000; font-size:16px" %)**Добавление уведомления**(%%) == 1413 + 1414 + 1415 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1416 + 1417 + 1418 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1419 + 1420 + 1122 1122 (% class="box" lang="en-US" style="text-align: center;" %) 1123 1123 ((( 1124 1124 (% 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]] **