Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Likes
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,68 +1,50 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 +== Описание ГЛОНАССSoft Public API 3.0 == 3 + 4 +== == 5 + 6 +(% class="box" style="text-align: center;" %) 2 2 ((( 3 -** Содержаниестраницы:**8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения** 4 4 ))) 5 5 6 - {{toc/}}11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 7 7 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 8 8 9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 - 11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 - 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 - 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 + 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 +(% class="box" style="text-align: center;" %) 19 +((( 20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 +))) 18 18 19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 - 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 - 23 23 (% class="box infomessage" %) 24 24 ((( 25 -(% lang="en-US" %)** POST25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** POST**30 +(% style="color:#000000" %)Метод запроса: **GET** 31 31 32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 - 38 -(% style="color:#000000" %){ 39 - "login": "testuser", 40 - "password": "testuser" 41 -} 42 - 43 - 44 -(% style="color:#000000" %)**Ответ:** 45 - 46 46 (% lang="en-US" %) 47 -(% style="color:#000000" %){ 37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 48 48 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 54 -} 55 - 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) 61 61 ((( 62 -(% lang="en-US" %)**GET /api/v3/auth/check** 44 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 63 63 ))) 64 64 65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 66 66 67 67 (% style="color:#000000" %)Метод запроса: **GET** 68 68 ... ... @@ -73,243 +73,49 @@ 73 73 (% lang="en-US" %) 74 74 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 75 75 76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 77 77 78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 - 80 -(% class="box infomessage" %) 59 +(% class="box" style="text-align: center;" %) 81 81 ((( 82 - **GETapi/v3/agents/{id}**61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты** 83 83 ))) 84 84 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 - 122 122 (% class="box infomessage" %) 123 123 ((( 124 -(% lang="en-US" %)** POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 125 125 ))) 126 126 127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочернихклиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителяи т.д.Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 128 128 129 129 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права « __**Доступ к партнёрским клиентам**__».75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 134 134 135 -(% style="color:#000000" %)Метод запроса: ** POST**77 +(% style="color:#000000" %)Метод запроса: **GET** 136 136 137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 79 +(% 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> 138 138 139 -(% style="color:#000000" %)Параметр запроса: 81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 140 140 141 -(% style="color:#000000" %){ 142 - "parentId": "string" 143 -} 83 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 144 144 145 -(% style="color:#000000" %)Ответ: 85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 146 146 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 - Отказ) 155 -} 87 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 156 156 157 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 -(% class="box s uccessmessage" %)90 +(% class="box" style="text-align: center;" %) 160 160 ((( 161 - **POST/api/v3/agents **92 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** 162 162 ))) 163 163 164 -Метод позволяет добавить клиента, указанного в запросе. 165 - 166 -Метод запроса: **POST** 167 - 168 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 169 - 170 -В заголовках запроса: X-Auth: Токен авторизации 171 - 172 -Параметры в теле запроса (JSON): 173 - 174 -{ 175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 - "name": "string", ~/~/ имя 177 - "fullName": "string", ~/~/ полное наименование 178 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 - "isForeign": true, ~/~/ иностранный контрагент 180 - "district": "string", ~/~/ округ 181 - "region": "string", ~/~/ регион 182 - "city": "string", ~/~/ город 183 - "inn": "string", ~/~/ ИНН 184 - "kpp": "string", ~/~/ КПП 185 - "address": "string", ~/~/ юридический адрес 186 - "addressFact": "string", ~/~/ фактический адрес 187 - "email": "string", ~/~/ email 188 - "director": "string", ~/~/ ФИО руководителя 189 - "bankName": "string", ~/~/ банк 190 - "bankBIK": "string", ~/~/ БИК 191 - "bankRS": "string", ~/~/ номер счёта 192 - "bankKS": "string" ~/~/ корр. счёт 193 -} 194 - 195 - 196 -Ответ: 197 - 198 -{ 199 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 200 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 - "name": "string", ~/~/ имя 202 - "fullName": "string", ~/~/ полное наименование 203 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 - "isForeign": true, ~/~/ иностранный контрагент 205 - "district": "string", ~/~/ округ 206 - "region": "string", ~/~/ регион 207 - "city": "string", ~/~/ город 208 - "inn": "string", ~/~/ ИНН 209 - "kpp": "string", ~/~/ КПП 210 - "address": "string", ~/~/ юридический адрес 211 - "addressFact": "string", ~/~/ фактический адрес 212 - "email": "string", ~/~/ email 213 - "director": "string", ~/~/ ФИО руководителя 214 - "bankName": "string", ~/~/ банк 215 - "bankBIK": "string", ~/~/ БИК 216 - "bankRS": "string", ~/~/ номер счёта 217 - "bankKS": "string" ~/~/ корр. счёт 218 -} 219 - 220 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 - 222 -(% class="box warningmessage" %) 223 -((( 224 -**PUT /api/v3/agents** 225 -))) 226 - 227 -Метод позволяет отредактировать клиента, указанного в запросе. 228 - 229 -Метод запроса: **PUT** 230 - 231 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 232 - 233 -В заголовках запроса: X-Auth: Токен авторизации 234 - 235 - 236 -Параметры в теле запроса (JSON): 237 - 238 -{ 239 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 240 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 - "name": "string", ~/~/ имя 242 - "fullName": "string", ~/~/ полное наименование 243 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 - "isForeign": true, ~/~/ иностранный контрагент 245 - "district": "string", ~/~/ округ 246 - "region": "string", ~/~/ регион 247 - "city": "string", ~/~/ город 248 - "inn": "string", ~/~/ ИНН 249 - "kpp": "string", ~/~/ КПП 250 - "address": "string", ~/~/ юридический адрес 251 - "addressFact": "string", ~/~/ фактический адрес 252 - "email": "string", ~/~/ email 253 - "director": "string", ~/~/ ФИО руководителя 254 - "bankName": "string", ~/~/ банк 255 - "bankBIK": "string", ~/~/ БИК 256 - "bankRS": "string", ~/~/ номер счёта 257 - "bankKS": "string" ~/~/ корр. счёт 258 -} 259 - 260 - 261 -Ответ: 262 - 263 -{ 264 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 265 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 266 - "name": "string", ~/~/ имя 267 - "fullName": "string", ~/~/ полное наименование 268 - "isForeign": true, ~/~/ иностранный контрагент 269 - "district": "string", ~/~/ округ 270 - "region": "string", ~/~/ регион 271 - "city": "string", ~/~/ город 272 - "inn": "string", ~/~/ ИНН 273 - "kpp": "string", ~/~/ КПП 274 - "address": "string", ~/~/ юридический адрес 275 - "addressFact": "string", ~/~/ фактический адрес 276 - "email": "string", ~/~/ email 277 - "director": "string", ~/~/ ФИО руководителя 278 - "bankName": "string", ~/~/ банк 279 - "bankBIK": "string", ~/~/ БИК 280 - "bankRS": "string", ~/~/ номер счёта 281 - "bankKS": "string" ~/~/ корр. счёт 282 -} 283 - 284 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 285 - 286 -(% class="box errormessage" %) 287 -((( 288 -**DELETE /api/v3/agents/{clientId}** 289 -))) 290 - 291 -Метод позволяет удалить клиента, указанного в строке запроса. 292 - 293 -Метод запроса: **DELETE** 294 - 295 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 296 - 297 -Параметр запроса: **{clientId}** - Guid пользователя 298 - 299 -В заголовках запроса: X-Auth: Токен авторизации 300 - 301 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 - 303 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 - 305 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 306 - 307 307 (% class="box successmessage" %) 308 308 ((( 309 -(% lang="en-US" %)**POST /api/v3/users** 97 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 310 310 ))) 311 311 312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 313 313 314 314 (% style="color:#000000" %)Метод запроса: **POST** 315 315 ... ... @@ -317,189 +317,50 @@ 317 317 318 318 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 319 319 320 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 108 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } 321 321 322 -(% style="color:#000000" %) 323 -{ 324 - "lastName": "", ~/~/ фамилия 325 - "firstName": "", ~/~/ имя 326 - "position": "", ~/~/ должность 327 - "phone": "", ~/~/ телефон 328 - "organization": "", ~/~/ организация 329 - "login": "", ~/~/ логин (обязателен) 330 - "password": "", ~/~/ пароль (обязателен) 331 - "email": "", ~/~/ email (обязателен) 332 - "description": "string", ~/~/ Описание 333 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 336 - "parentId": "", ~/~/ Guid родительского агента 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 - Азербайджанский 353 -} 354 - 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 - 367 367 (% style="text-align:left" %) 368 -(% style="color:#000000; font-weight:normal" %)Ответ: 111 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } 369 369 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 372 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 375 - "lastName": "" , ~/~/ Фамилия , 376 - "firstName": "" , ~/~/ Имя 377 - "position": "" , ~/~/ Должность 378 - "phone": "" , ~/~/ Телефон 379 - "organization": "" , ~/~/ Организация 380 - "login": "" , ~/~/ Логин 381 - "password": "" , ~/~/ Пароль 382 - "email": "" , ~/~/ Email 383 - "description": "" , ~/~/ Описание 384 - "isEnabled": "" , ~/~/ Признак включения 385 - "parentId": "" , ~/~/ Guid родительского агента 386 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 387 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 388 - "kind": "" , ~/~/ тип аутентификации 389 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 391 - 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 - 395 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 - 397 -(% class="box infomessage" %) 114 +(% class="box successmessage" %) 398 398 ((( 399 -(% lang="en-US" %)**POST /api/v3/users/find** 116 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 400 400 ))) 401 401 402 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 119 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 403 403 404 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **« __Просмотр пользователей__»**.121 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 405 405 406 406 (% style="color:#000000" %)Метод запроса: **POST** 407 407 408 408 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 409 409 410 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 127 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 411 411 412 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 129 +(% class="western" %) 130 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 131 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 132 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 133 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 413 413 414 -(% style="color:#000000" %){ 415 - 416 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 -(% style="color:#000000" %)Ответ: 137 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 424 424 425 -(% style="color:#000000" %){ (%%) 139 +(% class="western" style="margin-bottom:19px" %) 140 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 426 426 427 - "id": "" , ~/~/ идентификатор пользователя 428 - "lastName": "" , ~/~/ фамилия 429 - "firstName": "" , ~/~/ имя 430 - "position": "" , ~/~/ должность 431 - "phone": "" , ~/~/ телефон 432 - "parentId": "" , ~/~/ идентификатор клиента-родителя 433 - "parentName": "" , ~/~/ наименование клиента-родителя 434 - "organization": "" , ~/~/ организация 435 - "login": "" , ~/~/ логин 436 - "email": "" , ~/~/ E-mail 437 - "sessionDuration":"", ~/~/ длительность сессии в минутах 438 - "status": "1", ~/~/ статус пользователя 439 - "lastLogged": "", ~/~/ дата/время последней авторизации 142 +(% lang="en-US" style="text-align:left" %) 143 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 440 440 441 -(% style="color:#000000" %)} 442 442 443 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 444 - 445 -(% class="box infomessage" %) 446 -((( 447 -(% lang="en-US" %)**GET /api/v3/users/{GUID}** 448 -))) 449 - 450 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 451 - 452 -(% style="color:#000000" %)Метод запроса: **GET** 453 - 454 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 455 - 456 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 457 - 458 -(% style="color:#000000" %)Ответ: 459 - 460 -((( 461 -((( 462 -{ 463 - "id": "", ~/~/ GUID пользователя 464 - "lastName": "", ~/~/ Фамилия 465 - "firstName": "", ~/~/ Имя 466 - "position": "", ~/~/ Должность 467 - "phone": "", ~/~/ Номер телефона 468 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 469 - "parentName": "", Наименование клиента, которому принадлежит пользователь 470 - "organization": "", ~/~/ Организация 471 - "login": "", ~/~/ Логин пользователя 472 - "email": "", ~/~/ Адрес электронной почты 473 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 474 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 475 - "description": "", ~/~/ Описание 476 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 477 - "doubleAuth": 478 - { 479 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 - }, 482 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 484 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 485 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 486 - "groups": [], ~/~/ Список ролей пользователя 487 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 488 - "authDevices": [ ], ~/~/ Список авторизованных устройств 489 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 490 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 491 -} 492 -))) 493 -))) 494 - 495 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 496 - 497 497 (% class="box warningmessage" %) 498 498 ((( 499 -(% lang="en-US" %)**PUT /api/v3/users** 148 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 500 500 ))) 501 501 502 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 151 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 503 503 504 504 (% style="color:#000000" %)Метод запроса: **PUT** 505 505 ... ... @@ -508,362 +508,98 @@ 508 508 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 509 509 510 510 (% lang="en-US" style="text-align:left" %) 511 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 160 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } // 512 512 513 -(% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 515 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 518 - "lastName": "" , ~/~/ фамилия 519 - "firstName": "" , ~/~/ имя 520 - "position": "" , ~/~/ должность 521 - "phone": "" , ~/~/ телефон 522 - "organization": "" , ~/~/ организация 523 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 524 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 527 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 528 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 529 - "isEnabled": "" , ~/~/ признак включения 530 - "parentId": "" , ~/~/ Guid родительского агента 531 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 532 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 533 - "doubleAuth": 534 - { 535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 - }, 538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 542 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 - 544 -(% lang="en-US" style="text-align:left" %) 545 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 - 547 -(% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 552 - "lastName": "" , ~/~/ фамилия 553 - "firstName": "" , ~/~/ имя 554 - "position": "" , ~/~/ должность 555 - "phone": "" , ~/~/ телефон 556 - "organization": "" , ~/~/ организация 557 - "login": "" , ~/~/ логин 558 - "password": "" , ~/~/ пароль 559 - "email": "" , ~/~/ email 560 - "description": "" , ~/~/ описание 561 - "isEnabled": "" , ~/~/ признак включения 562 - "parentId": "" , ~/~/ Guid родительского агента 563 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 564 - "doubleAuth": 565 - { 566 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 - }, 569 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 572 - 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 - 578 578 (% class="box warningmessage" %) 579 579 ((( 580 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 165 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 581 581 ))) 582 582 583 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 168 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 584 584 585 585 (% style="color:#000000" %)Метод запроса: **PUT** 586 586 587 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 172 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса: 588 588 589 -(% style="color:#000000" %)Параметр запроса: { __**id**__}- Guidпользователя174 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 590 590 591 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 176 +(% class="western" %) 177 +{{{ "description": "", // описание 178 + "data": "" // данные, связанные со сменой статуса}}} 592 592 593 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 594 - 595 -(% style="color:#000000" %){ 596 - 597 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 - "description": "" , ~/~/ описание 599 - "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) 604 604 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 605 605 606 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 607 607 608 -(% class="box warningmessage" %) 609 -((( 610 -**POST /api/v3/users/disable** 611 -))) 612 - 613 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 614 - 615 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 616 - 617 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 618 - 619 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 - 621 - [ 622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 - ] 625 - 626 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 627 - 628 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 629 - 630 -(% class="box warningmessage" %) 631 -((( 632 -**POST /api/v3/users/enable** 633 -))) 634 - 635 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 636 - 637 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 638 - 639 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 640 - 641 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 642 - 643 - [ 644 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 645 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 646 - ] 647 - 648 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 649 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 650 - 651 -((( 652 -В теле ответа: 653 -{ 654 - "errorMessages": [ 655 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 656 - ], 657 - "users": [ 658 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 659 - ] 660 -} 661 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 662 -"users" - массив id пользователей, которых не удалось включить или отключить. 663 -))) 664 - 665 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 - 667 667 (% class="box errormessage" %) 668 668 ((( 669 -(% lang="en-US" %)**DELETE /api/v3/users/{id}** 188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 670 670 ))) 671 671 672 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 673 673 674 674 (% style="color:#000000" %)Метод запроса: **DELETE** 675 675 676 676 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 677 677 678 -(% style="color:#000000" %)Параметр запроса: { **__id__**} - Guid пользователя197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 679 679 680 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 681 - 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 686 686 687 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 203 +(% class="box" style="text-align: center;" %) 204 +((( 205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 206 +))) 688 688 689 689 (% class="box infomessage" %) 690 690 ((( 691 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 210 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 692 692 ))) 693 693 694 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 213 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 695 695 696 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 215 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 697 697 698 698 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 699 699 700 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **« __Просмотр заданий на техобслуживание__»**.219 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 701 701 702 702 (% style="color:#000000" %)Метод запроса: **GET** 703 703 704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) {(% lang="en-US" %)v(%%)ehicleID}223 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID> 705 705 706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__- идентификатор объекта (integer($int32))225 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 707 707 708 708 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 709 710 710 (% style="color:#000000" %)Ответ: 711 711 712 -((( 713 -{ 714 - "vehicleId": "", ~/~/ ID объекта 715 - "name": "", ~/~/ Имя объекта 716 - "imei": "", ~/~/ IMEI объекта 717 - "deviceTypeId": , ~/~/ ID типа устройства 718 - "deviceTypeName": "", ~/~/ Название типа устройства 719 - "sim1": "", ~/~/ Номер SIM1 720 - "sim2": "", ~/~/ Номер SIM2 231 +(% style="color:#000000" %){ 721 721 722 - "parentId": "", ~/~/ ID клиента-родителя 723 - "parentName": "", ~/~/ Наименование клиента-родителя 724 - "modelId": "", ~/~/ ID модели объекта 725 - "modelName": "", ~/~/ Имя модели объекта 726 - 727 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 - "unitName": "string", ~/~/ Наименование подразделения 729 - "status": 0, ~/~/ Статус объекта 730 - 731 - "createdAt": "", ~/~/ Дата создания объекта 732 - }, 733 - 734 -"customFields": [ ~/~/ Произвольные поля 735 - { 736 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 737 - "name": "string", ~/~/ Имя поля 738 - "value": "string", ~/~/ Значение поля 739 - "forClient": true, ~/~/ Не используемая функция 740 - "forTooltip": true, ~/~/ Отображать в подсказке 741 - "forReport": true ~/~/ Отображать в отчете 742 - } 743 - 744 -], ~/~/ Данные с вкладки нормы 745 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 746 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 747 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 748 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 749 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 750 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 751 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 752 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 753 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 758 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 - "mileageCoeff": 0, ~/~/ коэффициент пробега 760 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 761 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 762 - "counters": { ~/~/ Счетчики 763 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 764 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 765 - "mileage": 0, ~/~/ Текущий пробег 766 - "motohours": 0, ~/~/ Текущие моточасы 767 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 768 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 233 +(% class="western" %) 234 +{{{ "vehicleId": “”, // идентификатор объекта 235 + "name": "", // имя объекта 236 + "imei": "", // IMEI объекта 237 + "deviceTypeId": “”, // идентификатор устройства объекта 238 + "deviceTypeName": "" // наименование устройства объекта 239 + "parentId": "", // идентификатор клиента-родителя 240 + "parentName": "" // наименование клиента-родителя, 241 + "modelId": "", // идентификатор модели объекта 242 + "modelName": "" // наименование модели объекта, 243 + "unitId": "", // идентификатор подразделения 244 + "unitName": "", // наименование подразделения 245 + "status": “”, // статус объекта 246 + ... 769 769 }, 248 + ...}}} 770 770 771 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 772 - "id": "string", ~/~/ ID объекта 773 - "enabled": true, ~/~/ Включить, true - активна, false - не активна 774 - "host": "string", ~/~/ CMSV6 Web Host 775 - "login": "string", ~/~/ CMSV6 Account 776 - "password": "string" ~/~/ CMSV6 Password 777 - }, 250 +(% style="color:#000000" %)} 778 778 779 -"commandTemplates": [ ~/~/ Шаблоны команд 780 - { 781 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 782 - "name": "string", ~/~/ Наименование команды 783 - "command": "string", ~/~/ Текст команды 784 - "retries": 0 ~/~/ Количество попыток 785 - } 786 - ], 787 - 788 - "sensors": [ ~/~/ Датчики 789 - { 790 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 791 - "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный 792 - "type": 0, ~/~/ Тип датчика 793 - "name": "string", ~/~/ Имя датчика 794 - "inputType": 0, ~/~/ Тип входа 795 - "inputNumber": 0, ~/~/ Номер входа 796 - "pseudonym": "string", ~/~/ Псевдоним 797 - "medianDegree": 0, ~/~/ Медианная фильтрация 798 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 799 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 800 - "gradeType": 0, ~/~/ Тип тарировки 801 - "gradesTables": [ ~/~/ Тип тарировки Таблица 802 - { 803 - "grades": [ ~/~/ Тарировка 804 - { 805 - "input": 0, ~/~/ Входящее значение 806 - "output": 0 ~/~/ Выходящее значение 807 - } 808 - ], 809 - "relevanceTime": "2023-05-22T09:57:39.562Z" 810 - } 811 - ], 812 - "showInTooltip": true, ~/~/ Отображать в подсказке 813 - "showLastValid": true, ~/~/ Отображать последнее валидное значение 814 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 - "agrFunction": 0, 817 - "expr": "string", 818 - "children": [ 819 - "string" 820 - ], 821 - "customParams": { 822 - "additionalProp1": "string", 823 - "additionalProp2": "string", 824 - "additionalProp3": "string" 825 - }, 826 - "summaryMaxValue": 0 827 - } 828 - 829 - "drivers": [ ~/~/ Водители 830 - { 831 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 832 - "name": "string", 833 - "description": "string", 834 - "isDefault": true 835 - } 836 - ], 837 - 838 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 839 - { 840 - "id": "", ~/~/ ID задания 841 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 842 - "name": "", ~/~/ Наименование задания 843 - "description": "", ~/~/ Описание задания 844 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 845 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 846 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 847 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 848 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 849 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 850 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 851 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 852 - } 853 - ], 854 - 855 - "statusHistory": [ ~/~/ История статусов 856 - { 857 - "status": 0, 858 - "date": "2023-05-22T09:57:39.562Z", 859 - "description": "string", 860 - "additionalInfo": "string" 861 - } 862 - ] 863 - 864 -} 865 -))) 866 - 867 867 (% style="text-align:left" %) 868 868 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 869 869 ... ... @@ -870,14 +870,13 @@ 870 870 (% style="text-align:left" %) 871 871 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 872 872 873 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 874 874 875 875 (% class="box successmessage" %) 876 876 ((( 877 -(% lang="en-US" %)**POST /api/v3/vehicles** 261 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 878 878 ))) 879 879 880 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 264 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 881 881 882 882 (% style="color:#000000" %)Метод запроса: **POST** 883 883 ... ... @@ -885,201 +885,118 @@ 885 885 886 886 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 887 887 888 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 272 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 889 889 890 -(% style="color:#000000" %){ 891 - 892 - "parentId": "" , ~/~/ ID клиента 893 - "name": "" , ~/~/ имя ТС 894 - "imei": "" , ~/~/ IMEI 895 - "deviceTypeId": "" , ~/~/ ID типа устройства 896 - "modelId": "" , ~/~/ ID модели 897 - "unitId": "" , ~/~/ ID подразделения 898 - "sim1": "" , ~/~/ Номер SIM 1 899 - "sim2": "" , ~/~/ Номер SIM2 900 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 901 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 902 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 903 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 904 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 905 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 906 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 907 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 908 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 909 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 910 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 911 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 912 - 913 - "mileageCalcMethod": 0, 914 - "mileageCoeff": 0, 915 - "locationByCellId": true, 916 - "dottedLineTrackWhenNoCoords": true, 917 - "counters": ~/~/ счетчики 918 - { 919 - "mileage": "" , ~/~/ пробег 920 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 921 - "motohours": "" , ~/~/ моточасы 922 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 274 +(% class="western" %) 275 +{{{ "parentId": "", // ID клиента 276 + "name": "", // имя ТС 277 + "imei": "", // IMEI 278 + "deviceTypeId": "",// ID типа устройства 279 + "modelId": "", 280 + "unitId": "", // ID подразделения 281 + "sim1": "", // Номер SIM 1 282 + "sim2": "", // Номер SIM2 283 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 284 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 285 + "consumptionIdle": "",// Расход топлива на холостом ходу 286 + "counters": { 287 + "mileage": "", // пробег 288 + "mileageEnabled": true, // флаг активности счётчика "пробег" 289 + "motohours":"", // моточасы 290 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 291 + }, 292 + "cmsv6Parameters": { // параметры CMSv6 293 + "enabled": true, // флаг включения 294 + //"id": "", // идентификатор 295 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 296 + "login": "", // имя учетной записи 297 + "password": "" // пароль учетной записи 923 923 }, 924 - "cmsv6Parameters": { ~/~/ параметры CMSv6 925 - "enabled": true, ~/~/ флаг включения 926 - "id": "" , ~/~/ идентификатор 927 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 928 - "login": "" , ~/~/ имя учетной записи 929 - "password": "" ~/~/ пароль учетной записи 930 - }, 931 - "inspectionTasks": ~/~/ задания на ТО 299 + "inspectionTasks": [ // задания на ТО 932 932 { 933 - "enabled": "" , ~/~/ Признак включения 934 - "name": "" , ~/~/ Имя задания 935 - "description": "" , ~/~/ Описание задания 936 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 937 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 938 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 939 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 940 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 941 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 942 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 943 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 944 - } 945 - 946 -"drivers": [ ~/~/ Водители 947 - { 948 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 949 - "isDefault": true 950 - } 951 - ], 952 - "commandTemplates": [ ~/~/ Шаблон команды 953 - { 954 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 955 - "name": "string", 956 - "command": "string", 957 - "retries": 0 958 - } 959 - ], 960 - "sensors": [ ~/~/ Датчики 961 - { 962 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 963 - "kind": 0, 964 - "type": 0, 965 - "name": "string", 966 - "inputType": 0, 967 - "inputNumber": 0, 968 - "pseudonym": "string", 969 - "medianDegree": 0, 970 - "isInverted": true, 971 - "disabled": true, 972 - "gradeType": 0, 973 - "gradesTables": [ 974 - { 975 - "grades": [ 976 - { 977 - "input": 0, 978 - "output": 0 979 - } 980 - ], 981 - "relevanceTime": "2023-05-22T12:19:59.728Z" 982 - } 983 - ], 984 - "showInTooltip": true, 985 - "showLastValid": true, 986 - "showAsDutOnGraph": true, 987 - "showWithoutIgn": true, 988 - "agrFunction": 0, 989 - "expr": "string", 990 - "children": [ 991 - "string" 992 - ], 993 - "customParams": { 994 - "additionalProp1": "string", 995 - "additionalProp2": "string", 996 - "additionalProp3": "string" 301 + "enabled": "", // Признак включения 302 + "name": "", // Имя задания 303 + "description": "", // Описание задания 304 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 305 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 306 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 307 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 308 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 309 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 310 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 311 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 997 997 }, 998 - "summaryMaxValue": 0 999 - } 1000 - ], 1001 - "customFields": [ ~/~/ Произвольные поля 1002 - { 1003 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1004 - "name": "string", 1005 - "value": "string", 1006 - "forClient": true, 1007 - "forTooltip": true, 1008 - "forReport": true 1009 - } 1010 - ] 1011 -} 313 + ]}}} 1012 1012 315 +(% style="color:#000000" %)… } 316 + 1013 1013 (% style="color:#000000" %)Ответ: 1014 1014 1015 1015 (% style="color:#000000" %){ 1016 1016 1017 - "vehicleId": "", ~/~/ID ТС 1018 - "parentId": "", ~/~/Guid владельца ТС 1019 - "name": "", ~/~/Имя объекта 1020 - "imei": "", ~/~/IMEI 1021 - "deviceTypeId": "", ~/~/ID типа устройства 1022 - "modelId": "", ~/~/ID модели 1023 - "unitId": "", ~/~/ID подразделения 1024 - "sim1": "", ~/~/SIM1 1025 - "sim2": "", ~/~/SIM2 1026 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1027 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1028 - "counters": { ~/~/Счётчики 1029 - "mileageEnabled": true, 1030 - "motohoursEnabled": true, 1031 - "mileage": "", 1032 - "motohours": 345.0 1033 - }, 1034 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1035 - "id": null, 1036 - "enabled": true, ~/~/флаг включения 1037 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1038 - "login": "", ~/~/ имя учетной записи 1039 - "password": "" ~/~/ пароль учетной записи 1040 - }, 1041 - "inspectionTasks": { ~/~/ задания на ТО 1042 - "id": "", ~/~/ ID задачи 1043 - "enabled": false, ~/~/ Признак включения 1044 - "name": "", ~/~/ Имя задания 1045 - "description": "", ~/~/ Описание задания 1046 - "mileageCondition": "", ~/~/ Условие по пробегу 1047 - "lastMileage": "", ~/~/ Пробег (в метрах) 1048 - "motohoursCondition": "", ~/~/ Условие по моточасам 1049 - "lastMotohours": "", ~/~/ Моточасы 1050 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1051 - "kind": "", ~/~/ Вид периодичности по времени 1052 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1053 - } 321 +(% class="western" %) 322 +{{{ "vehicleId": "", //ID ТС 323 + "parentId": "", //Guid владельца ТС 324 + "name": "", //Имя объекта 325 + "imei": "", //IMEI 326 + "deviceTypeId": "", //ID типа устройства 327 + "modelId": "", //ID модели 328 + "unitId": "", //ID подразделения 329 + "sim1": "", //SIM1 330 + "sim2": "", //SIM2 331 + "consumptionPer100Km": "", //Расход топлива на 100 км 332 + "consumptionIdle": "", //Расход топлива на холостом ходу 333 + "counters": { //Счётчики 334 + "mileageEnabled": true, 335 + "motohoursEnabled": true, 336 + "mileage": "", 337 + "motohours": 345.0 338 + }, 339 + "cmsv6Parameters": { //Параметры CmsV6 340 + "id": null, 341 + "enabled": true, //флаг включения 342 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 343 + "login": "", // имя учетной записи 344 + "password": "" // пароль учетной записи 345 + }, 346 + "inspectionTasks": [ // задания на ТО 347 + { 348 + "id": "", // ID задачи 349 + "enabled": false, // Признак включения 350 + "name": "", // Имя задания 351 + "description": "", // Описание задания 352 + "mileageCondition": "", // Условие по пробегу 353 + "lastMileage": "", // Пробег (в метрах) 354 + "motohoursCondition": "", // Условие по моточасам 355 + "lastMotohours": "", // Моточасы 356 + "periodicCondition": "", // Условие периодичности по времени 357 + "kind": "", // Вид периодичности по времени 358 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 359 + } 360 + ]}}} 1054 1054 1055 1055 (% style="text-align:left" %) 1056 1056 (% style="color:#000000" %)} 1057 1057 1058 -**Валидация:** 1059 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1060 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1061 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1062 1062 1063 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1064 - 1065 -(% class="box infomessage" %) 366 +(% class="box successmessage" %) 1066 1066 ((( 1067 -(% lang="en-US" %)**POST /api/v3/vehicles/find** 368 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find** 1068 1068 ))) 1069 1069 1070 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 371 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1071 1071 1072 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 373 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 1073 1073 1074 1074 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 1075 1075 1076 1076 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 1077 1077 1078 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;379 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 1079 1079 1080 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;381 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 1081 1081 1082 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.383 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 1083 1083 1084 1084 (% style="color:#000000" %)Метод запроса: **POST** 1085 1085 ... ... @@ -1087,115 +1087,76 @@ 1087 1087 1088 1088 (% style="color:#000000" %)В заголовках запроса: 1089 1089 1090 -(% style="color:#000000" %)− Content-Type: __**application/json**__391 +(% style="color:#000000" %)− Content-Type: application/json 1091 1091 1092 1092 (% style="color:#000000" %)− X-Auth: Токен авторизации 1093 1093 1094 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 395 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 1095 1095 1096 -(% style="color:#000000" %) Параметрывтелезапроса (JSON):397 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 1097 1097 1098 -{ 1099 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1100 - "name": null, ~/~/ Имя ТС (string, опционально) 1101 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1102 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1103 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1104 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1105 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1106 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1107 -} 399 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1108 1108 1109 -(% style="color:#000000" %) Фильтрацияосуществляетсяпоточному совпадению значений параметров«__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__»,«__**unitId**__»,ипочастичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра«__**sim**__»осуществляетсяприналичии у авторизованного пользователя права **«__Просмотрномеровтелефоновобъектов__»**.401 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 1110 1110 1111 -(% style="color:#000000" %) Ответ:403 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 1112 1112 1113 -(% style="color:#000000" %) {405 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 1114 1114 1115 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1116 - "name": "" ~/~/ наименование объекта 1117 - "imei": "" ~/~/ IMEI объекта 1118 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 1119 - "deviceTypeName": "" ~/~/ наименование типа устройства 1120 - "sim1": "" ~/~/ первый номер телефона 1121 - "sim2": "" ~/~/ второй номер телефона 1122 - "parentId": "" ~/~/ идентификатор клиента-родителя 1123 - "parentName": "" ~/~/ наименование клиента-родителя 1124 - "modelId": "" ~/~/ идентификатор модели объекта 1125 - "modelName": "" ~/~/ наименование модели объекта 1126 - "unitId": "" ~/~/ идентификатор подразделения 1127 - "unitName": "" ~/~/ наименование подразделения 1128 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1129 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1130 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1131 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1132 - "customFields": [ 1133 - { 1134 - "id": "", ~/~/ идентификатор произвольного поля 1135 - "name": "", ~/~/ имя произвольного поля 1136 - "value": "", ~/~/ значение произвольного поля 1137 - "forClient": true, ~/~/ право на отображение у клиента 1138 - "forTooltip": false, ~/~/ право на отображение в подсказке 1139 - "forReport": false ~/~/ право на отображение в отчетах 1140 - }(%%) 1141 -(% style="color:#000000" %)} 407 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 1142 1142 1143 -(% style="color:#000000" %) Параметры « __**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.409 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1144 1144 1145 - == (% style="color:#000000;font-size:16px"%)**Изменениестатуса объекта**(%%) ==411 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1146 1146 413 + 1147 1147 (% class="box successmessage" %) 1148 1148 ((( 1149 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 416 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 1150 1150 ))) 1151 1151 1152 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 419 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1153 1153 1154 1154 (% style="color:#000000" %)Метод запроса: **POST** 1155 1155 1156 1156 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId} 1157 1157 1158 -(% style="color:#000000" %)Параметр запроса: { __**vehicleId**__} - ID ТС425 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 1159 1159 1160 1160 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1161 1161 1162 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 429 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 1163 1163 1164 -(% style="color:#000000" %){ 431 +(% class="western" %) 432 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 433 + "date": "", // Дата смены статуса (null если сменить немедленно) 434 + "description": "", // Описание 435 + "data": "", // Данные 436 + "overwrite": false, // Флаг перезаписи 437 + "stage": "", // Состояние, может быть null}}} 1165 1165 1166 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1167 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1168 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1169 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1170 - "description": "", ~/~/ Описание 1171 - "data": "", ~/~/ Данные 1172 - "overwrite": false, ~/~/ Флаг перезаписи 1173 - "stage": "", ~/~/ Состояние, может быть null 1174 - 1175 1175 (% style="color:#000000" %)} 1176 1176 1177 -(% style="color:#000000" %)Ответ: 441 +(% style="color:#000000" %)Ответ: { 1178 1178 1179 -(% style="color:#000000" %){ 443 +(% class="western" %) 444 +{{{ "status": "", // значение статуса 445 + "date": "", // Дата смены статуса 446 + "description": "", // Описание 447 + "data": "", // Данные 448 + "overwrite": false, // Флаг перезаписи 449 + "stage": "", // Состояние}}} 1180 1180 1181 - "status": "", ~/~/ значение статуса 1182 - "date": "", ~/~/ Дата смены статуса 1183 - "description": "", ~/~/ Описание 1184 - "data": "", ~/~/ Данные 1185 - "overwrite": false, ~/~/ Флаг перезаписи 1186 - "stage": "", ~/~/ Состояние 1187 - 1188 1188 (% style="text-align:left" %) 1189 -(% style="color:#000000" %) 452 +(% style="color:#000000" %)} 1190 1190 1191 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1192 1192 1193 1193 (% class="box warningmessage" %) 1194 1194 ((( 1195 -(% lang="en-US" %)**PUT /api/v3/vehicles** 457 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 1196 1196 ))) 1197 1197 1198 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 460 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1199 1199 1200 1200 (% style="color:#000000" %)Метод запроса: **PUT** 1201 1201 ... ... @@ -1205,198 +1205,26 @@ 1205 1205 1206 1206 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1207 1207 1208 -(% style="color:#000000" %){ 470 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1209 1209 1210 - "parentId": "" , ~/~/ ID клиента 1211 - "name": "" , ~/~/ имя ТС 1212 - "imei": "" , ~/~/ IMEI 1213 - "deviceTypeId": "" , ~/~/ ID типа устройства 1214 - "modelId": "" , ~/~/ ID модели 1215 - "unitId": "" , ~/~/ ID подразделения 1216 - "sim1": "" , ~/~/ Номер SIM 1 1217 - "sim2": "" , ~/~/ Номер SIM2 1218 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1219 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1220 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1221 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1222 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1223 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1224 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1225 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1226 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1227 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1228 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1229 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1230 - 1231 - "mileageCalcMethod": 0, 1232 - "mileageCoeff": 0, 1233 - "locationByCellId": true, 1234 - "dottedLineTrackWhenNoCoords": true, 1235 - "counters": ~/~/ счетчики 1236 - { 1237 - "mileage": "" , ~/~/ пробег 1238 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1239 - "motohours": "" , ~/~/ моточасы 1240 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1241 - }, 1242 - "cmsv6Parameters": { ~/~/ параметры CMSv6 1243 - "enabled": true, ~/~/ флаг включения 1244 - "id": "" , ~/~/ идентификатор 1245 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1246 - "login": "" , ~/~/ имя учетной записи 1247 - "password": "" ~/~/ пароль учетной записи 1248 - }, 1249 - "inspectionTasks": ~/~/ задания на ТО 1250 - { 1251 - "enabled": "" , ~/~/ Признак включения 1252 - "name": "" , ~/~/ Имя задания 1253 - "description": "" , ~/~/ Описание задания 1254 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1255 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1256 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1257 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1258 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1259 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1260 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1261 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1262 - } 1263 - 1264 -"drivers": [ ~/~/ Водители 1265 - { 1266 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1267 - "isDefault": true 1268 - } 1269 - ], 1270 - "commandTemplates": [ ~/~/ Шаблон команды 1271 - { 1272 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1273 - "name": "string", 1274 - "command": "string", 1275 - "retries": 0 1276 - } 1277 - ], 1278 - "sensors": [ ~/~/ Датчики 1279 - { 1280 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1281 - "kind": 0, 1282 - "type": 0, 1283 - "name": "string", 1284 - "inputType": 0, 1285 - "inputNumber": 0, 1286 - "pseudonym": "string", 1287 - "medianDegree": 0, 1288 - "isInverted": true, 1289 - "disabled": true, 1290 - "gradeType": 0, 1291 - "gradesTables": [ 1292 - { 1293 - "grades": [ 1294 - { 1295 - "input": 0, 1296 - "output": 0 1297 - } 1298 - ], 1299 - "relevanceTime": "2023-05-22T12:19:59.728Z" 1300 - } 1301 - ], 1302 - "showInTooltip": true, 1303 - "showLastValid": true, 1304 - "showAsDutOnGraph": true, 1305 - "showWithoutIgn": true, 1306 - "agrFunction": 0, 1307 - "expr": "string", 1308 - "children": [ 1309 - "string" 1310 - ], 1311 - "customParams": { 1312 - "additionalProp1": "string", 1313 - "additionalProp2": "string", 1314 - "additionalProp3": "string" 1315 - }, 1316 - "summaryMaxValue": 0 1317 - } 1318 - ], 1319 - "customFields": [ ~/~/ Произвольные поля 1320 - { 1321 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1322 - "name": "string", 1323 - "value": "string", 1324 - "forClient": true, 1325 - "forTooltip": true, 1326 - "forReport": true 1327 - } 1328 - ] 1329 -} 1330 - 1331 1331 (% style="color:#000000" %)Ответ: 1332 1332 1333 1333 (% lang="en-US" style="text-align:left" %) 1334 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 475 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] } 1335 1335 1336 -(% lang="en-US" style="text-align:left" %) 1337 - "vehicleId": "", ~/~/ ID ТС 1338 - "parentId": "", ~/~/ ID клиента 1339 - "name": "", ~/~/ имя ТС 1340 - "imei": "", ~/~/ IMEI 1341 - "deviceTypeId": "", ~/~/ типа устройства 1342 - "modelId": "", ~/~/ ID модели 1343 - "unitId": "", ~/~/ ID подразделения 1344 - "sim1": "", ~/~/ SIM 1 1345 - "sim2": "", ~/~/ SIM2 1346 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1347 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1348 - "counters": 1349 - { 1350 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1351 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1352 - "mileage": "", ~/~/ пробег 1353 - "motohours": "", ~/~/ моточасы 1354 - } 1355 - "cmsv6Parameters": ~/~/ параметры CMSv6 1356 - { 1357 - "id": ~/~/ идентификатор 1358 - "enabled": true, ~/~/ флаг включения 1359 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1360 - "login": "", ~/~/ имя учетной записи 1361 - "password": "", ~/~/ пароль учетной записи 1362 - } 1363 - "inspectionTasks": ~/~/ задания на ТО 1364 - { 1365 - "id": "", ~/~/ ID задания 1366 - "enabled": false, ~/~/ Признак включения 1367 - "name": "", ~/~/ Имя задания 1368 - "description": "", ~/~/ Описание задания 1369 - "mileageCondition": "", ~/~/ Условие по пробегу 1370 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1371 - "motohoursCondition": "", ~/~/ Условие по моточасам 1372 - "lastMotohours": "", ~/~/ Моточасы 1373 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1374 - "kind": "", ~/~/ Вид периодичности по времени 1375 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1376 - } 1377 1377 1378 -(% lang="en-US" style="text-align:left" %) 1379 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1380 - 1381 -**Валидация:** 1382 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1383 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1384 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1385 - 1386 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1387 - 1388 1388 (% class="box errormessage" %) 1389 1389 ((( 1390 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 480 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1391 1391 ))) 1392 1392 1393 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 483 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1394 1394 1395 1395 (% style="color:#000000" %)Метод запроса: **DELETE** 1396 1396 1397 1397 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1398 1398 1399 -(% style="color:#000000" %)Параметр запроса: { __**id**__} - Guid объекта489 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 1400 1400 1401 1401 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1402 1402 ... ... @@ -1403,351 +1403,70 @@ 1403 1403 (% style="text-align:left" %) 1404 1404 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1405 1405 1406 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1407 1407 1408 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1409 - 1410 -(% class="box infomessage" %) 497 +(% class="box" lang="en-US" style="text-align: center;" %) 1411 1411 ((( 1412 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**499 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1413 1413 ))) 1414 1414 1415 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 1416 - 1417 -(% style="color:#000000" %)Метод запроса: **GET** 1418 - 1419 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1420 - 1421 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1422 - 1423 -(% style="color:#000000" %)Ответ: 1424 - 1425 -(% style="color:#000000" %){ 1426 - 1427 - "deviceTypeId" : "", ~/~/ ID типа устройства 1428 - "deviceTypeName" : "" ~/~/ Название типа устройства 1429 - 1430 -(% style="text-align:left" %) 1431 -(% style="color:#000000" %)} 1432 - 1433 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1434 - 1435 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1436 - 1437 1437 (% class="box infomessage" %) 1438 1438 ((( 1439 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/ sensors/types**504 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1440 1440 ))) 1441 1441 1442 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типахдатчиков с учетом настроек авторизованного пользователя, указанного в запросе.507 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1443 1443 1444 1444 (% style="color:#000000" %)Метод запроса: **GET** 1445 1445 1446 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/se nsors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]511 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1447 1447 1448 1448 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1449 1449 1450 -(% style="color:#000000" %)Ответ: 515 +(% style="color:#000000" %)Ответ: [ 1451 1451 1452 -(% style="color:#000000" %){ 517 +(% class="western" %) 518 +{{{ { 519 + "deviceTypeId" : "", // ID типа устройства 520 + "deviceTypeName" : "" // Название типа устройства 521 + },}}} 1453 1453 1454 - "id": "", ~/~/ ID типа датчика 1455 - "name": "", ~/~/ Название 1456 - "description": "", ~/~/ Описание 1457 - 1458 1458 (% style="text-align:left" %) 1459 -(% style="color:#000000" %) }524 +(% style="color:#000000" %)…** **] 1460 1460 1461 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1462 1462 1463 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1464 - 1465 -(% class="box infomessage" style="text-align: left;" %) 527 +(% class="box" style="text-align: center;" %) 1466 1466 ((( 1467 - **POST/api/v3/terminalMessages/count**529 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 1468 1468 ))) 1469 1469 1470 -(% style="text-align: left;" %) 1471 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1472 - 1473 -(% style="text-align: left;" %) 1474 -Метод запроса **POST** 1475 - 1476 -(% style="text-align: left;" %) 1477 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1478 - 1479 -(% style="text-align: left;" %) 1480 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1481 - 1482 -(% style="text-align: left;" %) 1483 -{ 1484 - "vehicleIds": [ 1485 - id ~/~/ здесь передается список идентификаторов объектов 1486 - ], 1487 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1488 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1489 -} 1490 - 1491 -(% style="text-align: left;" %) 1492 -Ответ: 1493 - 1494 -(% style="text-align: left;" %) 1495 -[ 1496 - { 1497 - "vehicleId": 0, ~/~/ идентификатор объекта 1498 - "count": 0 ~/~/ количество сообщений за период 1499 - } 1500 -] 1501 - 1502 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1503 - 1504 1504 (% class="box infomessage" %) 1505 1505 ((( 1506 -** POST/api/v3/terminalMessages**534 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 1507 1507 ))) 1508 1508 1509 -Метод возвращает списоксообщенийтерминала объекта за выбранный период.537 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1510 1510 1511 -(% style="text-align: left;" %) 1512 -Метод запроса **POST** 539 +(% style="color:#000000" %)Метод запроса: **GET** 1513 1513 1514 -(% style="text-align: left;" %) 1515 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 541 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1516 1516 1517 -(% style="text-align: left;" %) 1518 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 543 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1519 1519 1520 -{ 1521 - "vehicleId": 0, ~/~/ id объекта 1522 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1523 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1524 -} 545 +(% style="color:#000000" %)Ответ: [ 1525 1525 1526 -Ответ: 547 +(% class="western" style="margin-bottom:19px" %) 548 +{{{ {}}} 1527 1527 1528 -[ 1529 - { 1530 - "messages": [ 1531 - { 1532 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1533 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1534 - "speed": 0, ~/~/ Скорость, км/ч 1535 - "altitude": 0, ~/~/ Высота, м 1536 - "latitude": 0, ~/~/ Широта [-90°;90°] 1537 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1538 - "satellites": 0, ~/~/ Кол-во спутников 1539 - "voltage": 0, ~/~/ Напряжение 1540 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1541 - "additionalProp1": "string", 1542 - "additionalProp2": "string", 1543 - "additionalProp3": "string" 1544 - }, 1545 - "photoCount": 0 ~/~/ Кол-во фото 1546 - } 1547 - ] 1548 - } 1549 -] 550 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1550 1550 1551 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 552 +(% class="western" %) 553 +{{{ "description": "" // Описание 554 + },}}} 1552 1552 1553 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 556 +(% style="text-align:left" %) 557 +(% style="color:#000000" %)… ] 1554 1554 1555 -(% class="box infomessage" %) 1556 -((( 1557 -**POST /api/v3/notifications/find** 1558 -))) 1559 1559 1560 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1561 - 1562 -(% style="text-align: left;" %) 1563 -Метод запроса **POST** 1564 - 1565 -(% style="text-align: left;" %) 1566 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1567 - 1568 -(% style="text-align: left;" %) 1569 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1570 - 1571 -{ 1572 - "parentId": "" ~/~/ id клиента 1573 -} 1574 - 1575 -Ответ: 1576 - 1577 -[ 1578 - { 1579 - "id": 0, ~/~/ ID уведомления 1580 - "name": "string", ~/~/ Название уведомления 1581 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 1582 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1583 - "userId": "", ~/~/ Пользователь, создавший уведомление 1584 - "parentId": "", ~/~/ Идентификатор клиента 1585 - "parentName": "string" ~/~/ Имя клиента 1586 - } 1587 -] 1588 - 1589 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1590 - 1591 -(% class="box infomessage" %) 1592 -((( 1593 -**GET /api/v3/notifications/{id}** 1594 -))) 1595 - 1596 -Метод возвращает данные правил формирования выбранного уведомления. 1597 - 1598 -(% style="text-align: left;" %) 1599 -Метод запроса **GET** 1600 - 1601 -(% style="text-align: left;" %) 1602 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1603 - 1604 -(% style="text-align: left;" %) 1605 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 1606 - 1607 -(% style="text-align: left;" %) 1608 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1609 - 1610 -(% style="text-align: left;" %) 1611 -(% style="color:#000000" %)Ответ: 1612 - 1613 -(% style="text-align: left;" %) 1614 -(% style="color:#000000" %){ 1615 - "id": 0, ~/~/ (%%)id уведомления 1616 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1617 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1618 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1619 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1620 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1621 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1622 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1623 -(% style="color:#000000" %) 0 1624 - ], 1625 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1626 -(% style="color:#000000" %) 0 1627 - ], 1628 - "fieldids": [ ~/~/ (%%)Список id полей для анализа 1629 -(% style="color:#000000" %) 0 1630 - ], 1631 - "settings": { ~/~/ Список параметров уведомления 1632 - "additionalProp1": "string", 1633 - "additionalProp2": "string", 1634 - "additionalProp3": "string" 1635 - }, 1636 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1637 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1638 -(% style="color:#000000" %) "" 1639 - ], 1640 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1641 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1642 -(% style="color:#000000" %) "string" 1643 - ], 1644 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1645 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1646 -(% style="color:#000000" %) { 1647 - "id": 0, ~/~/ (%%)Идентификатор участника чата 1648 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1649 -(% style="color:#000000" %) } 1650 - ], 1651 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1652 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1653 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1654 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1655 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1656 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1657 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1658 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1659 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1660 -(% style="color:#000000" %)} 1661 - 1662 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1663 - 1664 -(% class="box warningmessage" %) 1665 -((( 1666 -**PUT /api/v3/notifications/** 1667 -))) 1668 - 1669 -Метод позволяет отредактировать уведомление. 1670 - 1671 -Метод запроса **PUT** 1672 - 1673 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 1674 - 1675 -В заголовках запроса: X-Auth: Токен авторизации 1676 - 1677 -Тело запроса: 1678 -{ 1679 - "id": 0, ~/~/ id уведомления 1680 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1681 - "userId": "", ~/~/ Пользователь, создавший уведомление 1682 - "parentId": "", ~/~/ Идентификатор клиента 1683 - "parentName": "string", ~/~/ Имя клиента 1684 - "name": "string", ~/~/ Название уведомления 1685 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 1686 - "vehicleIds": [ ~/~/ Список id объектов для анализа 1687 - 0 1688 - ], 1689 - "geoids": [ ~/~/ Список id геообъектов для анализа 1690 - 0 1691 - ], 1692 - "fieldids": [ ~/~/ Список id полей для анализа 1693 - 0 1694 - ], 1695 - "settings": { ~/~/ Список параметров уведомления 1696 - "additionalProp1": "string", 1697 - "additionalProp2": "string", 1698 - "additionalProp3": "string" 1699 - }, 1700 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1701 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1702 - "" 1703 - ], 1704 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1705 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1706 - "string" 1707 - ], 1708 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 1709 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1710 - { 1711 - "id": 0, ~/~/ Идентификатор участника чата 1712 - "info": "string" ~/~/ Дополнительные сведения 1713 - } 1714 - ], 1715 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 1716 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 1717 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1718 - "kind": 0, ~/~/ Определяет вид уведомления 1719 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1720 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 1721 - "timezone": 0, ~/~/ Сдвиг часового пояса 1722 - "validity": 0, ~/~/ Срок действия в днях (1-90) 1723 - "autoProlongation": true ~/~/ Автопродление срока действия 1724 -} 1725 - 1726 -Ответ: 1727 - 1728 -Success 1729 - 1730 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1731 - 1732 -(% class="box errormessage" %) 1733 -((( 1734 -**DELETE /api/v3/notifications/{id}** 1735 -))) 1736 - 1737 -Метод позволяет удалить выбранное уведомление. 1738 - 1739 -Метод запроса **DELETE** 1740 - 1741 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1742 - 1743 -Передаваемый параметр: {id} - id уведомления 1744 - 1745 -В заголовках запроса: X-Auth: Токен авторизации 1746 - 1747 -Ответ: 1748 - 1749 -Success 1750 - 1751 1751 (% class="box" lang="en-US" style="text-align: center;" %) 1752 1752 ((( 1753 1753 (% 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]] **