Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,50 +1,68 @@ 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 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 14 14 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 - 17 17 18 -(% class="box" style="text-align: center;" %) 19 -((( 20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 21 -))) 17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 22 22 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 - style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) 28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %)Метод запроса: ** GET**30 +(% style="color:#000000" %)Метод запроса: **POST** 31 31 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]]32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 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 + 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %) **Ответ: [{«AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**47 +(% style="color:#000000" %){ 38 38 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 + 39 39 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 40 40 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 41 41 42 42 (% class="box infomessage" %) 43 43 ((( 44 -(% 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** 45 45 ))) 46 46 47 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет. 48 48 49 49 (% style="color:#000000" %)Метод запроса: **GET** 50 50 ... ... @@ -55,49 +55,243 @@ 55 55 (% lang="en-US" %) 56 56 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 57 57 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 58 58 59 -(% class="box" style="text-align: center;" %) 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 80 +(% class="box infomessage" %) 60 60 ((( 61 - (%style="color:#000000; font-size:14pt" %)**Раздел Клиенты**82 +**GET api/v3/agents/{id}** 62 62 ))) 63 63 85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 86 + 87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 88 + 89 +(% style="color:#000000" %)Метод запроса: **GET** 90 + 91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 92 + 93 +Запрос должен содержать данные параметра "**agentId**" 94 + 95 +(% style="color:#000000" %)Ответ: 96 +А 97 +{ 98 + "agentId": "", ~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 118 + } 119 + 120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 + 64 64 (% class="box infomessage" %) 65 65 ((( 66 -(% 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(%%)** 67 67 ))) 68 68 69 -(% style="color:#000000" %) основныепараметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе: 70 70 71 71 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 72 72 73 73 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 74 74 75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 76 76 77 -(% style="color:#000000" %)Метод запроса: ** GET**135 +(% style="color:#000000" %)Метод запроса: **POST** 78 78 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>137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 80 80 81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)139 +(% style="color:#000000" %)Параметр запроса: 82 82 83 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 84 84 85 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ]145 +(% style="color:#000000" %)Ответ: 86 86 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" %)] 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 +} 88 88 157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 89 89 90 -(% class="box "style="text-align: center;" %)159 +(% class="box successmessage" %) 91 91 ((( 92 - (%style="color:#000000; font-size:14pt"%)**Раздел Пользователи**161 +**POST /api/v3/agents ** 93 93 ))) 94 94 164 +Метод позволяет добавить клиента, указанного в запросе. 165 + 166 +Метод запроса: **POST** 167 + 168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 169 + 170 +В заголовках запроса: X-Auth: Токен авторизации 171 + 172 +Параметры в теле запроса (JSON): 173 + 174 +{ 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 + "name": "string", ~/~/ имя 177 + "fullName": "string", ~/~/ полное наименование 178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 179 + "isForeign": true, ~/~/ иностранный контрагент 180 + "district": "string", ~/~/ округ 181 + "region": "string", ~/~/ регион 182 + "city": "string", ~/~/ город 183 + "inn": "string", ~/~/ ИНН 184 + "kpp": "string", ~/~/ КПП 185 + "address": "string", ~/~/ юридический адрес 186 + "addressFact": "string", ~/~/ фактический адрес 187 + "email": "string", ~/~/ email 188 + "director": "string", ~/~/ ФИО руководителя 189 + "bankName": "string", ~/~/ банк 190 + "bankBIK": "string", ~/~/ БИК 191 + "bankRS": "string", ~/~/ номер счёта 192 + "bankKS": "string" ~/~/ корр. счёт 193 +} 194 + 195 + 196 +Ответ: 197 + 198 +{ 199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 201 + "name": "string", ~/~/ имя 202 + "fullName": "string", ~/~/ полное наименование 203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 204 + "isForeign": true, ~/~/ иностранный контрагент 205 + "district": "string", ~/~/ округ 206 + "region": "string", ~/~/ регион 207 + "city": "string", ~/~/ город 208 + "inn": "string", ~/~/ ИНН 209 + "kpp": "string", ~/~/ КПП 210 + "address": "string", ~/~/ юридический адрес 211 + "addressFact": "string", ~/~/ фактический адрес 212 + "email": "string", ~/~/ email 213 + "director": "string", ~/~/ ФИО руководителя 214 + "bankName": "string", ~/~/ банк 215 + "bankBIK": "string", ~/~/ БИК 216 + "bankRS": "string", ~/~/ номер счёта 217 + "bankKS": "string" ~/~/ корр. счёт 218 +} 219 + 220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 + 222 +(% class="box warningmessage" %) 223 +((( 224 +**PUT /api/v3/agents** 225 +))) 226 + 227 +Метод позволяет отредактировать клиента, указанного в запросе. 228 + 229 +Метод запроса: **PUT** 230 + 231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 232 + 233 +В заголовках запроса: X-Auth: Токен авторизации 234 + 235 + 236 +Параметры в теле запроса (JSON): 237 + 238 +{ 239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 241 + "name": "string", ~/~/ имя 242 + "fullName": "string", ~/~/ полное наименование 243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 244 + "isForeign": true, ~/~/ иностранный контрагент 245 + "district": "string", ~/~/ округ 246 + "region": "string", ~/~/ регион 247 + "city": "string", ~/~/ город 248 + "inn": "string", ~/~/ ИНН 249 + "kpp": "string", ~/~/ КПП 250 + "address": "string", ~/~/ юридический адрес 251 + "addressFact": "string", ~/~/ фактический адрес 252 + "email": "string", ~/~/ email 253 + "director": "string", ~/~/ ФИО руководителя 254 + "bankName": "string", ~/~/ банк 255 + "bankBIK": "string", ~/~/ БИК 256 + "bankRS": "string", ~/~/ номер счёта 257 + "bankKS": "string" ~/~/ корр. счёт 258 +} 259 + 260 + 261 +Ответ: 262 + 263 +{ 264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 266 + "name": "string", ~/~/ имя 267 + "fullName": "string", ~/~/ полное наименование 268 + "isForeign": true, ~/~/ иностранный контрагент 269 + "district": "string", ~/~/ округ 270 + "region": "string", ~/~/ регион 271 + "city": "string", ~/~/ город 272 + "inn": "string", ~/~/ ИНН 273 + "kpp": "string", ~/~/ КПП 274 + "address": "string", ~/~/ юридический адрес 275 + "addressFact": "string", ~/~/ фактический адрес 276 + "email": "string", ~/~/ email 277 + "director": "string", ~/~/ ФИО руководителя 278 + "bankName": "string", ~/~/ банк 279 + "bankBIK": "string", ~/~/ БИК 280 + "bankRS": "string", ~/~/ номер счёта 281 + "bankKS": "string" ~/~/ корр. счёт 282 +} 283 + 284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 285 + 286 +(% class="box errormessage" %) 287 +((( 288 +**DELETE /api/v3/agents/{clientId}** 289 +))) 290 + 291 +Метод позволяет удалить клиента, указанного в строке запроса. 292 + 293 +Метод запроса: **DELETE** 294 + 295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 296 + 297 +Параметр запроса: **{clientId}** - Guid пользователя 298 + 299 +В заголовках запроса: X-Auth: Токен авторизации 300 + 301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 + 303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 + 305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 306 + 95 95 (% class="box successmessage" %) 96 96 ((( 97 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**309 +(% lang="en-US" %)**POST /api/v3/users** 98 98 ))) 99 99 100 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе. 101 101 102 102 (% style="color:#000000" %)Метод запроса: **POST** 103 103 ... ... @@ -105,18 +105,189 @@ 105 105 106 106 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 107 107 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»: [ // группы пользователя «», //названия групп «», «» ] }320 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 109 109 322 +(% style="color:#000000" %) 323 +{ 324 + "lastName": "", ~/~/ фамилия 325 + "firstName": "", ~/~/ имя 326 + "position": "", ~/~/ должность 327 + "phone": "", ~/~/ телефон 328 + "organization": "", ~/~/ организация 329 + "login": "", ~/~/ логин (обязателен) 330 + "password": "", ~/~/ пароль (обязателен) 331 + "email": "", ~/~/ email (обязателен) 332 + "description": "string", ~/~/ Описание 333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено 334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен 336 + "parentId": "", ~/~/ Guid родительского агента 337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 339 + "doubleAuth": 340 + { 341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 343 + }, 344 + "groups": 345 + [ 346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей 347 + ], 348 + "customGroups": 349 + [ 350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 + ], 352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 +} 354 + 355 +{ 356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 + "lastName": "string", 358 + "firstName": "string", 359 + "position": "string", 360 + "phone": "string", 361 + "organization": "string", 362 + "login": "string", 363 + "password": "string", 364 + "email": "string", 365 + 366 + 110 110 (% style="text-align:left" %) 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» //названия групп ] }368 +(% style="color:#000000; font-weight:normal" %)Ответ: 112 112 370 +(% style="text-align:left" %) 371 +(% style="color:#000000; font-weight:normal" %){ 113 113 373 +(% style="text-align:left" %) 374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 375 + "lastName": "" , ~/~/ Фамилия , 376 + "firstName": "" , ~/~/ Имя 377 + "position": "" , ~/~/ Должность 378 + "phone": "" , ~/~/ Телефон 379 + "organization": "" , ~/~/ Организация 380 + "login": "" , ~/~/ Логин 381 + "password": "" , ~/~/ Пароль 382 + "email": "" , ~/~/ Email 383 + "description": "" , ~/~/ Описание 384 + "isEnabled": "" , ~/~/ Признак включения 385 + "parentId": "" , ~/~/ Guid родительского агента 386 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 387 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 388 + "kind": "" , ~/~/ тип аутентификации 389 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 391 + 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 394 + 395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 + 397 +(% class="box infomessage" %) 398 +((( 399 +(% lang="en-US" %)**POST /api/v3/users/find** 400 +))) 401 + 402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 403 + 404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 405 + 406 +(% style="color:#000000" %)Метод запроса: **POST** 407 + 408 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 409 + 410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 411 + 412 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 413 + 414 +(% style="color:#000000" %){ 415 + 416 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 421 +(% style="color:#000000" %)} 422 + 423 +(% style="color:#000000" %)Ответ: 424 + 425 +(% style="color:#000000" %){ (%%) 426 + 427 + "id": "" , ~/~/ идентификатор пользователя 428 + "lastName": "" , ~/~/ фамилия 429 + "firstName": "" , ~/~/ имя 430 + "position": "" , ~/~/ должность 431 + "phone": "" , ~/~/ телефон 432 + "parentId": "" , ~/~/ идентификатор клиента-родителя 433 + "parentName": "" , ~/~/ наименование клиента-родителя 434 + "organization": "" , ~/~/ организация 435 + "login": "" , ~/~/ логин 436 + "email": "" , ~/~/ E-mail 437 + "sessionDuration":"", ~/~/ длительность сессии в минутах 438 + "status": "1", ~/~/ статус пользователя 439 + "lastLogged": "", ~/~/ дата/время последней авторизации 440 + 441 +(% style="color:#000000" %)} 442 + 443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 444 + 445 +(% class="box infomessage" %) 446 +((( 447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 448 +))) 449 + 450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 451 + 452 +(% style="color:#000000" %)Метод запроса: **GET** 453 + 454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 455 + 456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 457 + 458 +(% style="color:#000000" %)Ответ: 459 + 460 +((( 461 +((( 462 +{ 463 + "id": "", ~/~/ GUID пользователя 464 + "lastName": "", ~/~/ Фамилия 465 + "firstName": "", ~/~/ Имя 466 + "position": "", ~/~/ Должность 467 + "phone": "", ~/~/ Номер телефона 468 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 469 + "parentName": "", Наименование клиента, которому принадлежит пользователь 470 + "organization": "", ~/~/ Организация 471 + "login": "", ~/~/ Логин пользователя 472 + "email": "", ~/~/ Адрес электронной почты 473 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 474 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 475 + "description": "", ~/~/ Описание 476 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 477 + "doubleAuth": 478 + { 479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 481 + }, 482 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 483 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 484 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 485 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 486 + "groups": [], ~/~/ Список ролей пользователя 487 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 488 + "authDevices": [ ], ~/~/ Список авторизованных устройств 489 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 490 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 491 +} 492 +))) 493 +))) 494 + 495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 496 + 114 114 (% class="box warningmessage" %) 115 115 ((( 116 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**499 +(% lang="en-US" %)**PUT /api/v3/users** 117 117 ))) 118 118 119 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе. 120 120 121 121 (% style="color:#000000" %)Метод запроса: **PUT** 122 122 ... ... @@ -125,98 +125,174 @@ 125 125 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 126 126 127 127 (% lang="en-US" style="text-align:left" %) 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» //названия групп ] } //511 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 129 129 513 +(% lang="en-US" style="text-align:left" %) 514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 130 130 516 +(% lang="en-US" style="text-align:left" %) 517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 518 + "lastName": "" , ~/~/ фамилия 519 + "firstName": "" , ~/~/ имя 520 + "position": "" , ~/~/ должность 521 + "phone": "" , ~/~/ телефон 522 + "organization": "" , ~/~/ организация 523 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 527 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 528 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 529 + "isEnabled": "" , ~/~/ признак включения 530 + "parentId": "" , ~/~/ Guid родительского агента 531 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 532 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 533 + "doubleAuth": 534 + { 535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 + }, 538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 + 541 +(% lang="en-US" style="text-align:left" %) 542 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 + 544 +(% lang="en-US" style="text-align:left" %) 545 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 + 547 +(% lang="en-US" style="text-align:left" %) 548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 + 550 +(% lang="en-US" style="text-align:left" %) 551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 552 + "lastName": "" , ~/~/ фамилия 553 + "firstName": "" , ~/~/ имя 554 + "position": "" , ~/~/ должность 555 + "phone": "" , ~/~/ телефон 556 + "organization": "" , ~/~/ организация 557 + "login": "" , ~/~/ логин 558 + "password": "" , ~/~/ пароль 559 + "email": "" , ~/~/ email 560 + "description": "" , ~/~/ описание 561 + "isEnabled": "" , ~/~/ признак включения 562 + "parentId": "" , ~/~/ Guid родительского агента 563 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 564 + "doubleAuth": 565 + { 566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен 567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 568 + }, 569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 572 + 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 + 576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 + 131 131 (% class="box warningmessage" %) 132 132 ((( 133 -(% style="color:#000000" %) **Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 134 134 ))) 135 135 136 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 137 137 138 138 (% style="color:#000000" %)Метод запроса: **PUT** 139 139 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} Параметр запроса:587 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} 141 141 142 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 143 143 144 -(% class="western" %) 145 -{{{ "description": "", // описание 146 - "data": "" // данные, связанные со сменой статуса}}} 591 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 147 147 593 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 594 + 595 +(% style="color:#000000" %){ 596 + 597 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 + "description": "" , ~/~/ описание 599 + "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 148 148 (% style="color:#000000" %)} 149 149 150 150 (% style="text-align:left" %) 151 151 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 152 152 606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 153 153 154 -(% class="box successmessage" %)608 +(% class="box warningmessage" %) 155 155 ((( 156 - (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**610 +**POST /api/v3/users/disable** 157 157 ))) 158 158 159 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметрыпользователей:логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %). 160 160 161 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяприналичииправа**«Просмотр пользователей»**.615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 162 162 163 -(% style="color:#000000" %) Методзапроса:**POST**617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 164 164 165 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 166 166 167 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 621 + [ 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 + ] 168 168 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 - неважно}}} 626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 174 174 175 -(% style="color:#000000" %) }628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 176 176 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" %) 630 +(% class="box warningmessage" %) 187 187 ((( 188 - (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE/api/v3/users/{id}**632 +**POST /api/v3/users/enable** 189 189 ))) 190 190 191 - (% style="color:#000000" %)Метод позволяетудалить пользователя. Методпозволяет удалитьпользователя,указанного в строкезапроса (обязательный параметр взаголовках запроса -токенавторизации **«X-Auth»**).635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %). 192 192 193 -(% style="color:#000000" %)Метод запроса: ** DELETE**637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 194 194 195 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>> url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 196 196 197 -(% style="color:#000000" %) Параметрзапроса:{id}-Guid пользователя В заголовках запроса: X-Auth: Токенавторизации641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 198 198 199 -(% style="text-align:left" %) 200 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 643 + [ 644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 646 + ] 201 201 648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 202 202 203 -(% class="box" style="text-align: center;" %) 204 204 ((( 205 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 652 +В теле ответа: 653 +{ 654 + "errorMessages": [ 655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 656 + ], 657 + "users": [ 658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 659 + ] 660 +} 661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 662 +"users" - массив id пользователей, которых не удалось включить или отключить. 206 206 ))) 207 207 665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 666 + 208 208 (% class="box errormessage" %) 209 209 ((( 210 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 211 211 ))) 212 212 213 -(% style="color:#000000" %) бъект. Метод позволяет удалить объект, указанныйв строке запроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 214 214 215 215 (% style="color:#000000" %)Метод запроса: **DELETE** 216 216 217 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}676 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 218 218 219 -(% style="color:#000000" %)Параметр запроса: {id} - Guid о бъекта678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 220 220 221 221 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 222 222 ... ... @@ -223,51 +223,187 @@ 223 223 (% style="text-align:left" %) 224 224 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 225 225 685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 226 226 687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 + 227 227 (% class="box infomessage" %) 228 228 ((( 229 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 230 230 ))) 231 231 232 -(% style="color:#000000" %) 694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 233 233 234 -(% style="color:#000000" %) (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе: 235 235 236 236 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 237 237 238 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 239 239 240 240 (% style="color:#000000" %)Метод запроса: **GET** 241 241 242 -(% 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>704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID} 243 243 244 -(% style="color:#000000" %)Параметр запроса: <vehicleid>- идентификатор объекта (опционально)706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 245 245 246 246 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 247 247 248 248 (% style="color:#000000" %)Ответ: 249 249 250 -(% style="color:#000000" %){ 712 +((( 713 +{ 714 + "vehicleId": "", ~/~/ ID объекта 715 + "name": "", ~/~/ Имя объекта 716 + "imei": "", ~/~/ IMEI объекта 717 + "deviceTypeId": , ~/~/ ID типа устройства 718 + "deviceTypeName": "", ~/~/ Название типа устройства 719 + "sim1": "", ~/~/ Номер SIM1 720 + "sim2": "", ~/~/ Номер SIM2 251 251 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 - ... 722 + "parentId": "", ~/~/ ID клиента-родителя 723 + "parentName": "", ~/~/ Наименование клиента-родителя 724 + "modelId": "", ~/~/ ID модели объекта 725 + "modelName": "", ~/~/ Имя модели объекта 726 + 727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 + "unitName": "string", ~/~/ Наименование подразделения 729 + "status": 0, ~/~/ Статус объекта 730 + 731 + "createdAt": "", ~/~/ Дата создания объекта 732 + }, 733 + 734 +"customFields": [ ~/~/ Произвольные поля 735 + { 736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 737 + "name": "string", 738 + "value": "string", 739 + "forClient": true, 740 + "forTooltip": true, 741 + "forReport": true 742 + } 743 + 744 +], ~/~/ Данные с вкладки нормы 745 + "consumptionPer100Km": 0, 746 + "consumptionPerHour": 0, 747 + "consumptionIdle": 0, 748 + "consumptionPer100KmSeasonal": 0, 749 + "consumptionPerHourSeasonal": 0, 750 + "consumptionIdleSeasonal": 0, 751 + "consumptionPer100KmSeasonalBegin": "2023-05-22T09:57:39.562Z", 752 + "consumptionPer100KmSeasonalEnd": "2023-05-22T09:57:39.562Z", 753 + "consumptionPerHourSeasonalBegin": "2023-05-22T09:57:39.562Z", 754 + "consumptionPerHourSeasonalEnd": "2023-05-22T09:57:39.562Z", 755 + "consumptionIdleSeasonalBegin": "2023-05-22T09:57:39.562Z", 756 + "consumptionIdleSeasonalEnd": "2023-05-22T09:57:39.562Z", 757 + "mileageCalcMethod": 0, 758 + "mileageCoeff": 0, 759 + "locationByCellId": true, 760 + "dottedLineTrackWhenNoCoords": true, 761 + "counters": { 762 + "mileageEnabled": true, 763 + "motohoursEnabled": true, 764 + "mileage": 0, 765 + "motohours": 0, 766 + "mileageTime": "2023-05-22T09:57:39.562Z", 767 + "motohoursTime": "2023-05-22T09:57:39.562Z" 266 266 }, 267 - ...}}} 268 268 269 -(% style="color:#000000" %)} 770 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 771 + "id": "string", 772 + "enabled": true, 773 + "host": "string", 774 + "login": "string", 775 + "password": "string" 776 + }, 270 270 778 +"commandTemplates": [ ~/~/ Шаблоны команд 779 + { 780 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 781 + "name": "string", 782 + "command": "string", 783 + "retries": 0 784 + } 785 + ], 786 + 787 + "sensors": [ ~/~/ Датчики 788 + { 789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 790 + "kind": 0, 791 + "type": 0, 792 + "name": "string", 793 + "inputType": 0, 794 + "inputNumber": 0, 795 + "pseudonym": "string", 796 + "medianDegree": 0, 797 + "isInverted": true, 798 + "disabled": true, 799 + "gradeType": 0, 800 + "gradesTables": [ 801 + { 802 + "grades": [ 803 + { 804 + "input": 0, 805 + "output": 0 806 + } 807 + ], 808 + "relevanceTime": "2023-05-22T09:57:39.562Z" 809 + } 810 + ], 811 + "showInTooltip": true, 812 + "showLastValid": true, 813 + "showAsDutOnGraph": true, 814 + "showWithoutIgn": true, 815 + "agrFunction": 0, 816 + "expr": "string", 817 + "children": [ 818 + "string" 819 + ], 820 + "customParams": { 821 + "additionalProp1": "string", 822 + "additionalProp2": "string", 823 + "additionalProp3": "string" 824 + }, 825 + "summaryMaxValue": 0 826 + } 827 + 828 + "drivers": [ ~/~/ Водители 829 + { 830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 831 + "name": "string", 832 + "description": "string", 833 + "isDefault": true 834 + } 835 + ], 836 + 837 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 838 + { 839 + "id": "", ~/~/ ID задания 840 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 841 + "name": "", ~/~/ Наименование задания 842 + "description": "", ~/~/ Описание задания 843 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 844 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 845 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 846 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 847 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 848 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 849 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 850 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 851 + } 852 + ], 853 + 854 + "statusHistory": [ ~/~/ История статусов 855 + { 856 + "status": 0, 857 + "date": "2023-05-22T09:57:39.562Z", 858 + "description": "string", 859 + "additionalInfo": "string" 860 + } 861 + ] 862 + 863 +} 864 +))) 865 + 271 271 (% style="text-align:left" %) 272 272 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 273 273 ... ... @@ -274,13 +274,14 @@ 274 274 (% style="text-align:left" %) 275 275 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 276 276 872 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 277 277 278 278 (% class="box successmessage" %) 279 279 ((( 280 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**876 +(% lang="en-US" %)**POST /api/v3/vehicles** 281 281 ))) 282 282 283 -(% style="color:#000000" %) . Метод позволяет добавить объект, указанный в запросе(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).879 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 284 284 285 285 (% style="color:#000000" %)Метод запроса: **POST** 286 286 ... ... @@ -288,302 +288,733 @@ 288 288 289 289 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 290 290 291 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {887 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 292 292 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": "" // пароль учетной записи 317 - }, 318 - "inspectionTasks": [ // задания на ТО 889 +(% style="color:#000000" %){ 890 + 891 + "parentId": "" , ~/~/ ID клиента 892 + "name": "" , ~/~/ имя ТС 893 + "imei": "" , ~/~/ IMEI 894 + "deviceTypeId": "" , ~/~/ ID типа устройства 895 + "modelId": "" , ~/~/ ID модели 896 + "unitId": "" , ~/~/ ID подразделения 897 + "sim1": "" , ~/~/ Номер SIM 1 898 + "sim2": "" , ~/~/ Номер SIM2 899 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 900 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 901 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 902 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 903 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 904 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 905 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 906 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 907 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 908 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 909 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 910 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 911 + "counters": ~/~/ счетчики 319 319 { 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 - однократно) 913 + "mileage": "" , ~/~/ пробег 914 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 915 + "motohours": "" , ~/~/ моточасы 916 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 331 331 }, 332 - ]}}} 918 + "cmsv6Parameters": { ~/~/ параметры CMSv6 919 + "enabled": true, ~/~/ флаг включения 920 + "id": "" , ~/~/ идентификатор 921 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 922 + "login": "" , ~/~/ имя учетной записи 923 + "password": "" ~/~/ пароль учетной записи 924 + }, 925 + "inspectionTasks": ~/~/ задания на ТО 926 + { 927 + "enabled": "" , ~/~/ Признак включения 928 + "name": "" , ~/~/ Имя задания 929 + "description": "" , ~/~/ Описание задания 930 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 931 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 932 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 933 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 934 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 935 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 936 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 937 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 938 + } 333 333 334 -(% style="color:#000000" %) …}940 +(% style="color:#000000" %) } 335 335 336 336 (% style="color:#000000" %)Ответ: 337 337 338 338 (% style="color:#000000" %){ 339 339 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 - ]}}} 946 + "vehicleId": "", ~/~/ID ТС 947 + "parentId": "", ~/~/Guid владельца ТС 948 + "name": "", ~/~/Имя объекта 949 + "imei": "", ~/~/IMEI 950 + "deviceTypeId": "", ~/~/ID типа устройства 951 + "modelId": "", ~/~/ID модели 952 + "unitId": "", ~/~/ID подразделения 953 + "sim1": "", ~/~/SIM1 954 + "sim2": "", ~/~/SIM2 955 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 956 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 957 + "counters": { ~/~/Счётчики 958 + "mileageEnabled": true, 959 + "motohoursEnabled": true, 960 + "mileage": "", 961 + "motohours": 345.0 962 + }, 963 + "cmsv6Parameters": { ~/~/Параметры CmsV6 964 + "id": null, 965 + "enabled": true, ~/~/флаг включения 966 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 967 + "login": "", ~/~/ имя учетной записи 968 + "password": "" ~/~/ пароль учетной записи 969 + }, 970 + "inspectionTasks": { ~/~/ задания на ТО 971 + "id": "", ~/~/ ID задачи 972 + "enabled": false, ~/~/ Признак включения 973 + "name": "", ~/~/ Имя задания 974 + "description": "", ~/~/ Описание задания 975 + "mileageCondition": "", ~/~/ Условие по пробегу 976 + "lastMileage": "", ~/~/ Пробег (в метрах) 977 + "motohoursCondition": "", ~/~/ Условие по моточасам 978 + "lastMotohours": "", ~/~/ Моточасы 979 + "periodicCondition": "", ~/~/ Условие периодичности по времени 980 + "kind": "", ~/~/ Вид периодичности по времени 981 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 982 + } 380 380 381 381 (% style="text-align:left" %) 382 382 (% style="color:#000000" %)} 383 383 987 +**Валидация:** 988 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 989 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 990 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 384 384 385 -(% class="box warningmessage" %) 992 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 993 + 994 +(% class="box infomessage" %) 386 386 ((( 387 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**996 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 388 388 ))) 389 389 390 -(% style="color:#000000" %) редактироватьобъект.Метод позволяетотредактировать объект,указанный в запросе(обязательныйпараметрвзаголовкахзапроса- токенавторизации **«X-Auth»**).999 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 391 391 392 -(% style="color:#000000" %)Метод за проса:**PUT**1001 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 393 393 394 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]1003 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 395 395 396 -(% style="color:#000000" %) Взаголовках запроса:X-Auth:Токен авторизации1005 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 397 397 1007 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 1008 + 1009 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 1010 + 1011 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 1012 + 1013 +(% style="color:#000000" %)Метод запроса: **POST** 1014 + 1015 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 1016 + 1017 +(% style="color:#000000" %)В заголовках запроса: 1018 + 1019 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 1020 + 1021 +(% style="color:#000000" %)− X-Auth: Токен авторизации 1022 + 1023 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 1024 + 398 398 (% style="color:#000000" %)Параметры в теле запроса (JSON): 399 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»: «» //Сколько раз выполнить задание } ] } 1027 +{ 1028 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 1029 + "name": null, ~/~/ Имя ТС (string, опционально) 1030 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1031 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1032 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1033 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 1034 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1035 + "customFields": null ~/~/ значение любого из произвольных полей ТС 1036 +} 401 401 1038 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 1039 + 402 402 (% style="color:#000000" %)Ответ: 403 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»: «» //Сколько раз выполнить задание } ] } 1042 +(% style="color:#000000" %){ 406 406 1044 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1045 + "name": "" ~/~/ наименование объекта 1046 + "imei": "" ~/~/ IMEI объекта 1047 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 1048 + "deviceTypeName": "" ~/~/ наименование типа устройства 1049 + "sim1": "" ~/~/ первый номер телефона 1050 + "sim2": "" ~/~/ второй номер телефона 1051 + "parentId": "" ~/~/ идентификатор клиента-родителя 1052 + "parentName": "" ~/~/ наименование клиента-родителя 1053 + "modelId": "" ~/~/ идентификатор модели объекта 1054 + "modelName": "" ~/~/ наименование модели объекта 1055 + "unitId": "" ~/~/ идентификатор подразделения 1056 + "unitName": "" ~/~/ наименование подразделения 1057 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1058 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1059 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1060 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 1061 + "customFields": [ 1062 + { 1063 + "id": "", ~/~/ идентификатор произвольного поля 1064 + "name": "", ~/~/ имя произвольного поля 1065 + "value": "", ~/~/ значение произвольного поля 1066 + "forClient": true, ~/~/ право на отображение у клиента 1067 + "forTooltip": false, ~/~/ право на отображение в подсказке 1068 + "forReport": false ~/~/ право на отображение в отчетах 1069 + }(%%) 1070 +(% style="color:#000000" %)} 407 407 1072 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1073 + 1074 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 1075 + 408 408 (% class="box successmessage" %) 409 409 ((( 410 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**1078 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 411 411 ))) 412 412 413 -(% style="color:#000000" %) получитьосновные параметрыобъектов:наименование, IMEI,типустройства,модель объекта,подразделение,номера телефонови идентификатор клиента, к которомуприкрепленобъект (клиент-родитель).1081 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе. 414 414 415 -(% style="color:#000000" %) возвращает информацию об объектах с учетом настроек авторизованногопользователя, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации**«X-Auth»**):1083 +(% style="color:#000000" %)Метод запроса: **POST** 416 416 417 -(% style="color:#000000" %) − возвращается информацияоб объектахклиента-родителяавторизованногопользователя и объектах его дочерних клиентов;1085 +(% 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} 418 418 419 -(% style="color:#000000" %) − возвращаетинформациюоб объектах с учетомзаданных настроек видимостиобъектов;1087 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 420 420 421 -(% style="color:#000000" %) −информация предоставляется с учетом наличия правна просмотр объектов заблокированныхдоговоров (объекты, принадлежащиезаблокированному договору возвращаются при наличиилюбогоиз прав «Видимость объектов заблокированныхдоговоров в панели управления» или «Видимостьобъектовзаблокированных договоров в мониторинге»;1089 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 422 422 423 -(% style="color:#000000" %) − информация о телефонах SIM1/SIM2 предоставляется приналичии права«Просмотр номеров телефоновобъектов»;1091 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 424 424 425 -(% style="color:#000000" %) − информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».1093 +(% style="color:#000000" %){ 426 426 427 -(% style="color:#000000" %)Метод запроса: **POST** 1095 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 1096 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 1097 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 1098 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 1099 + "description": "", ~/~/ Описание 1100 + "data": "", ~/~/ Данные 1101 + "overwrite": false, ~/~/ Флаг перезаписи 1102 + "stage": "", ~/~/ Состояние, может быть null 428 428 429 -(% style="color:#000000" %) URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]1104 +(% style="color:#000000" %)} 430 430 431 -(% style="color:#000000" %) В заголовках запроса:1106 +(% style="color:#000000" %)Ответ: 432 432 433 -(% style="color:#000000" %) − Content-Type: application/json1108 +(% style="color:#000000" %){ 434 434 435 -(% style="color:#000000" %)− X-Auth: Токен авторизации 1110 + "status": "", ~/~/ значение статуса 1111 + "date": "", ~/~/ Дата смены статуса 1112 + "description": "", ~/~/ Описание 1113 + "data": "", ~/~/ Данные 1114 + "overwrite": false, ~/~/ Флаг перезаписи 1115 + "stage": "", ~/~/ Состояние 436 436 437 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 1117 +(% style="text-align:left" %) 1118 +(% style="color:#000000" %) } 438 438 439 -(% class="western" style="color:#000000"%)##{"vehicleId":null,~/~/84350, ~/~/ ID ТС (int, опционально)"name": null, ~/~/ Имя ТС (string,опционально)"imei": null,~/~/"710179307",##1120 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 440 440 441 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 1122 +(% class="box warningmessage" %) 1123 +((( 1124 +(% lang="en-US" %)**PUT /api/v3/vehicles** 1125 +))) 442 442 443 -(% class="western" style="color:#000000" %)##~/~/IDтипаустройства(short, опционально)"parentId": null, ~/~/ ID клиента (Guid,опционально)"unitId":null##1127 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 444 444 445 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения(Guid, опционально)##(% style="color:#000000"%)}1129 +(% style="color:#000000" %)Метод запроса: **PUT** 446 446 447 -(% style="color:#000000" %) Фильтрация осуществляетсяпоточномусовпадениюзначений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».1131 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 448 448 449 -(% style="color:#000000" %) Ответ:[ { «vehicleId»: «», //идентификаторобъекта «name»: «», // наименование объекта«imei»: «», // IMEI объекта«deviceTypeId»: «», // идентификатор типа устройства«deviceTypeName»:«», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»:«», //наименованиеклиента-родителя«modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификаторподразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]1133 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 450 450 451 -(% style="color:#000000" %) «sim1» и «sim2» содержатсявответе при наличии у авторизованного пользователяправа **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованногопользователя права **«Просмотр статусаобъекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:1135 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 452 452 453 -(% style="color:#000000" %) 0- «Блокировка»1137 +(% style="color:#000000" %){ 454 454 455 -(% style="color:#000000" %)1 - «Активен», 1139 +((( 1140 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1141 + "parentId": "", ~/~/ ID клиента 1142 + "name": "", ~/~/ имя ТС 1143 + "imei": "", ~/~/ IMEI 1144 + "deviceTypeId": "", ~/~/ ID типа устройства 1145 + "modelId": "", ~/~/ , ID модели 1146 + "unitId": "", ~/~/ подразделения 1147 + "sim1": "", ~/~/ SIM 1 1148 + "sim2": "", ~/~/ SIM2 (%%) 1149 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1150 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1151 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1152 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1153 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1154 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1155 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1156 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1157 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1158 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1159 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1160 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1161 +(% style="color:#000000" %) "counters": 1162 + { 1163 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1164 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1165 + "mileage": "", ~/~/ пробег, в метрах 1166 + "motohours": "" ~/~/ моточасы, в секундах 1167 + } 1168 + "cmsv6Parameters": ~/~/ параметры CMSv6 1169 + { 1170 + "id": "", ~/~/ идентификатор 1171 + "enabled": true, ~/~/ флаг включения 1172 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1173 + "login": "", ~/~/ имя учетной записи 1174 + "password": "", ~/~/ пароль учетной записи 1175 + } 1176 + "inspectionTasks": ~/~/ задания на ТО 1177 + { 1178 + "id": "", ~/~/ ID задания 1179 + "enabled": false, ~/~/ Признак включения 1180 + "name": "", ~/~/ Имя задания 1181 + "description": "", ~/~/ Описание задания 1182 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1183 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1184 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1185 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1186 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1187 + "kind": "", ~/~/ Вид периодичности по времени 1188 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1189 + } 1190 +))) 456 456 457 -(% style="color:#000000" %) 2 - «Отменен»1192 +(% style="color:#000000" %)} 458 458 459 -(% style="color:#000000" %) 3 - «Оборудован»1194 +(% style="color:#000000" %)Ответ: 460 460 461 -(% style="color:#000000" %)4 - «Диагностика» 1196 +(% lang="en-US" style="text-align:left" %) 1197 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 462 462 463 -(% style="color:#000000" %)5 - «Сервис» 1199 +(% lang="en-US" style="text-align:left" %) 1200 + "vehicleId": "", ~/~/ ID ТС 1201 + "parentId": "", ~/~/ ID клиента 1202 + "name": "", ~/~/ имя ТС 1203 + "imei": "", ~/~/ IMEI 1204 + "deviceTypeId": "", ~/~/ типа устройства 1205 + "modelId": "", ~/~/ ID модели 1206 + "unitId": "", ~/~/ ID подразделения 1207 + "sim1": "", ~/~/ SIM 1 1208 + "sim2": "", ~/~/ SIM2 1209 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1210 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1211 + "counters": 1212 + { 1213 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1214 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1215 + "mileage": "", ~/~/ пробег 1216 + "motohours": "", ~/~/ моточасы 1217 + } 1218 + "cmsv6Parameters": ~/~/ параметры CMSv6 1219 + { 1220 + "id": ~/~/ идентификатор 1221 + "enabled": true, ~/~/ флаг включения 1222 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1223 + "login": "", ~/~/ имя учетной записи 1224 + "password": "", ~/~/ пароль учетной записи 1225 + } 1226 + "inspectionTasks": ~/~/ задания на ТО 1227 + { 1228 + "id": "", ~/~/ ID задания 1229 + "enabled": false, ~/~/ Признак включения 1230 + "name": "", ~/~/ Имя задания 1231 + "description": "", ~/~/ Описание задания 1232 + "mileageCondition": "", ~/~/ Условие по пробегу 1233 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1234 + "motohoursCondition": "", ~/~/ Условие по моточасам 1235 + "lastMotohours": "", ~/~/ Моточасы 1236 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1237 + "kind": "", ~/~/ Вид периодичности по времени 1238 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1239 + } 464 464 465 -(% style="color:#000000" %)6 - «Демонтаж» 1241 +(% lang="en-US" style="text-align:left" %) 1242 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 466 466 467 -(% style="color:#000000" %)7 - «Монтаж» 1244 +**Валидация:** 1245 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1246 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1247 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 468 468 469 -(% style="color:#000000" %) 8- «Дозаказ»1249 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 470 470 471 -(% style="color:#000000" %)9 - «Обслужен» 1251 +(% class="box errormessage" %) 1252 +((( 1253 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1254 +))) 472 472 473 -(% style="color:#000000" %) 10- «Списан»1256 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 474 474 475 -(% style="color:#000000" %) 11 - «Неисправен»1258 +(% style="color:#000000" %)Метод запроса: **DELETE** 476 476 477 -(% style="color:#000000" %) 12 - «Проверен»1260 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 478 478 1262 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1263 + 1264 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1265 + 479 479 (% style="text-align:left" %) 480 -(% style="color:#000000 ; font-weight:normal" %)13-«Неэксплуатируется»1267 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 481 481 1269 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 482 482 483 -(% class="box successmessage" %) 1271 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1272 + 1273 +(% class="box infomessage" %) 484 484 ((( 485 -(% style="color:#000000; line-height:100%" %)** Изменениестатуса объекта —**(% lang="en-US" %)**POSTvehicles/changeStatus/{vehicleId}**1275 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 486 486 ))) 487 487 488 -(% style="color:#000000" %) зменить статусбъекта. Методпозволяет изменитьстатусобъекта,указанногов запросе (обязательныйпараметр взаголовкахзапроса - токен авторизации **«X-Auth»**).1278 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе. 489 489 490 -(% style="color:#000000" %)Метод запроса: ** POST**1280 +(% style="color:#000000" %)Метод запроса: **GET** 491 491 492 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ve hicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}1282 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 493 493 494 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 495 - 496 496 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 497 497 498 -(% style="color:#000000" %) Параметрывтеле запроса (JSON):{1286 +(% style="color:#000000" %)Ответ: 499 499 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}}} 1288 +(% style="color:#000000" %){ 507 507 1290 + "deviceTypeId" : "", ~/~/ ID типа устройства 1291 + "deviceTypeName" : "" ~/~/ Название типа устройства 1292 + 1293 +(% style="text-align:left" %) 508 508 (% style="color:#000000" %)} 509 509 510 -(% style="color:#000000" %) Ответ:{1296 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 511 511 512 -(% class="western" %) 513 -{{{ "status": "", // значение статуса 514 - "date": "", // Дата смены статуса 515 - "description": "", // Описание 516 - "data": "", // Данные 517 - "overwrite": false, // Флаг перезаписи 518 - "stage": "", // Состояние}}} 1298 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 519 519 1300 +(% class="box infomessage" %) 1301 +((( 1302 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1303 +))) 1304 + 1305 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1306 + 1307 +(% style="color:#000000" %)Метод запроса: **GET** 1308 + 1309 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1310 + 1311 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1312 + 1313 +(% style="color:#000000" %)Ответ: 1314 + 1315 +(% style="color:#000000" %){ 1316 + 1317 + "id": "", ~/~/ ID типа датчика 1318 + "name": "", ~/~/ Название 1319 + "description": "", ~/~/ Описание 1320 + 520 520 (% style="text-align:left" %) 521 521 (% style="color:#000000" %)} 522 522 1324 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 523 523 524 -(% class="box" lang="en-US" style="text-align: center;" %) 1326 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1327 + 1328 +(% class="box infomessage" style="text-align: left;" %) 525 525 ((( 526 - (%style="color:#000000; font-size:14pt" %)**Раздел Устройства**1330 +**POST /api/v3/terminalMessages/count** 527 527 ))) 528 528 1333 +(% style="text-align: left;" %) 1334 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1335 + 1336 +(% style="text-align: left;" %) 1337 +Метод запроса **POST** 1338 + 1339 +(% style="text-align: left;" %) 1340 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1341 + 1342 +(% style="text-align: left;" %) 1343 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1344 + 1345 +(% style="text-align: left;" %) 1346 +{ 1347 + "vehicleIds": [ 1348 + id ~/~/ здесь передается список идентификаторов объектов 1349 + ], 1350 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1351 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1352 +} 1353 + 1354 +(% style="text-align: left;" %) 1355 +Ответ: 1356 + 1357 +(% style="text-align: left;" %) 1358 +[ 1359 + { 1360 + "vehicleId": 0, ~/~/ идентификатор объекта 1361 + "count": 0 ~/~/ количество сообщений за период 1362 + } 1363 +] 1364 + 1365 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1366 + 529 529 (% class="box infomessage" %) 530 530 ((( 531 - (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETdevices/types**1369 +**POST /api/v3/terminalMessages** 532 532 ))) 533 533 534 - (% style="color:#000000" %)Методпозволяетполучитьсписоктипов устройств. Метод возвращает информацию о типах устройствс учетом настроек авторизованного пользователя,указанноговзапросе(обязательный параметрв заголовках запроса - токен авторизации **«X-Auth»**).1372 +Метод возвращает список сообщений терминала объекта за выбранный период. 535 535 536 -(% style="color:#000000" %)Метод запроса: **GET** 1374 +(% style="text-align: left;" %) 1375 +Метод запроса **POST** 537 537 538 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1377 +(% style="text-align: left;" %) 1378 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 539 539 1380 +(% style="text-align: left;" %) 540 540 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 541 541 542 -(% style="color:#000000" %)Ответ: [ 1383 +{ 1384 + "vehicleId": 0, ~/~/ id объекта 1385 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1386 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1387 +} 543 543 544 -(% class="western" %) 545 -{{{ { 546 - "deviceTypeId" : "", // ID типа устройства 547 - "deviceTypeName" : "" // Название типа устройства 548 - },}}} 1389 +Ответ: 549 549 550 -(% style="text-align:left" %) 551 -(% style="color:#000000" %)…** **] 1391 +[ 1392 + { 1393 + "messages": [ 1394 + { 1395 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1396 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1397 + "speed": 0, ~/~/ Скорость, км/ч 1398 + "altitude": 0, ~/~/ Высота, м 1399 + "latitude": 0, ~/~/ Широта [-90°;90°] 1400 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1401 + "satellites": 0, ~/~/ Кол-во спутников 1402 + "voltage": 0, ~/~/ Напряжение 1403 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1404 + "additionalProp1": "string", 1405 + "additionalProp2": "string", 1406 + "additionalProp3": "string" 1407 + }, 1408 + "photoCount": 0 ~/~/ Кол-во фото 1409 + } 1410 + ] 1411 + } 1412 +] 552 552 1414 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 553 553 554 -(% class="box" style="text-align: center;" %) 1416 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1417 + 1418 +(% class="box infomessage" %) 555 555 ((( 556 - (%style="color:#000000; font-size:14pt" %)**Раздел Датчики**1420 +**POST /api/v3/notifications/find** 557 557 ))) 558 558 1423 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1424 + 1425 +(% style="text-align: left;" %) 1426 +Метод запроса **POST** 1427 + 1428 +(% style="text-align: left;" %) 1429 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 1430 + 1431 +(% style="text-align: left;" %) 1432 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1433 + 1434 +{ 1435 + "parentId": "" ~/~/ id клиента 1436 +} 1437 + 1438 +Ответ: 1439 + 1440 +[ 1441 + { 1442 + "id": 0, ~/~/ ID уведомления 1443 + "name": "string", ~/~/ Название уведомления 1444 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1445 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1446 + "userId": "", ~/~/ Пользователь, создавший уведомление 1447 + "parentId": "", ~/~/ Идентификатор клиента 1448 + "parentName": "string" ~/~/ Имя клиента 1449 + } 1450 +] 1451 + 1452 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1453 + 559 559 (% class="box infomessage" %) 560 560 ((( 561 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**1456 +**GET /api/v3/notifications/{id}** 562 562 ))) 563 563 564 - (% style="color:#000000" %)Методпозволяет получить список типов датчиков. Метод возвращаетинформацию о типахдатчиков с учетомнастроекавторизованногопользователя, указанного взапросе(обязательный параметр в заголовках запроса - токенавторизации **«X-Auth»**).1459 +Метод возвращает данные правил формирования выбранного уведомления. 565 565 566 -(% style="color:#000000" %)Метод запроса: **GET** 1461 +(% style="text-align: left;" %) 1462 +Метод запроса **GET** 567 567 568 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1464 +(% style="text-align: left;" %) 1465 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 569 569 570 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 1467 +(% style="text-align: left;" %) 1468 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления 571 571 572 -(% style="color:#000000" %)Ответ: [ 1470 +(% style="text-align: left;" %) 1471 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 573 573 574 -(% class="western" style="margin-bottom:19px" %)575 - {{{{}}}1473 +(% style="text-align: left;" %) 1474 +(% style="color:#000000" %)Ответ: 576 576 577 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 1476 +(% style="text-align: left;" %) 1477 +(% style="color:#000000" %){ 1478 + "id": 0, ~/~/ (%%)id уведомления 1479 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1480 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 1481 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 1482 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 1483 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 1484 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 1485 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 1486 +(% style="color:#000000" %) 0 1487 + ], 1488 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 1489 +(% style="color:#000000" %) 0 1490 + ], 1491 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 1492 +(% style="color:#000000" %) 0 1493 + ], 1494 + "settings": { ~/~/ Список параметров уведомления 1495 + "additionalProp1": "string", 1496 + "additionalProp2": "string", 1497 + "additionalProp3": "string" 1498 + }, 1499 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1500 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1501 +(% style="color:#000000" %) "" 1502 + ], 1503 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1504 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 1505 +(% style="color:#000000" %) "string" 1506 + ], 1507 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 1508 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 1509 +(% style="color:#000000" %) { 1510 + "id": 0, ~/~/ (%%)Идентификатор участника чата 1511 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 1512 +(% style="color:#000000" %) } 1513 + ], 1514 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 1515 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 1516 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1517 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 1518 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1519 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 1520 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 1521 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 1522 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1523 +(% style="color:#000000" %)} 578 578 579 -(% class="western" %) 580 -{{{ "description": "" // Описание 581 - },}}} 1525 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 582 582 583 -(% style="text-align:left" %) 584 -(% style="color:#000000" %)… ] 1527 +(% class="box warningmessage" %) 1528 +((( 1529 +**PUT /api/v3/notifications/** 1530 +))) 585 585 1532 +Метод позволяет отредактировать уведомление. 586 586 1534 +Метод запроса **PUT** 1535 + 1536 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 1537 + 1538 +В заголовках запроса: X-Auth: Токен авторизации 1539 + 1540 +Тело запроса: 1541 +{ 1542 + "id": 0, ~/~/ id уведомления 1543 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 1544 + "userId": "", ~/~/ Пользователь, создавший уведомление 1545 + "parentId": "", ~/~/ Идентификатор клиента 1546 + "parentName": "string", ~/~/ Имя клиента 1547 + "name": "string", ~/~/ Название уведомления 1548 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 1549 + "vehicleIds": [ ~/~/ Список id объектов для анализа 1550 + 0 1551 + ], 1552 + "geoids": [ ~/~/ Список id геообъектов для анализа 1553 + 0 1554 + ], 1555 + "fieldids": [ ~/~/ Список id полей для анализа 1556 + 0 1557 + ], 1558 + "settings": { ~/~/ Список параметров уведомления 1559 + "additionalProp1": "string", 1560 + "additionalProp2": "string", 1561 + "additionalProp3": "string" 1562 + }, 1563 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 1564 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1565 + "" 1566 + ], 1567 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 1568 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1569 + "string" 1570 + ], 1571 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 1572 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1573 + { 1574 + "id": 0, ~/~/ Идентификатор участника чата 1575 + "info": "string" ~/~/ Дополнительные сведения 1576 + } 1577 + ], 1578 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 1579 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 1580 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 1581 + "kind": 0, ~/~/ Определяет вид уведомления 1582 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 1583 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 1584 + "timezone": 0, ~/~/ Сдвиг часового пояса 1585 + "validity": 0, ~/~/ Срок действия в днях (1-90) 1586 + "autoProlongation": true ~/~/ Автопродление срока действия 1587 +} 1588 + 1589 +Ответ: 1590 + 1591 +Success 1592 + 1593 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1594 + 1595 +(% class="box errormessage" %) 1596 +((( 1597 +**DELETE /api/v3/notifications/{id}** 1598 +))) 1599 + 1600 +Метод позволяет удалить выбранное уведомление. 1601 + 1602 +Метод запроса **DELETE** 1603 + 1604 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1605 + 1606 +Передаваемый параметр: {id} - id уведомления 1607 + 1608 +В заголовках запроса: X-Auth: Токен авторизации 1609 + 1610 +Ответ: 1611 + 1612 +Success 1613 + 587 587 (% class="box" lang="en-US" style="text-align: center;" %) 588 588 ((( 589 589 (% 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]] **