Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1,31 +1,31 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API 3.0 == 3 - 4 -== == 5 - 6 -(% class="box" style="text-align: center;" %) 7 7 ((( 8 - (% style="color:#000000; font-size:18.6667px" %)**Действующиеограничения**3 +**Содержание страницы:** 9 9 ))) 10 10 11 - (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).6 +{{toc/}} 12 12 8 + 9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) = 10 + 11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 + 13 13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 - 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 22 22 23 -(% class="box successmessage" %) 19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 + 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 + 23 +(% class="box infomessage" %) 24 24 ((( 25 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 30 (% style="color:#000000" %)Метод запроса: **POST** 31 31 ... ... @@ -38,9 +38,9 @@ 38 38 (% style="color:#000000" %){ 39 39 "login": "testuser", 40 40 "password": "testuser" 41 -}(%%) 42 - 41 +} 43 43 43 + 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,13 +55,14 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 58 58 59 59 (% class="box infomessage" %) 60 60 ((( 61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**62 +(% lang="en-US" %)**GET /api/v3/auth/check** 62 62 ))) 63 63 64 -(% style="color:#000000" %) 65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 65 65 66 66 (% style="color:#000000" %)Метод запроса: **GET** 67 67 ... ... @@ -72,18 +72,58 @@ 72 72 (% lang="en-US" %) 73 73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 74 74 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 75 75 76 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 77 77 ((( 78 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 79 79 ))) 80 80 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 + 81 81 (% class="box infomessage" %) 82 82 ((( 83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 84 84 ))) 85 85 86 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 87 87 88 88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 89 89 ... ... @@ -91,37 +91,184 @@ 91 91 92 92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 93 93 94 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 95 95 96 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 97 97 98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 99 99 100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 101 101 102 102 (% style="color:#000000" %)Ответ: 103 103 104 -(% style="color:#000000" %){ 105 - "agentId": "", ~/~/ идентификатор клиента 106 - "parentId": "", ~/~/ идентификатор клиента-родителя 107 - "name": "", ~/~/ наименование клиента 108 - "fullName": "", ~/~/ полное наименование клиента 109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 111 111 } 112 112 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 113 113 114 -(% class="box "style="text-align: center;" %)159 +(% class="box successmessage" %) 115 115 ((( 116 - (%style="color:#000000; font-size:14pt"%)**Раздел Пользователи**161 +**POST /api/v3/agents ** 117 117 ))) 118 118 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 + 119 119 (% class="box successmessage" %) 120 120 ((( 121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 122 122 ))) 123 123 124 -(% style="color:#000000" %) 312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 125 125 126 126 (% style="color:#000000" %)Метод запроса: **POST** 127 127 ... ... @@ -137,9 +137,9 @@ 137 137 "position": "", ~/~/ должность 138 138 "phone": "", ~/~/ телефон 139 139 "organization": "", ~/~/ организация 140 - "login": "", ~/~/ логин 141 - "password": "", ~/~/ пароль ( при добавлении - обязателен, при редактировании, если null - менять пароль не надо)142 - "email": "", ~/~/ email 328 + "login": "", ~/~/ логин (обязателен) 329 + "password": "", ~/~/ пароль (обязателен) 330 + "email": "", ~/~/ email (обязателен) 143 143 "description": "", ~/~/ описание 144 144 "isEnabled": "", ~/~/ признак включения 145 145 "parentId": "", ~/~/ Guid родительского агента ... ... @@ -148,7 +148,7 @@ 148 148 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 149 149 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 150 150 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 151 - "groups": 339 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 152 152 } 153 153 154 154 (% style="text-align:left" %) ... ... @@ -174,18 +174,19 @@ 174 174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 175 175 "kind": "" , ~/~/ тип аутентификации 176 176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 177 - "groups": группы пользователя,«user»названия группыпользователя365 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 178 178 179 179 (% style="text-align:left" %) 180 180 (% style="color:#000000; font-weight:normal" %)} 181 181 370 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 182 182 183 -(% class="box successmessage" %)372 +(% class="box infomessage" %) 184 184 ((( 185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**374 +(% lang="en-US" %)**POST /api/v3/users/find** 186 186 ))) 187 187 188 -(% style="color:#000000" %) 377 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 189 189 190 190 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 191 191 ... ... @@ -226,13 +226,66 @@ 226 226 227 227 (% style="color:#000000" %)} 228 228 418 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 229 229 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": 453 + { 454 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 455 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 456 + }, 457 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 458 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 459 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 460 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 461 + "groups": [], ~/~/ Список ролей пользователя 462 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 463 + "authDevices": [ ], ~/~/ Список авторизованных устройств 464 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 465 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 466 +} 467 +))) 468 +))) 469 + 470 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 471 + 230 230 (% class="box warningmessage" %) 231 231 ((( 232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**474 +(% lang="en-US" %)**PUT /api/v3/users** 233 233 ))) 234 234 235 -(% style="color:#000000" %) 477 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 236 236 237 237 (% style="color:#000000" %)Метод запроса: **PUT** 238 238 ... ... @@ -253,17 +253,22 @@ 253 253 "position": "" , ~/~/ должность 254 254 "phone": "" , ~/~/ телефон 255 255 "organization": "" , ~/~/ организация 256 - "login": "" , ~/~/ логин 257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 258 - "email": "" , ~/~/ email 259 - "description": "" , ~/~/ описание 498 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 499 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 500 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 501 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 502 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 503 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 260 260 "isEnabled": "" , ~/~/ признак включения 261 261 "parentId": "" , ~/~/ Guid родительского агента 262 262 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 263 263 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 265 - "kind": "" , ~/~/ тип аутентификации 266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 508 + "doubleAuth": 509 + { 510 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 511 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 512 + }, 513 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 267 267 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 268 268 269 269 (% lang="en-US" style="text-align:left" %) ... ... @@ -289,8 +289,12 @@ 289 289 "isEnabled": "" , ~/~/ признак включения 290 290 "parentId": "" , ~/~/ Guid родительского агента 291 291 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 293 - "kind": "" , ~/~/ тип аутентификации 539 + "doubleAuth": 540 + { 541 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 542 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 543 + }, 544 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 294 294 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 295 295 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 296 296 ... ... @@ -297,13 +297,14 @@ 297 297 (% lang="en-US" style="text-align:left" %) 298 298 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 299 299 551 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 300 300 301 301 (% class="box warningmessage" %) 302 302 ((( 303 -(% style="color:#000000" %) **Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**555 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 304 304 ))) 305 305 306 -(% style="color:#000000" %) 558 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 307 307 308 308 (% style="color:#000000" %)Метод запроса: **PUT** 309 309 ... ... @@ -326,10 +326,11 @@ 326 326 (% style="text-align:left" %) 327 327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 328 328 581 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 329 329 330 330 (% class="box warningmessage" %) 331 331 ((( 332 -** Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/disable**585 +**POST /api/v3/users/disable** 333 333 ))) 334 334 335 335 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -347,10 +347,11 @@ 347 347 348 348 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 349 349 603 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 350 350 351 351 (% class="box warningmessage" %) 352 352 ((( 353 -** Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**—POST /api/v3/users/enable**607 +**POST /api/v3/users/enable** 354 354 ))) 355 355 356 356 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). ... ... @@ -366,15 +366,31 @@ 366 366 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 367 367 ] 368 368 369 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 623 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 624 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 370 370 626 +((( 627 +В теле ответа: 628 +{ 629 + "errorMessages": [ 630 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 631 + ], 632 + "users": [ 633 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 634 + ] 635 +} 636 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 637 +"users" - массив id пользователей, которых не удалось включить или отключить. 638 +))) 371 371 640 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 641 + 372 372 (% class="box errormessage" %) 373 373 ((( 374 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**644 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 375 375 ))) 376 376 377 -(% style="color:#000000" %) 647 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 378 378 379 379 (% style="color:#000000" %)Метод запроса: **DELETE** 380 380 ... ... @@ -387,20 +387,18 @@ 387 387 (% style="text-align:left" %) 388 388 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 389 389 660 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 390 390 391 -(% class="box" style="text-align: center;" %) 392 -((( 393 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 394 -))) 662 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 395 395 396 396 (% class="box infomessage" %) 397 397 ((( 398 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**666 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 399 399 ))) 400 400 401 -(% style="color:#000000" %) 669 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 402 402 403 -(% style="color:#000000" %) 671 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 404 404 405 405 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 406 406 ... ... @@ -416,22 +416,46 @@ 416 416 417 417 (% style="color:#000000" %)Ответ: 418 418 419 -(% style="color:#000000" %){ 420 - 421 - "vehicleId": "" , ~/~/ идентификатор объекта 422 - "name": "" , ~/~/ имя объекта 423 - "imei": "" , ~/~/ IMEI объекта 424 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 425 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 426 - "parentId": "" , ~/~/ идентификатор клиента-родителя 427 - "parentName": "" , ~/~/ наименование клиента-родителя, 428 - "modelId": "" , ~/~/ идентификатор модели объекта 429 - "modelName": "" , ~/~/ наименование модели объекта, 430 - "unitId": "" , ~/~/ идентификатор подразделения 431 - "unitName": "" , ~/~/ наименование подразделения 432 - "status": "" , ~/~/ статус объекта 433 - 687 +((( 688 +{ 689 + "vehicleId": "", ~/~/ ID объекта 690 + "name": "", ~/~/ Имя объекта 691 + "imei": "", ~/~/ IMEI объекта 692 + "deviceTypeId": , ~/~/ ID типа устройства 693 + "deviceTypeName": "", ~/~/ Название типа устройства 694 + "sim1": "", ~/~/ Номер SIM1 695 + "parentId": "", Номер SIM2 696 + "parentName": "", Наименование клиента-родителя 697 + "modelId": "", ID модели объекта 698 + "modelName": "", Имя модели объекта 699 + "createdAt": "", Дата создания объекта 700 + "mileageCalcMethod": "", Выбранный метод расчета пробега 701 + "counters": { ~/~/ Нормы 702 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 703 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 704 + "mileage": "", ~/~/ Пробег по нормам в метрах 705 + "motohours": "" ~/~/ Моточасы по нормам, в секундах 706 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 707 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 708 + }, 709 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 710 + { 711 + "id": "", ~/~/ ID задания 712 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 713 + "name": "", ~/~/ Наименование задания 714 + "description": "", ~/~/ Описание задания 715 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 716 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 717 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 718 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 719 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 720 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 721 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 722 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 723 + } 724 + ] 434 434 } 726 +))) 435 435 436 436 (% style="text-align:left" %) 437 437 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -439,13 +439,14 @@ 439 439 (% style="text-align:left" %) 440 440 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 441 441 734 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 442 442 443 443 (% class="box successmessage" %) 444 444 ((( 445 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**738 +(% lang="en-US" %)**POST /api/v3/vehicles** 446 446 ))) 447 447 448 -(% style="color:#000000" %) 741 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 449 449 450 450 (% style="color:#000000" %)Метод запроса: **POST** 451 451 ... ... @@ -558,15 +558,16 @@ 558 558 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 559 559 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 560 560 854 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 561 561 562 -(% class="box successmessage" %)856 +(% class="box infomessage" %) 563 563 ((( 564 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**858 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 565 565 ))) 566 566 567 -(% style="color:#000000" %) 861 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 568 568 569 -(% style="color:#000000" %) 863 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 570 570 571 571 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 572 572 ... ... @@ -592,19 +592,19 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% class="western" style="color:#000000" %)##{## 889 +{ 890 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 891 + "name": null, ~/~/ Имя ТС (string, опционально) 892 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 893 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 894 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 895 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 896 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 897 + "customFields": null ~/~/ значение любого из произвольных полей ТС 898 +} 596 596 597 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 598 - "name": null, ~/~/ Имя ТС (string, опционально) 599 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 600 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 601 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 602 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 603 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 604 -(% style="color:#000000" %)} 900 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 605 605 606 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 607 - 608 608 (% style="color:#000000" %)Ответ: 609 609 610 610 (% style="color:#000000" %){ ... ... @@ -625,18 +625,28 @@ 625 625 "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 626 626 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 627 627 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 628 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%) 922 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 923 + "customFields": [ 924 + { 925 + "id": "", ~/~/ идентификатор произвольного поля 926 + "name": "", ~/~/ имя произвольного поля 927 + "value": "", ~/~/ значение произвольного поля 928 + "forClient": true, ~/~/ право на отображение у клиента 929 + "forTooltip": false, ~/~/ право на отображение в подсказке 930 + "forReport": false ~/~/ право на отображение в отчетах 931 + }(%%) 629 629 (% style="color:#000000" %)} 630 630 631 631 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 632 632 936 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 633 633 634 634 (% class="box successmessage" %) 635 635 ((( 636 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**940 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 637 637 ))) 638 638 639 -(% style="color:#000000" %) 943 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 640 640 641 641 (% style="color:#000000" %)Метод запроса: **POST** 642 642 ... ... @@ -675,13 +675,14 @@ 675 675 (% style="text-align:left" %) 676 676 (% style="color:#000000" %) } 677 677 982 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 678 678 679 679 (% class="box warningmessage" %) 680 680 ((( 681 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**986 +(% lang="en-US" %)**PUT /api/v3/vehicles** 682 682 ))) 683 683 684 -(% style="color:#000000" %) 989 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 685 685 686 686 (% style="color:#000000" %)Метод запроса: **PUT** 687 687 ... ... @@ -719,8 +719,8 @@ 719 719 { 720 720 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 721 721 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 722 - "mileage": «», пробег723 - "motohours": «»моточасы1027 + "mileage": "", ~/~/ пробег, в метрах 1028 + "motohours": "" ~/~/ моточасы, в секундах 724 724 } 725 725 "cmsv6Parameters": ~/~/ параметры CMSv6 726 726 { ... ... @@ -803,13 +803,14 @@ 803 803 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 804 804 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 805 805 1111 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 806 806 807 807 (% class="box errormessage" %) 808 808 ((( 809 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**1115 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 810 810 ))) 811 811 812 -(% style="color:#000000" %) 1118 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 813 813 814 814 (% style="color:#000000" %)Метод запроса: **DELETE** 815 815 ... ... @@ -822,18 +822,16 @@ 822 822 (% style="text-align:left" %) 823 823 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 824 824 1131 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 825 825 826 -(% class="box" lang="en-US" style="text-align: center;" %) 827 -((( 828 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 829 -))) 1133 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 830 830 831 831 (% class="box infomessage" %) 832 832 ((( 833 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов устройств**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**1137 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 834 834 ))) 835 835 836 -(% style="color:#000000" %) 1140 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 837 837 838 838 (% style="color:#000000" %)Метод запроса: **GET** 839 839 ... ... @@ -851,24 +851,22 @@ 851 851 (% style="text-align:left" %) 852 852 (% style="color:#000000" %)} 853 853 1158 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 854 854 855 -(% class="box" style="text-align: center;" %) 856 -((( 857 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики** 858 -))) 1160 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 859 859 860 860 (% class="box infomessage" %) 861 861 ((( 862 -(% style="color:#000000; line-height:100%" %)** Получениесписка типов датчиков**(%style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**1164 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 863 863 ))) 864 864 865 -(% style="color:#000000" %) 1167 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 866 866 867 867 (% style="color:#000000" %)Метод запроса: **GET** 868 868 869 869 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 870 870 871 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1173 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 872 872 873 873 (% style="color:#000000" %)Ответ: 874 874 ... ... @@ -881,7 +881,48 @@ 881 881 (% style="text-align:left" %) 882 882 (% style="color:#000000" %)} 883 883 1186 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 884 884 1188 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1189 + 1190 +(% class="box infomessage" style="text-align: left;" %) 1191 +((( 1192 +**POST /api/v3/terminalMessages/count** 1193 +))) 1194 + 1195 +(% style="text-align: left;" %) 1196 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1197 + 1198 +(% style="text-align: left;" %) 1199 +Метод запроса **POST** 1200 + 1201 +(% style="text-align: left;" %) 1202 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1203 + 1204 +(% style="text-align: left;" %) 1205 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1206 + 1207 +(% style="text-align: left;" %) 1208 +{ 1209 + "vehicleIds": [ 1210 + id ~/~/ здесь передается список идентификаторов объектов 1211 + ], 1212 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1213 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1214 +} 1215 + 1216 +(% style="text-align: left;" %) 1217 +Ответ: 1218 + 1219 +(% style="text-align: left;" %) 1220 +[ 1221 + { 1222 + "vehicleId": 0, ~/~/ идентификатор объекта 1223 + "count": 0 ~/~/ количество сообщений за период 1224 + } 1225 +] 1226 + 1227 + 885 885 (% class="box" lang="en-US" style="text-align: center;" %) 886 886 ((( 887 887 (% 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]] **