Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
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" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).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" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 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": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 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" %)Метод позволяет получить параметры всех дочернихклиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителяи т.д.Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):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 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 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 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 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 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 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" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 313 313 314 314 (% style="color:#000000" %)Метод запроса: **POST** 315 315 ... ... @@ -317,161 +317,18 @@ 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 - "lastName": "", ~/~/ фамилия 324 - "firstName": "", ~/~/ имя 325 - "position": "", ~/~/ должность 326 - "phone": "", ~/~/ телефон 327 - "organization": "", ~/~/ организация 328 - "login": "", ~/~/ логин (обязателен) 329 - "password": "", ~/~/ пароль (обязателен) 330 - "email": "", ~/~/ email (обязателен) 331 - "description": "", ~/~/ описание 332 - "isEnabled": "", ~/~/ признак включения 333 - "parentId": "", ~/~/ Guid родительского агента 334 - "leaderId": "", ~/~/ Guid руководителя (null - не задан) 335 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 336 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 337 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 338 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 339 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 340 -} 341 - 342 342 (% style="text-align:left" %) 343 -(% 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» //названия групп ] } 344 344 345 -(% style="text-align:left" %) 346 -(% style="color:#000000; font-weight:normal" %){ 347 347 348 -(% style="text-align:left" %) 349 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 350 - "lastName": "" , ~/~/ Фамилия , 351 - "firstName": "" , ~/~/ Имя 352 - "position": "" , ~/~/ Должность 353 - "phone": "" , ~/~/ Телефон 354 - "organization": "" , ~/~/ Организация 355 - "login": "" , ~/~/ Логин 356 - "password": "" , ~/~/ Пароль 357 - "email": "" , ~/~/ Email 358 - "description": "" , ~/~/ Описание 359 - "isEnabled": "" , ~/~/ Признак включения 360 - "parentId": "" , ~/~/ Guid родительского агента 361 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 362 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 363 - "kind": "" , ~/~/ тип аутентификации 364 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 365 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 366 - 367 -(% style="text-align:left" %) 368 -(% style="color:#000000; font-weight:normal" %)} 369 - 370 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 371 - 372 -(% class="box infomessage" %) 373 -((( 374 -(% lang="en-US" %)**POST /api/v3/users/find** 375 -))) 376 - 377 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 378 - 379 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 380 - 381 -(% style="color:#000000" %)Метод запроса: **POST** 382 - 383 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 384 - 385 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 386 - 387 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 388 - 389 -(% style="color:#000000" %){ 390 - 391 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 392 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 393 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 394 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 395 - 396 -(% style="color:#000000" %)} 397 - 398 -(% style="color:#000000" %)Ответ: 399 - 400 -(% style="color:#000000" %){ (%%) 401 - 402 - "id": "" , ~/~/ идентификатор пользователя 403 - "lastName": "" , ~/~/ фамилия 404 - "firstName": "" , ~/~/ имя 405 - "position": "" , ~/~/ должность 406 - "phone": "" , ~/~/ телефон 407 - "parentId": "" , ~/~/ идентификатор клиента-родителя 408 - "parentName": "" , ~/~/ наименование клиента-родителя 409 - "organization": "" , ~/~/ организация 410 - "login": "" , ~/~/ логин 411 - "email": "" , ~/~/ E-mail 412 - "sessionDuration":"", ~/~/ длительность сессии в минутах 413 - "status": "1", ~/~/ статус пользователя 414 - "astLogged": "", ~/~/ дата/время последней авторизации 415 - 416 -(% style="color:#000000" %)} 417 - 418 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 419 - 420 -(% class="box infomessage" %) 421 -((( 422 -(% lang="en-US" %)**GET /api/v3/users/{GUID}** 423 -))) 424 - 425 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 426 - 427 -(% style="color:#000000" %)Метод запроса: **GET** 428 - 429 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 430 - 431 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 432 - 433 -(% style="color:#000000" %)Ответ: 434 - 435 -((( 436 -((( 437 -{ 438 - "id": "", ~/~/ GUID пользователя 439 - "lastName": "", ~/~/ Фамилия 440 - "firstName": "", ~/~/ Имя 441 - "position": "", ~/~/ Должность 442 - "phone": "", ~/~/ Номер телефона 443 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 444 - "parentName": "", Наименование клиента, которому принадлежит пользователь 445 - "organization": "", ~/~/ Организация 446 - "login": "", ~/~/ Логин пользователя 447 - "email": "", ~/~/ Адрес электронной почты 448 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 449 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 450 - "description": "", ~/~/ Описание 451 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 452 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 453 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 454 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 455 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 456 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 457 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 458 - "groups": [], ~/~/ Список ролей пользователя 459 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 460 - "authDevices": [ ], ~/~/ Список авторизованных устройств 461 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 462 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 463 -} 464 -))) 465 -))) 466 - 467 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 468 - 469 469 (% class="box warningmessage" %) 470 470 ((( 471 -(% lang="en-US" %)**PUT /api/v3/users** 116 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 472 472 ))) 473 473 474 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).119 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 475 475 476 476 (% style="color:#000000" %)Метод запроса: **PUT** 477 477 ... ... @@ -480,165 +480,98 @@ 480 480 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 481 481 482 482 (% lang="en-US" style="text-align:left" %) 483 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 128 +(% 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» //названия групп ] } // 484 484 485 -(% lang="en-US" style="text-align:left" %) 486 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 487 487 488 -(% lang="en-US" style="text-align:left" %) 489 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 490 - "lastName": "" , ~/~/ фамилия 491 - "firstName": "" , ~/~/ имя 492 - "position": "" , ~/~/ должность 493 - "phone": "" , ~/~/ телефон 494 - "organization": "" , ~/~/ организация 495 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 496 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 497 - "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 498 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 499 - "isEnabled": "" , ~/~/ признак включения 500 - "parentId": "" , ~/~/ Guid родительского агента 501 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 502 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 503 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 504 - "kind": "" , ~/~/ тип аутентификации 505 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 506 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 507 - 508 -(% lang="en-US" style="text-align:left" %) 509 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 510 - 511 -(% lang="en-US" style="text-align:left" %) 512 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 513 - 514 -(% lang="en-US" style="text-align:left" %) 515 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 516 - 517 -(% lang="en-US" style="text-align:left" %) 518 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 519 - "lastName": "" , ~/~/ фамилия 520 - "firstName": "" , ~/~/ имя 521 - "position": "" , ~/~/ должность 522 - "phone": "" , ~/~/ телефон 523 - "organization": "" , ~/~/ организация 524 - "login": "" , ~/~/ логин 525 - "password": "" , ~/~/ пароль 526 - "email": "" , ~/~/ email 527 - "description": "" , ~/~/ описание 528 - "isEnabled": "" , ~/~/ признак включения 529 - "parentId": "" , ~/~/ Guid родительского агента 530 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 531 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 532 - "kind": "" , ~/~/ тип аутентификации 533 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 534 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 535 - 536 -(% lang="en-US" style="text-align:left" %) 537 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 538 - 539 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 540 - 541 541 (% class="box warningmessage" %) 542 542 ((( 543 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 133 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 544 544 ))) 545 545 546 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).136 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 547 547 548 548 (% style="color:#000000" %)Метод запроса: **PUT** 549 549 550 -(% 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} 140 +(% 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} Параметр запроса: 551 551 552 -(% style="color:#000000" %)Параметр запроса: { __**id**__}- Guidпользователя142 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 553 553 554 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 144 +(% class="western" %) 145 +{{{ "description": "", // описание 146 + "data": "" // данные, связанные со сменой статуса}}} 555 555 556 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 557 - 558 -(% style="color:#000000" %){ 559 - 560 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 561 - "description": "" , ~/~/ описание 562 - "data": "" , ~/~/ данные, связанные со сменой статуса 563 - 564 564 (% style="color:#000000" %)} 565 565 566 566 (% style="text-align:left" %) 567 567 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 568 568 569 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 570 570 571 -(% class="box warningmessage" %)154 +(% class="box successmessage" %) 572 572 ((( 573 -**POST /api/v3/users/ disable**156 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find** 574 574 ))) 575 575 576 -Метод апозволяетвыполнитьмассовуюблокировкупользователей(% style="color:#000000"%)(обязательный параметрв заголовкахзапроса-токенвторизации**«__X-Auth__»**).159 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 577 577 578 -(% style="color:#000000" %)Метод запроса :(%style="color:#000000;line-height:100%"%)**POST**161 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 579 579 580 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]163 +(% style="color:#000000" %)Метод запроса: **POST** 581 581 582 -(% style="color:#000000" %) В телезапросаперечисляете массив id пользователей(JSON):165 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 583 583 584 - [ 585 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 586 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 587 - ] 167 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 588 588 589 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 169 +(% class="western" %) 170 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 171 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 172 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 173 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 590 590 591 - ==(% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==175 +(% style="color:#000000" %)} 592 592 593 -(% class="box warningmessage" %) 177 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 178 + 179 +(% class="western" style="margin-bottom:19px" %) 180 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 181 + 182 +(% lang="en-US" style="text-align:left" %) 183 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 184 + 185 + 186 +(% class="box errormessage" %) 594 594 ((( 595 -** POST /api/v3/users/enable**188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 596 596 ))) 597 597 598 -Метод апозволяетвыполнитьмассовую разблокировку пользователей (%style="color:#000000"%)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 599 599 600 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**193 +(% style="color:#000000" %)Метод запроса: **DELETE** 601 601 602 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/ enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]195 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 603 603 604 -(% style="color:#000000" %) В телезапросаперечисляетемассивid пользователей(JSON):197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 605 605 606 - [ 607 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 608 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 609 - ] 199 +(% style="text-align:left" %) 200 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 610 610 611 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 612 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 613 613 203 +(% class="box" style="text-align: center;" %) 614 614 ((( 615 -В теле ответа: 616 -{ 617 - "errorMessages": [ 618 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 619 - ], 620 - "users": [ 621 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 622 - ] 623 -} 624 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 625 -"users" - массив id пользователей, которых не удалось включить или отключить. 205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 626 626 ))) 627 627 628 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 629 - 630 630 (% class="box errormessage" %) 631 631 ((( 632 -(% lang="en-US" %)**DELETE /api/v3/ users/{id}**210 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 633 633 ))) 634 634 635 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанногов строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).213 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 636 636 637 637 (% style="color:#000000" %)Метод запроса: **DELETE** 638 638 639 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}217 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 640 640 641 -(% style="color:#000000" %)Параметр запроса: { **__id__**} - Guidпользователя219 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 642 642 643 643 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 644 644 ... ... @@ -645,74 +645,51 @@ 645 645 (% style="text-align:left" %) 646 646 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 647 647 648 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 649 649 650 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 651 - 652 652 (% class="box infomessage" %) 653 653 ((( 654 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 229 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 655 655 ))) 656 656 657 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 232 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 658 658 659 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):234 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 660 660 661 661 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 662 662 663 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **« __Просмотр заданий на техобслуживание__»**.238 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 664 664 665 665 (% style="color:#000000" %)Метод запроса: **GET** 666 666 667 667 (% 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> 668 668 669 -(% style="color:#000000" %)Параметр запроса: < __**vehicleid**__> - идентификатор объекта (опционально)244 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 670 670 671 671 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 672 672 673 673 (% style="color:#000000" %)Ответ: 674 674 675 -((( 676 -{ 677 - "vehicleId": "", ~/~/ ID объекта 678 - "name": "", ~/~/ Имя объекта 679 - "imei": "", ~/~/ IMEI объекта 680 - "deviceTypeId": , ~/~/ ID типа устройства 681 - "deviceTypeName": "", ~/~/ Название типа устройства 682 - "sim1": "", ~/~/ Номер SIM1 683 - "parentId": "", Номер SIM2 684 - "parentName": "", Наименование клиента-родителя 685 - "modelId": "", ID модели объекта 686 - "modelName": "", Имя модели объекта 687 - "createdAt": "", Дата создания объекта 688 - "mileageCalcMethod": "", Выбранный метод расчета пробега 689 - "counters": { ~/~/ Нормы 690 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 691 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 692 - "mileage": "", ~/~/ Пробег по нормам в метрах 693 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 694 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 695 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 696 - }, 697 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 698 - { 699 - "id": "", ~/~/ ID задания 700 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 701 - "name": "", ~/~/ Наименование задания 702 - "description": "", ~/~/ Описание задания 703 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 704 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 705 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 706 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 707 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 708 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 709 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 710 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 711 - } 712 - ] 713 -} 714 -))) 250 +(% style="color:#000000" %){ 715 715 252 +(% class="western" %) 253 +{{{ "vehicleId": “”, // идентификатор объекта 254 + "name": "", // имя объекта 255 + "imei": "", // IMEI объекта 256 + "deviceTypeId": “”, // идентификатор устройства объекта 257 + "deviceTypeName": "" // наименование устройства объекта 258 + "parentId": "", // идентификатор клиента-родителя 259 + "parentName": "" // наименование клиента-родителя, 260 + "modelId": "", // идентификатор модели объекта 261 + "modelName": "" // наименование модели объекта, 262 + "unitId": "", // идентификатор подразделения 263 + "unitName": "", // наименование подразделения 264 + "status": “”, // статус объекта 265 + ... 266 + }, 267 + ...}}} 268 + 269 +(% style="color:#000000" %)} 270 + 716 716 (% style="text-align:left" %) 717 717 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 718 718 ... ... @@ -719,14 +719,13 @@ 719 719 (% style="text-align:left" %) 720 720 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 721 721 722 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 723 723 724 724 (% class="box successmessage" %) 725 725 ((( 726 -(% lang="en-US" %)**POST /api/v3/vehicles** 280 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 727 727 ))) 728 728 729 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**, //Content-Type//:__**application/json**__; //charset//=__**utf-8**__).283 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 730 730 731 731 (% style="color:#000000" %)Метод запроса: **POST** 732 732 ... ... @@ -734,131 +734,141 @@ 734 734 735 735 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 736 736 737 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 291 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 738 738 739 -(% style="color:#000000" %){ 740 - 741 - "parentId": "" , ~/~/ ID клиента 742 - "name": "" , ~/~/ имя ТС 743 - "imei": "" , ~/~/ IMEI 744 - "deviceTypeId": "" , ~/~/ ID типа устройства 745 - "modelId": "" , ~/~/ ID модели 746 - "unitId": "" , ~/~/ ID подразделения 747 - "sim1": "" , ~/~/ Номер SIM 1 748 - "sim2": "" , ~/~/ Номер SIM2 749 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 750 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 751 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 752 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 753 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 754 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 755 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 756 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 757 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 758 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 759 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 760 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 761 - "counters": ~/~/ счетчики 762 - { 763 - "mileage": "" , ~/~/ пробег 764 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 765 - "motohours": "" , ~/~/ моточасы 766 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 293 +(% class="western" %) 294 +{{{ "parentId": "", // ID клиента 295 + "name": "", // имя ТС 296 + "imei": "", // IMEI 297 + "deviceTypeId": "",// ID типа устройства 298 + "modelId": "", 299 + "unitId": "", // ID подразделения 300 + "sim1": "", // Номер SIM 1 301 + "sim2": "", // Номер SIM2 302 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 303 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 304 + "consumptionIdle": "",// Расход топлива на холостом ходу 305 + "counters": { 306 + "mileage": "", // пробег 307 + "mileageEnabled": true, // флаг активности счётчика "пробег" 308 + "motohours":"", // моточасы 309 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 310 + }, 311 + "cmsv6Parameters": { // параметры CMSv6 312 + "enabled": true, // флаг включения 313 + //"id": "", // идентификатор 314 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 315 + "login": "", // имя учетной записи 316 + "password": "" // пароль учетной записи 767 767 }, 768 - "cmsv6Parameters": { ~/~/ параметры CMSv6 769 - "enabled": true, ~/~/ флаг включения 770 - "id": "" , ~/~/ идентификатор 771 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 772 - "login": "" , ~/~/ имя учетной записи 773 - "password": "" ~/~/ пароль учетной записи 774 - }, 775 - "inspectionTasks": ~/~/ задания на ТО 318 + "inspectionTasks": [ // задания на ТО 776 776 { 777 - "enabled": "" , ~/~/ Признак включения 778 - "name": "" , ~/~/ Имя задания 779 - "description": "" , ~/~/ Описание задания 780 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 781 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 782 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 783 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 784 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 785 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 786 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 787 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 788 - } 320 + "enabled": "", // Признак включения 321 + "name": "", // Имя задания 322 + "description": "", // Описание задания 323 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 324 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 325 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 326 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 327 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 328 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 329 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 330 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 331 + }, 332 + ]}}} 789 789 790 -(% style="color:#000000" %) } 334 +(% style="color:#000000" %)… } 791 791 792 792 (% style="color:#000000" %)Ответ: 793 793 794 794 (% style="color:#000000" %){ 795 795 796 - "vehicleId": "", ~/~/ID ТС 797 - "parentId": "", ~/~/Guid владельца ТС 798 - "name": "", ~/~/Имя объекта 799 - "imei": "", ~/~/IMEI 800 - "deviceTypeId": "", ~/~/ID типа устройства 801 - "modelId": "", ~/~/ID модели 802 - "unitId": "", ~/~/ID подразделения 803 - "sim1": "", ~/~/SIM1 804 - "sim2": "", ~/~/SIM2 805 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 806 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 807 - "counters": { ~/~/Счётчики 808 - "mileageEnabled": true, 809 - "motohoursEnabled": true, 810 - "mileage": "", 811 - "motohours": 345.0 812 - }, 813 - "cmsv6Parameters": { ~/~/Параметры CmsV6 814 - "id": null, 815 - "enabled": true, ~/~/флаг включения 816 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 817 - "login": "", ~/~/ имя учетной записи 818 - "password": "" ~/~/ пароль учетной записи 819 - }, 820 - "inspectionTasks": { ~/~/ задания на ТО 821 - "id": "", ~/~/ ID задачи 822 - "enabled": false, ~/~/ Признак включения 823 - "name": "", ~/~/ Имя задания 824 - "description": "", ~/~/ Описание задания 825 - "mileageCondition": "", ~/~/ Условие по пробегу 826 - "lastMileage": "", ~/~/ Пробег (в метрах) 827 - "motohoursCondition": "", ~/~/ Условие по моточасам 828 - "lastMotohours": "", ~/~/ Моточасы 829 - "periodicCondition": "", ~/~/ Условие периодичности по времени 830 - "kind": "", ~/~/ Вид периодичности по времени 831 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 832 - } 340 +(% class="western" %) 341 +{{{ "vehicleId": "", //ID ТС 342 + "parentId": "", //Guid владельца ТС 343 + "name": "", //Имя объекта 344 + "imei": "", //IMEI 345 + "deviceTypeId": "", //ID типа устройства 346 + "modelId": "", //ID модели 347 + "unitId": "", //ID подразделения 348 + "sim1": "", //SIM1 349 + "sim2": "", //SIM2 350 + "consumptionPer100Km": "", //Расход топлива на 100 км 351 + "consumptionIdle": "", //Расход топлива на холостом ходу 352 + "counters": { //Счётчики 353 + "mileageEnabled": true, 354 + "motohoursEnabled": true, 355 + "mileage": "", 356 + "motohours": 345.0 357 + }, 358 + "cmsv6Parameters": { //Параметры CmsV6 359 + "id": null, 360 + "enabled": true, //флаг включения 361 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 362 + "login": "", // имя учетной записи 363 + "password": "" // пароль учетной записи 364 + }, 365 + "inspectionTasks": [ // задания на ТО 366 + { 367 + "id": "", // ID задачи 368 + "enabled": false, // Признак включения 369 + "name": "", // Имя задания 370 + "description": "", // Описание задания 371 + "mileageCondition": "", // Условие по пробегу 372 + "lastMileage": "", // Пробег (в метрах) 373 + "motohoursCondition": "", // Условие по моточасам 374 + "lastMotohours": "", // Моточасы 375 + "periodicCondition": "", // Условие периодичности по времени 376 + "kind": "", // Вид периодичности по времени 377 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 378 + } 379 + ]}}} 833 833 834 834 (% style="text-align:left" %) 835 835 (% style="color:#000000" %)} 836 836 837 -**Валидация:** 838 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 839 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 840 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 841 841 842 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 385 +(% class="box warningmessage" %) 386 +((( 387 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 388 +))) 843 843 844 -(% class="box infomessage" %) 390 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 391 + 392 +(% style="color:#000000" %)Метод запроса: **PUT** 393 + 394 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 395 + 396 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 397 + 398 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 399 + 400 +(% 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»: «» //Сколько раз выполнить задание } ] } 401 + 402 +(% style="color:#000000" %)Ответ: 403 + 404 +(% lang="en-US" style="text-align:left" %) 405 +(% 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»: «» //Сколько раз выполнить задание } ] } 406 + 407 + 408 +(% class="box successmessage" %) 845 845 ((( 846 -(% lang="en-US" %)**POST /api/v3/vehicles /find**410 +(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles** 847 847 ))) 848 848 849 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 413 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 850 850 851 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**):415 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 852 852 853 853 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 854 854 855 855 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 856 856 857 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;421 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 858 858 859 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;423 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 860 860 861 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.425 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 862 862 863 863 (% style="color:#000000" %)Метод запроса: **POST** 864 864 ... ... @@ -866,266 +866,108 @@ 866 866 867 867 (% style="color:#000000" %)В заголовках запроса: 868 868 869 -(% style="color:#000000" %)− Content-Type: __**application/json**__433 +(% style="color:#000000" %)− Content-Type: application/json 870 870 871 871 (% style="color:#000000" %)− X-Auth: Токен авторизации 872 872 873 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 437 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 874 874 875 -(% style="color:#000000" %) Параметрывтелезапроса (JSON):439 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 876 876 877 -{ 878 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 879 - "name": null, ~/~/ Имя ТС (string, опционально) 880 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 881 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 882 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 883 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 884 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 885 - "customFields": null ~/~/ значение любого из произвольных полей ТС 886 -} 441 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 887 887 888 -(% style="color:#000000" %) Фильтрацияосуществляетсяпоточному совпадению значений параметров«__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__»,«__**unitId**__»,ипочастичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра«__**sim**__»осуществляетсяприналичии у авторизованного пользователя права **«__Просмотрномеровтелефоновобъектов__»**.443 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 889 889 890 -(% style="color:#000000" %) Ответ:445 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 891 891 892 -(% style="color:#000000" %) {447 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 893 893 894 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 895 - "name": "" ~/~/ наименование объекта 896 - "imei": "" ~/~/ IMEI объекта 897 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 898 - "deviceTypeName": "" ~/~/ наименование типа устройства 899 - "sim1": "" ~/~/ первый номер телефона 900 - "sim2": "" ~/~/ второй номер телефона 901 - "parentId": "" ~/~/ идентификатор клиента-родителя 902 - "parentName": "" ~/~/ наименование клиента-родителя 903 - "modelId": "" ~/~/ идентификатор модели объекта 904 - "modelName": "" ~/~/ наименование модели объекта 905 - "unitId": "" ~/~/ идентификатор подразделения 906 - "unitName": "" ~/~/ наименование подразделения 907 - "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 908 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 909 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 910 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 911 - "customFields": [ 912 - { 913 - "id": "", ~/~/ идентификатор произвольного поля 914 - "name": "", ~/~/ имя произвольного поля 915 - "value": "", ~/~/ значение произвольного поля 916 - "forClient": true, ~/~/ право на отображение у клиента 917 - "forTooltip": false, ~/~/ право на отображение в подсказке 918 - "forReport": false ~/~/ право на отображение в отчетах 919 - }(%%) 920 -(% style="color:#000000" %)} 449 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 921 921 922 -(% style="color:#000000" %) Параметры « __**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.451 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 923 923 924 - ==(% style="color:#000000; font-size:16px" %)**Изменениестатусаобъекта**(%%) ==453 +(% style="color:#000000" %)0 - «Блокировка» 925 925 926 -(% class="box successmessage" %) 927 -((( 928 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 929 -))) 455 +(% style="color:#000000" %)1 - «Активен», 930 930 931 -(% style="color:#000000" %) Методпозволяетизменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).457 +(% style="color:#000000" %)2 - «Отменен» 932 932 933 -(% style="color:#000000" %) Методзапроса: **POST**459 +(% style="color:#000000" %)3 - «Оборудован» 934 934 935 -(% 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}461 +(% style="color:#000000" %)4 - «Диагностика» 936 936 937 -(% style="color:#000000" %) Параметрзапроса: {__**vehicleId**__}-ID ТС463 +(% style="color:#000000" %)5 - «Сервис» 938 938 939 -(% style="color:#000000" %) Взаголовках запроса: X-Auth:Токенавторизации465 +(% style="color:#000000" %)6 - «Демонтаж» 940 940 941 -(% style="color:#000000" %) Параметрывтеле запроса (JSON):467 +(% style="color:#000000" %)7 - «Монтаж» 942 942 943 -(% style="color:#000000" %) {469 +(% style="color:#000000" %)8 - «Дозаказ» 944 944 945 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 946 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 947 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 948 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 949 - "description": "", ~/~/ Описание 950 - "data": "", ~/~/ Данные 951 - "overwrite": false, ~/~/ Флаг перезаписи 952 - "stage": "", ~/~/ Состояние, может быть null 471 +(% style="color:#000000" %)9 - «Обслужен» 953 953 954 -(% style="color:#000000" %) }473 +(% style="color:#000000" %)10 - «Списан» 955 955 956 -(% style="color:#000000" %) Ответ:475 +(% style="color:#000000" %)11 - «Неисправен» 957 957 958 -(% style="color:#000000" %) {477 +(% style="color:#000000" %)12 - «Проверен» 959 959 960 - "status": "", ~/~/ значение статуса 961 - "date": "", ~/~/ Дата смены статуса 962 - "description": "", ~/~/ Описание 963 - "data": "", ~/~/ Данные 964 - "overwrite": false, ~/~/ Флаг перезаписи 965 - "stage": "", ~/~/ Состояние 966 - 967 967 (% style="text-align:left" %) 968 -(% style="color:#000000" %) }480 +(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется» 969 969 970 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 971 971 972 -(% class="box warningmessage" %)483 +(% class="box successmessage" %) 973 973 ((( 974 -(% lang="en-US" %)**P UT /api/v3/vehicles**485 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 975 975 ))) 976 976 977 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяетотредактировать объект, указанныйв запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).488 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 978 978 979 -(% style="color:#000000" %)Метод запроса: **P UT**490 +(% style="color:#000000" %)Метод запроса: **POST** 980 980 981 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 492 +(% 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} 982 982 494 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 495 + 983 983 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 984 984 985 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 498 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 986 986 987 -(% style="color:#000000" %){ 500 +(% class="western" %) 501 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 502 + "date": "", // Дата смены статуса (null если сменить немедленно) 503 + "description": "", // Описание 504 + "data": "", // Данные 505 + "overwrite": false, // Флаг перезаписи 506 + "stage": "", // Состояние, может быть null}}} 988 988 989 -((( 990 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 991 - "parentId": "", ~/~/ ID клиента 992 - "name": "", ~/~/ имя ТС 993 - "imei": "", ~/~/ IMEI 994 - "deviceTypeId": "", ~/~/ ID типа устройства 995 - "modelId": "", ~/~/ , ID модели 996 - "unitId": "", ~/~/ подразделения 997 - "sim1": "", ~/~/ SIM 1 998 - "sim2": "", ~/~/ SIM2 (%%) 999 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1000 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1001 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1002 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1003 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1004 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1005 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1006 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1007 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1008 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1009 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1010 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1011 -(% style="color:#000000" %) "counters": 1012 - { 1013 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1014 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1015 - "mileage": "", ~/~/ пробег, в метрах 1016 - "motohours": "" ~/~/ моточасы, в секундах 1017 - } 1018 - "cmsv6Parameters": ~/~/ параметры CMSv6 1019 - { 1020 - "id": "", ~/~/ идентификатор 1021 - "enabled": true, ~/~/ флаг включения 1022 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1023 - "login": "", ~/~/ имя учетной записи 1024 - "password": "", ~/~/ пароль учетной записи 1025 - } 1026 - "inspectionTasks": ~/~/ задания на ТО 1027 - { 1028 - "id": "", ~/~/ ID задания 1029 - "enabled": false, ~/~/ Признак включения 1030 - "name": "", ~/~/ Имя задания 1031 - "description": "", ~/~/ Описание задания 1032 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1033 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1034 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1035 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1036 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1037 - "kind": "", ~/~/ Вид периодичности по времени 1038 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1039 - } 1040 -))) 1041 - 1042 1042 (% style="color:#000000" %)} 1043 1043 1044 -(% style="color:#000000" %)Ответ: 510 +(% style="color:#000000" %)Ответ: { 1045 1045 1046 -(% lang="en-US" style="text-align:left" %) 1047 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 512 +(% class="western" %) 513 +{{{ "status": "", // значение статуса 514 + "date": "", // Дата смены статуса 515 + "description": "", // Описание 516 + "data": "", // Данные 517 + "overwrite": false, // Флаг перезаписи 518 + "stage": "", // Состояние}}} 1048 1048 1049 -(% lang="en-US" style="text-align:left" %) 1050 - "vehicleId": "", ~/~/ ID ТС 1051 - "parentId": "", ~/~/ ID клиента 1052 - "name": "", ~/~/ имя ТС 1053 - "imei": "", ~/~/ IMEI 1054 - "deviceTypeId": "", ~/~/ типа устройства 1055 - "modelId": "", ~/~/ ID модели 1056 - "unitId": "", ~/~/ ID подразделения 1057 - "sim1": "", ~/~/ SIM 1 1058 - "sim2": "", ~/~/ SIM2 1059 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1060 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1061 - "counters": 1062 - { 1063 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1064 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1065 - "mileage": "", ~/~/ пробег 1066 - "motohours": "", ~/~/ моточасы 1067 - } 1068 - "cmsv6Parameters": ~/~/ параметры CMSv6 1069 - { 1070 - "id": ~/~/ идентификатор 1071 - "enabled": true, ~/~/ флаг включения 1072 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1073 - "login": "", ~/~/ имя учетной записи 1074 - "password": "", ~/~/ пароль учетной записи 1075 - } 1076 - "inspectionTasks": ~/~/ задания на ТО 1077 - { 1078 - "id": "", ~/~/ ID задания 1079 - "enabled": false, ~/~/ Признак включения 1080 - "name": "", ~/~/ Имя задания 1081 - "description": "", ~/~/ Описание задания 1082 - "mileageCondition": "", ~/~/ Условие по пробегу 1083 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1084 - "motohoursCondition": "", ~/~/ Условие по моточасам 1085 - "lastMotohours": "", ~/~/ Моточасы 1086 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1087 - "kind": "", ~/~/ Вид периодичности по времени 1088 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1089 - } 520 +(% style="text-align:left" %) 521 +(% style="color:#000000" %)} 1090 1090 1091 -(% lang="en-US" style="text-align:left" %) 1092 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1093 1093 1094 -**валидация:** 1095 -- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1096 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1097 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1098 - 1099 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 1100 - 1101 -(% class="box errormessage" %) 524 +(% class="box" lang="en-US" style="text-align: center;" %) 1102 1102 ((( 1103 -(% l ang="en-US" %)**DELETE/api/v3/vehicles/{vehicleId}**526 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 1104 1104 ))) 1105 1105 1106 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1107 - 1108 -(% style="color:#000000" %)Метод запроса: **DELETE** 1109 - 1110 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 1111 - 1112 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1113 - 1114 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1115 - 1116 -(% style="text-align:left" %) 1117 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 1118 - 1119 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 1120 - 1121 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1122 - 1123 1123 (% class="box infomessage" %) 1124 1124 ((( 1125 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 531 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 1126 1126 ))) 1127 1127 1128 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).534 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1129 1129 1130 1130 (% style="color:#000000" %)Метод запроса: **GET** 1131 1131 ... ... @@ -1133,86 +1133,51 @@ 1133 1133 1134 1134 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1135 1135 1136 -(% style="color:#000000" %)Ответ: 542 +(% style="color:#000000" %)Ответ: [ 1137 1137 1138 -(% style="color:#000000" %){ 544 +(% class="western" %) 545 +{{{ { 546 + "deviceTypeId" : "", // ID типа устройства 547 + "deviceTypeName" : "" // Название типа устройства 548 + },}}} 1139 1139 1140 - "deviceTypeId" : "", ~/~/ ID типа устройства 1141 - "deviceTypeName" : "" ~/~/ Название типа устройства 1142 - 1143 1143 (% style="text-align:left" %) 1144 -(% style="color:#000000" %) }551 +(% style="color:#000000" %)…** **] 1145 1145 1146 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1147 1147 1148 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 554 +(% class="box" style="text-align: center;" %) 555 +((( 556 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 557 +))) 1149 1149 1150 1150 (% class="box infomessage" %) 1151 1151 ((( 1152 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 561 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 1153 1153 ))) 1154 1154 1155 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **« __X-Auth__»**).564 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 1156 1156 1157 1157 (% style="color:#000000" %)Метод запроса: **GET** 1158 1158 1159 1159 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1160 1160 1161 -(% style="color:#000000" %)В заголовках запроса: 570 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1162 1162 1163 -(% style="color:#000000" %)Ответ: 572 +(% style="color:#000000" %)Ответ: [ 1164 1164 1165 -(% style="color:#000000" %){ 574 +(% class="western" style="margin-bottom:19px" %) 575 +{{{ {}}} 1166 1166 1167 - "id": "", ~/~/ ID типа датчика 1168 - "name": "", ~/~/ Название 1169 - "description": "", ~/~/ Описание 577 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1170 1170 579 +(% class="western" %) 580 +{{{ "description": "" // Описание 581 + },}}} 582 + 1171 1171 (% style="text-align:left" %) 1172 -(% style="color:#000000" %) }584 +(% style="color:#000000" %)… ] 1173 1173 1174 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 1175 1175 1176 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1177 - 1178 -(% class="box infomessage" style="text-align: left;" %) 1179 -((( 1180 -**POST /api/v3/terminalMessages/count** 1181 -))) 1182 - 1183 -(% style="text-align: left;" %) 1184 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1185 - 1186 -(% style="text-align: left;" %) 1187 -Метод запроса **POST** 1188 - 1189 -(% style="text-align: left;" %) 1190 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1191 - 1192 -(% style="text-align: left;" %) 1193 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1194 - 1195 -(% style="text-align: left;" %) 1196 -{ 1197 - "vehicleIds": [ 1198 - id ~/~/ здесь передается список идентификаторов объектов 1199 - ], 1200 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1201 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1202 -} 1203 - 1204 -(% style="text-align: left;" %) 1205 -Ответ: 1206 - 1207 -(% style="text-align: left;" %) 1208 -[ 1209 - { 1210 - "vehicleId": 0, ~/~/ идентификатор объекта 1211 - "count": 0 ~/~/ количество сообщений за период 1212 - } 1213 -] 1214 - 1215 - 1216 1216 (% class="box" lang="en-US" style="text-align: center;" %) 1217 1217 ((( 1218 1218 (% 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]] **