Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/28 11:43
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Artem1 +XWiki.krainovim - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Public API|API - Content
-
... ... @@ -1,62 +1,68 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 -== Описание ГЛОНАССSoft Public API == 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" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET**(%%)**/(% lang="en-US" %)api/v3/agents(%%)**25 +(% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) 27 27 28 -(% style="color:#000000" %) сновныепараметры клиентов: наименование,полноенаименование,тип, статусиидентификатор клиента-родителя.Методвозвращаетинформациюоклиентахс учетом настроекавторизованногопользователя,указанногов запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль. 29 29 30 -(% style="color:#000000" %) − информация о клиентах предоставляетсяпри наличииправа «Просмотрклиентов»;30 +(% style="color:#000000" %)Метод запроса: **POST** 31 31 32 -(% style="color:#000000" %) − возвращается информация о клиенте, которомупринадлежит авторизованныйпользователь, и его дочерних клиентах;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" %) −информацияо клиентетипа «Партнер»и его подклиентоввозвращается при наличииправа «Доступ к партнёрским клиентам».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 -(% style="color:#000000" %) Методзапроса:**GET**36 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 38 -(% 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> 38 +(% style="color:#000000" %){ 39 + "login": "testuser", 40 + "password": "testuser" 41 +} 39 39 40 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 41 41 42 -(% style="color:#000000" %) В заголовках запроса: X-Auth: Токен авторизации44 +(% style="color:#000000" %)**Ответ:** 43 43 44 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ] 46 +(% lang="en-US" %) 47 +(% style="color:#000000" %){ 45 45 46 -(% 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" %)] 49 +(% lang="en-US" %) 50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 + "User": "testuser" , ~/~/ имя пользователя 47 47 53 +(% lang="en-US" %) 54 +} 48 48 49 -(% class="box" style="text-align: center;" %) 50 -((( 51 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация** 52 -))) 56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 53 53 58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 + 54 54 (% class="box infomessage" %) 55 55 ((( 56 -(% 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** 57 57 ))) 58 58 59 -(% style="color:#000000" %) 65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 60 60 61 61 (% style="color:#000000" %)Метод запроса: **GET** 62 62 ... ... @@ -67,99 +67,253 @@ 67 67 (% lang="en-US" %) 68 68 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».** 69 69 76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) = 70 70 78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) == 79 + 71 71 (% class="box infomessage" %) 72 72 ((( 73 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET/api/v3/auth/login**82 +**GET api/v3/agents/{id}** 74 74 ))) 75 75 76 -(% style="color:#000000" %) Метод позволяетполучитьтокенавторизации, которыйнеобходимодобавлятьвзаголовок дляработы со всемиметодами API.Впараметрахметода передаетсяимяпользователяи пароль.85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 77 77 87 +(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»; 88 + 78 78 (% style="color:#000000" %)Метод запроса: **GET** 79 79 80 -(% 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]]91 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id} 81 81 82 - (% style="color:#000000" %)В случае успешноговыполненияметода, поле «AuthId»содержиттокен авторизации«X-Auth».93 +Запрос должен содержать данные параметра "**agentId**" 83 83 84 -(% lang="en-US" %) 85 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]** 95 +(% style="color:#000000" %)Ответ: 86 86 87 -**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 97 +{ 98 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 99 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 + "isForeign": true/false, ~/~/ Иностранный контрагент 105 + "district": "string", ~/~/ округ 106 + "region": "string", ~/~/ регион 107 + "city": "string", ~/~/ город 108 + "inn": "string", ~/~/ ИНН клиента 109 + "kpp": "string", ~/~/ КПП клиента 110 + "address": "string", ~/~/ юридический адрес 111 + "addressFact": "string", ~/~/ фактический адрес 112 + "email": "string", ~/~/ почта 113 + "director": "string", ~/~/ ФИО руководителя 114 + "bankName": "string", ~/~/ Банк 115 + "bankBIK": "string", ~/~/ БИК 116 + "bankRS": "string", ~/~/ Номер счета 117 + "bankKS": "string" ~/~/ Корр. счет 118 + } 88 88 89 -(% class="box" lang="en-US" style="text-align: center;" %) 90 -((( 91 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства** 92 -))) 120 +== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 93 93 94 94 (% class="box infomessage" %) 95 95 ((( 96 -(% style="color:#000000; line-height:100%" %)**Получениесписка типов устройств**(%style="color:#000000"%)**— **(% lang="en-US" %)**GET /api/v3/devices/types**124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)** 97 97 ))) 98 98 99 -(% style="color:#000000" %) списоктипов устройств. Метод возвращает информацию отипахустройствсучетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 100 100 101 -(% style="color:#000000" %) Методзапроса:**GET**129 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 102 102 103 -(% 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]]131 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 104 104 105 -(% style="color:#000000" %) Взаголовкахзапроса:X-Auth:Токенавторизации133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 106 106 107 -(% style="color:#000000" %) Ответ:[135 +(% style="color:#000000" %)Метод запроса: **POST** 108 108 109 -(% class="western" %) 110 -{{{ { 111 - "deviceTypeId" : "", // ID типа устройства 112 - "deviceTypeName" : "" // Название типа устройства 113 - },}}} 137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find 114 114 115 -(% style="text-align:left" %) 116 -(% style="color:#000000" %)…** **] 139 +(% style="color:#000000" %)Параметр запроса: 117 117 141 +(% style="color:#000000" %){ 142 + "parentId": "string" 143 +} 118 118 119 -(% class="box" style="text-align: center;" %) 145 +(% style="color:#000000" %)Ответ: 146 + 147 +{ 148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 154 + "isForeign": true/false, ~/~/ Иностранный контрагент 155 + "district": "string", ~/~/ округ 156 + "region": "string", ~/~/ регион 157 + "city": "string", ~/~/ город 158 + "inn": "string", ~/~/ ИНН клиента 159 + "kpp": "string", ~/~/ КПП клиента 160 + "address": "string", ~/~/ юридический адрес 161 + "addressFact": "string", ~/~/ фактический адрес 162 + "email": "string", ~/~/ почта 163 + "director": "string", ~/~/ ФИО руководителя 164 + "bankName": "string", ~/~/ Банк 165 + "bankBIK": "string", ~/~/ БИК 166 + "bankRS": "string", ~/~/ Номер счета 167 + "bankKS": "string" ~/~/ Корр. счет 168 + } 169 + 170 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 171 + 172 +(% class="box successmessage" %) 120 120 ((( 121 - (%style="color:#000000; font-size:14pt"%)**Раздел Датчики**174 +**POST /api/v3/agents ** 122 122 ))) 123 123 124 -(% class="box infomessage" %) 177 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 178 + 179 +Метод запроса: **POST** 180 + 181 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 182 + 183 +В заголовках запроса: X-Auth: Токен авторизации 184 + 185 +Параметры в теле запроса (JSON): 186 + 187 +{ 188 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 189 + "name": "string", ~/~/ имя 190 + "fullName": "string", ~/~/ полное наименование 191 + "isForeign": true, ~/~/ иностранный контрагент 192 + "district": "string", ~/~/ округ 193 + "region": "string", ~/~/ регион 194 + "city": "string", ~/~/ город 195 + "inn": "string", ~/~/ ИНН 196 + "kpp": "string", ~/~/ КПП 197 + "address": "string", ~/~/ юридический адрес 198 + "addressFact": "string", ~/~/ фактический адрес 199 + "email": "string", ~/~/ email 200 + "director": "string", ~/~/ ФИО руководителя 201 + "bankName": "string", ~/~/ банк 202 + "bankBIK": "string", ~/~/ БИК 203 + "bankRS": "string", ~/~/ номер счёта 204 + "bankKS": "string" ~/~/ корр. счёт 205 +} 206 + 207 + 208 +Ответ: 209 + 210 +{ 211 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 213 + "name": "string", ~/~/ имя 214 + "fullName": "string", ~/~/ полное наименование 215 + "isForeign": true, ~/~/ иностранный контрагент 216 + "district": "string", ~/~/ округ 217 + "region": "string", ~/~/ регион 218 + "city": "string", ~/~/ город 219 + "inn": "string", ~/~/ ИНН 220 + "kpp": "string", ~/~/ КПП 221 + "address": "string", ~/~/ юридический адрес 222 + "addressFact": "string", ~/~/ фактический адрес 223 + "email": "string", ~/~/ email 224 + "director": "string", ~/~/ ФИО руководителя 225 + "bankName": "string", ~/~/ банк 226 + "bankBIK": "string", ~/~/ БИК 227 + "bankRS": "string", ~/~/ номер счёта 228 + "bankKS": "string" ~/~/ корр. счёт 229 +} 230 + 231 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 232 + 233 +(% class="box warningmessage" %) 125 125 ((( 126 - (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GETsensors/types**235 +**PUT /api/v3/agents** 127 127 ))) 128 128 129 - (% style="color:#000000" %)Метод позволяетполучить список типовдатчиков. Метод возвращаетинформациюотипах датчиковс учетом настроекавторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).238 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 130 130 131 - (% style="color:#000000" %)Метод запроса: **GET**240 +Метод запроса: **PUT** 132 132 133 - (% style="color:#000000" %)URL(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]242 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]] 134 134 135 - (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации244 +В заголовках запроса: X-Auth: Токен авторизации 136 136 137 -(% style="color:#000000" %)Ответ: [ 138 138 139 -(% class="western" style="margin-bottom:19px" %) 140 -{{{ {}}} 247 +Параметры в теле запроса (JSON): 141 141 142 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 249 +{ 250 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 251 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 252 + "name": "string", ~/~/ имя 253 + "fullName": "string", ~/~/ полное наименование 254 + "isForeign": true, ~/~/ иностранный контрагент 255 + "district": "string", ~/~/ округ 256 + "region": "string", ~/~/ регион 257 + "city": "string", ~/~/ город 258 + "inn": "string", ~/~/ ИНН 259 + "kpp": "string", ~/~/ КПП 260 + "address": "string", ~/~/ юридический адрес 261 + "addressFact": "string", ~/~/ фактический адрес 262 + "email": "string", ~/~/ email 263 + "director": "string", ~/~/ ФИО руководителя 264 + "bankName": "string", ~/~/ банк 265 + "bankBIK": "string", ~/~/ БИК 266 + "bankRS": "string", ~/~/ номер счёта 267 + "bankKS": "string" ~/~/ корр. счёт 268 +} 143 143 144 -(% class="western" %) 145 -{{{ "description": "" // Описание 146 - },}}} 147 147 148 -(% style="text-align:left" %) 149 -(% style="color:#000000" %)… ] 271 +Ответ: 150 150 273 +{ 274 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента 275 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 276 + "name": "string", ~/~/ имя 277 + "fullName": "string", ~/~/ полное наименование 278 + "isForeign": true, ~/~/ иностранный контрагент 279 + "district": "string", ~/~/ округ 280 + "region": "string", ~/~/ регион 281 + "city": "string", ~/~/ город 282 + "inn": "string", ~/~/ ИНН 283 + "kpp": "string", ~/~/ КПП 284 + "address": "string", ~/~/ юридический адрес 285 + "addressFact": "string", ~/~/ фактический адрес 286 + "email": "string", ~/~/ email 287 + "director": "string", ~/~/ ФИО руководителя 288 + "bankName": "string", ~/~/ банк 289 + "bankBIK": "string", ~/~/ БИК 290 + "bankRS": "string", ~/~/ номер счёта 291 + "bankKS": "string" ~/~/ корр. счёт 292 +} 151 151 152 -(% class="box" style="text-align: center;" %) 294 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) == 295 + 296 +(% class="box errormessage" %) 153 153 ((( 154 - (%style="color:#000000; font-size:14pt" %)**Раздел Пользователи**298 +**DELETE /api/v3/agents/{clientId}** 155 155 ))) 156 156 301 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»). 302 + 303 +Метод запроса: **DELETE** 304 + 305 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}** 306 + 307 +Параметр запроса: **{clientId}** - Guid пользователя 308 + 309 +В заголовках запроса: X-Auth: Токен авторизации 310 + 311 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 312 + 313 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 314 + 315 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == 316 + 157 157 (% class="box successmessage" %) 158 158 ((( 159 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**319 +(% lang="en-US" %)**POST /api/v3/users** 160 160 ))) 161 161 162 -(% style="color:#000000" %) 322 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 163 163 164 164 (% style="color:#000000" %)Метод запроса: **POST** 165 165 ... ... @@ -167,18 +167,161 @@ 167 167 168 168 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 169 169 170 -(% 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»: [ // группы пользователя «», //названия групп «», «» ] }330 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 171 171 332 +(% style="color:#000000" %){ 333 + "lastName": "", ~/~/ фамилия 334 + "firstName": "", ~/~/ имя 335 + "position": "", ~/~/ должность 336 + "phone": "", ~/~/ телефон 337 + "organization": "", ~/~/ организация 338 + "login": "", ~/~/ логин (обязателен) 339 + "password": "", ~/~/ пароль (обязателен) 340 + "email": "", ~/~/ email (обязателен) 341 + "description": "", ~/~/ описание 342 + "isEnabled": "", ~/~/ признак включения 343 + "parentId": "", ~/~/ Guid родительского агента 344 + "leaderId": "", ~/~/ Guid руководителя (null - не задан) 345 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 346 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 347 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 348 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 349 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row) 350 +} 351 + 172 172 (% style="text-align:left" %) 173 -(% 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» //названия групп ] }353 +(% style="color:#000000; font-weight:normal" %)Ответ: 174 174 355 +(% style="text-align:left" %) 356 +(% style="color:#000000; font-weight:normal" %){ 175 175 358 +(% style="text-align:left" %) 359 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 360 + "lastName": "" , ~/~/ Фамилия , 361 + "firstName": "" , ~/~/ Имя 362 + "position": "" , ~/~/ Должность 363 + "phone": "" , ~/~/ Телефон 364 + "organization": "" , ~/~/ Организация 365 + "login": "" , ~/~/ Логин 366 + "password": "" , ~/~/ Пароль 367 + "email": "" , ~/~/ Email 368 + "description": "" , ~/~/ Описание 369 + "isEnabled": "" , ~/~/ Признак включения 370 + "parentId": "" , ~/~/ Guid родительского агента 371 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах 372 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 373 + "kind": "" , ~/~/ тип аутентификации 374 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 375 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 376 + 377 +(% style="text-align:left" %) 378 +(% style="color:#000000; font-weight:normal" %)} 379 + 380 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 381 + 382 +(% class="box successmessage" %) 383 +((( 384 +(% lang="en-US" %)**POST /api/v3/users/find** 385 +))) 386 + 387 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 388 + 389 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 390 + 391 +(% style="color:#000000" %)Метод запроса: **POST** 392 + 393 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 394 + 395 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 396 + 397 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 398 + 399 +(% style="color:#000000" %){ 400 + 401 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 402 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 403 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 404 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 405 + 406 +(% style="color:#000000" %)} 407 + 408 +(% style="color:#000000" %)Ответ: 409 + 410 +(% style="color:#000000" %){ (%%) 411 + 412 + "id": "" , ~/~/ идентификатор пользователя 413 + "lastName": "" , ~/~/ фамилия 414 + "firstName": "" , ~/~/ имя 415 + "position": "" , ~/~/ должность 416 + "phone": "" , ~/~/ телефон 417 + "parentId": "" , ~/~/ идентификатор клиента-родителя 418 + "parentName": "" , ~/~/ наименование клиента-родителя 419 + "organization": "" , ~/~/ организация 420 + "login": "" , ~/~/ логин 421 + "email": "" , ~/~/ E-mail 422 + "sessionDuration":"", ~/~/ длительность сессии в минутах 423 + "status": "1", ~/~/ статус пользователя 424 + "astLogged": "", ~/~/ дата/время последней авторизации 425 + 426 +(% style="color:#000000" %)} 427 + 428 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == 429 + 430 +(% class="box infomessage" %) 431 +((( 432 +(% lang="en-US" %)**GET /api/v3/users/{GUID}** 433 +))) 434 + 435 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**. 436 + 437 +(% style="color:#000000" %)Метод запроса: **GET** 438 + 439 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]] 440 + 441 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 442 + 443 +(% style="color:#000000" %)Ответ: 444 + 445 +((( 446 +((( 447 +{ 448 + "id": "", ~/~/ GUID пользователя 449 + "lastName": "", ~/~/ Фамилия 450 + "firstName": "", ~/~/ Имя 451 + "position": "", ~/~/ Должность 452 + "phone": "", ~/~/ Номер телефона 453 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 454 + "parentName": "", Наименование клиента, которому принадлежит пользователь 455 + "organization": "", ~/~/ Организация 456 + "login": "", ~/~/ Логин пользователя 457 + "email": "", ~/~/ Адрес электронной почты 458 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 459 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 460 + "description": "", ~/~/ Описание 461 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен 462 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 463 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 464 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 465 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах 466 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 467 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 468 + "groups": [], ~/~/ Список ролей пользователя 469 + "customGroups": [], ~/~/ Список клиентских ролей пользователя 470 + "authDevices": [ ], ~/~/ Список авторизованных устройств 471 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 472 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 473 +} 474 +))) 475 +))) 476 + 477 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) == 478 + 176 176 (% class="box warningmessage" %) 177 177 ((( 178 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**481 +(% lang="en-US" %)**PUT /api/v3/users** 179 179 ))) 180 180 181 -(% style="color:#000000" %) 484 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 182 182 183 183 (% style="color:#000000" %)Метод запроса: **PUT** 184 184 ... ... @@ -187,98 +187,165 @@ 187 187 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 188 188 189 189 (% lang="en-US" style="text-align:left" %) 190 -(% 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» //названия групп ] } //493 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 191 191 495 +(% lang="en-US" style="text-align:left" %) 496 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 192 192 498 +(% lang="en-US" style="text-align:left" %) 499 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 500 + "lastName": "" , ~/~/ фамилия 501 + "firstName": "" , ~/~/ имя 502 + "position": "" , ~/~/ должность 503 + "phone": "" , ~/~/ телефон 504 + "organization": "" , ~/~/ организация 505 + "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%) 506 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо) 507 + "email": "" , ~/~/ email (% style="color:#000000" %)(Если null - менять не надо)(%%) 508 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание 509 + "isEnabled": "" , ~/~/ признак включения 510 + "parentId": "" , ~/~/ Guid родительского агента 511 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 512 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 513 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 514 + "kind": "" , ~/~/ тип аутентификации 515 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 516 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 517 + 518 +(% lang="en-US" style="text-align:left" %) 519 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 520 + 521 +(% lang="en-US" style="text-align:left" %) 522 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 523 + 524 +(% lang="en-US" style="text-align:left" %) 525 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 526 + 527 +(% lang="en-US" style="text-align:left" %) 528 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 529 + "lastName": "" , ~/~/ фамилия 530 + "firstName": "" , ~/~/ имя 531 + "position": "" , ~/~/ должность 532 + "phone": "" , ~/~/ телефон 533 + "organization": "" , ~/~/ организация 534 + "login": "" , ~/~/ логин 535 + "password": "" , ~/~/ пароль 536 + "email": "" , ~/~/ email 537 + "description": "" , ~/~/ описание 538 + "isEnabled": "" , ~/~/ признак включения 539 + "parentId": "" , ~/~/ Guid родительского агента 540 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 541 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 542 + "kind": "" , ~/~/ тип аутентификации 543 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес 544 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 545 + 546 +(% lang="en-US" style="text-align:left" %) 547 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 548 + 549 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 550 + 193 193 (% class="box warningmessage" %) 194 194 ((( 195 -(% style="color:#000000" %) **Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**553 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 196 196 ))) 197 197 198 -(% style="color:#000000" %) . Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).556 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 199 199 200 200 (% style="color:#000000" %)Метод запроса: **PUT** 201 201 202 -(% 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} Параметр запроса:560 +(% 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} 203 203 204 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)562 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 205 205 206 -(% class="western" %) 207 -{{{ "description": "", // описание 208 - "data": "" // данные, связанные со сменой статуса}}} 564 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 209 209 566 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 567 + 568 +(% style="color:#000000" %){ 569 + 570 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 571 + "description": "" , ~/~/ описание 572 + "data": "" , ~/~/ данные, связанные со сменой статуса 573 + 210 210 (% style="color:#000000" %)} 211 211 212 212 (% style="text-align:left" %) 213 213 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 214 214 579 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) == 215 215 216 -(% class="box successmessage" %)581 +(% class="box warningmessage" %) 217 217 ((( 218 - (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**583 +**POST /api/v3/users/disable** 219 219 ))) 220 220 221 - (% style="color:#000000" %)Метод позволяет получитьосновныепараметрыпользователей:логин, имя,адрес электронной почты, номертелефона,статус,идентификаторклиента-родителяипрочее.586 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 222 222 223 -(% style="color:#000000" %)Метод возвращает информацию опользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляетсяприналичииправа**«Просмотр пользователей»**.588 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 224 224 225 -(% style="color:#000000" %) Методзапроса:**POST**590 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]] 226 226 227 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]592 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 228 228 229 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): { 594 + [ 595 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 596 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 597 + ] 230 230 231 -(% class="western" %) 232 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 233 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 234 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 235 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 599 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 236 236 237 -(% style="color:#000000" %) }601 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) == 238 238 239 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail 240 - 241 -(% class="western" style="margin-bottom:19px" %) 242 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 243 - 244 -(% lang="en-US" style="text-align:left" %) 245 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 246 - 247 - 248 -(% class="box errormessage" %) 603 +(% class="box warningmessage" %) 249 249 ((( 250 - (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE/api/v3/users/{id}**605 +**POST /api/v3/users/enable** 251 251 ))) 252 252 253 - (% style="color:#000000" %)Метод позволяетудалитьпользователя. Метод позволяетудалитьпользователя, указанного в строкезапроса(обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).608 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 254 254 255 -(% style="color:#000000" %)Метод запроса: ** DELETE**610 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST** 256 256 257 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>> url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}612 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]] 258 258 259 -(% style="color:#000000" %) Параметрзапроса:{id}-Guid пользователя В заголовках запроса: X-Auth: Токенавторизации614 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 260 260 261 -(% style="text-align:left" %) 262 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 616 + [ 617 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 618 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 619 + ] 263 263 621 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 622 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 264 264 265 -(% class="box" style="text-align: center;" %) 266 266 ((( 267 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства** 625 +В теле ответа: 626 +{ 627 + "errorMessages": [ 628 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719." 629 + ], 630 + "users": [ 631 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 632 + ] 633 +} 634 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 635 +"users" - массив id пользователей, которых не удалось включить или отключить. 268 268 ))) 269 269 638 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) == 639 + 270 270 (% class="box errormessage" %) 271 271 ((( 272 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**642 +(% lang="en-US" %)**DELETE /api/v3/users/{id}** 273 273 ))) 274 274 275 -(% style="color:#000000" %) бъект. Метод позволяет удалить объект, указанныйв строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).645 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 276 276 277 277 (% style="color:#000000" %)Метод запроса: **DELETE** 278 278 279 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}649 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 280 280 281 -(% style="color:#000000" %)Параметр запроса: {id} - Guid о бъекта651 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 282 282 283 283 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 284 284 ... ... @@ -285,51 +285,72 @@ 285 285 (% style="text-align:left" %) 286 286 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 287 287 658 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 288 288 660 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 661 + 289 289 (% class="box infomessage" %) 290 290 ((( 291 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**664 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}** 292 292 ))) 293 293 294 -(% style="color:#000000" %) 667 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 295 295 296 -(% style="color:#000000" %) 669 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 297 297 298 298 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 299 299 300 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 673 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 301 301 302 302 (% style="color:#000000" %)Метод запроса: **GET** 303 303 304 304 (% 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> 305 305 306 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 679 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 307 307 308 308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 309 309 310 310 (% style="color:#000000" %)Ответ: 311 311 312 -(% style="color:#000000" %){ 685 +((( 686 +{ 687 + "vehicleId": "", ~/~/ ID объекта 688 + "name": "", ~/~/ Имя объекта 689 + "imei": "", ~/~/ IMEI объекта 690 + "deviceTypeId": , ~/~/ ID типа устройства 691 + "deviceTypeName": "", ~/~/ Название типа устройства 692 + "sim1": "", ~/~/ Номер SIM1 693 + "parentId": "", Номер SIM2 694 + "parentName": "", Наименование клиента-родителя 695 + "modelId": "", ID модели объекта 696 + "modelName": "", Имя модели объекта 697 + "createdAt": "", Дата создания объекта 698 + "mileageCalcMethod": "", Выбранный метод расчета пробега 699 + "counters": { ~/~/ Нормы 700 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 701 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 702 + "mileage": "", ~/~/ Пробег по нормам в метрах 703 + "motohours": "" ~/~/ Моточасы по нормам, в секундах 704 + }, 705 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 706 + { 707 + "id": "", ~/~/ ID задания 708 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 709 + "name": "", ~/~/ Наименование задания 710 + "description": "", ~/~/ Описание задания 711 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 712 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 713 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 714 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 715 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 716 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 717 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 718 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 719 + } 720 + ] 721 +} 722 +))) 313 313 314 -(% class="western" %) 315 -{{{ "vehicleId": “”, // идентификатор объекта 316 - "name": "", // имя объекта 317 - "imei": "", // IMEI объекта 318 - "deviceTypeId": “”, // идентификатор устройства объекта 319 - "deviceTypeName": "" // наименование устройства объекта 320 - "parentId": "", // идентификатор клиента-родителя 321 - "parentName": "" // наименование клиента-родителя, 322 - "modelId": "", // идентификатор модели объекта 323 - "modelName": "" // наименование модели объекта, 324 - "unitId": "", // идентификатор подразделения 325 - "unitName": "", // наименование подразделения 326 - "status": “”, // статус объекта 327 - ... 328 - }, 329 - ...}}} 330 - 331 -(% style="color:#000000" %)} 332 - 333 333 (% style="text-align:left" %) 334 334 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 335 335 ... ... @@ -336,13 +336,14 @@ 336 336 (% style="text-align:left" %) 337 337 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 338 338 730 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 339 339 340 340 (% class="box successmessage" %) 341 341 ((( 342 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**734 +(% lang="en-US" %)**POST /api/v3/vehicles** 343 343 ))) 344 344 345 -(% style="color:#000000" %) 737 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 346 346 347 347 (% style="color:#000000" %)Метод запроса: **POST** 348 348 ... ... @@ -350,239 +350,485 @@ 350 350 351 351 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 352 352 353 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {745 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 354 354 355 -(% class="western" %) 356 -{{{ "parentId": "", // ID клиента 357 - "name": "", // имя ТС 358 - "imei": "", // IMEI 359 - "deviceTypeId": "",// ID типа устройства 360 - "modelId": "", 361 - "unitId": "", // ID подразделения 362 - "sim1": "", // Номер SIM 1 363 - "sim2": "", // Номер SIM2 364 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 365 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 366 - "consumptionIdle": "",// Расход топлива на холостом ходу 367 - "counters": { 368 - "mileage": "", // пробег 369 - "mileageEnabled": true, // флаг активности счётчика "пробег" 370 - "motohours":"", // моточасы 371 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 372 - }, 373 - "cmsv6Parameters": { // параметры CMSv6 374 - "enabled": true, // флаг включения 375 - //"id": "", // идентификатор 376 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 377 - "login": "", // имя учетной записи 378 - "password": "" // пароль учетной записи 379 - }, 380 - "inspectionTasks": [ // задания на ТО 747 +(% style="color:#000000" %){ 748 + 749 + "parentId": "" , ~/~/ ID клиента 750 + "name": "" , ~/~/ имя ТС 751 + "imei": "" , ~/~/ IMEI 752 + "deviceTypeId": "" , ~/~/ ID типа устройства 753 + "modelId": "" , ~/~/ ID модели 754 + "unitId": "" , ~/~/ ID подразделения 755 + "sim1": "" , ~/~/ Номер SIM 1 756 + "sim2": "" , ~/~/ Номер SIM2 757 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 758 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 759 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 760 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 761 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 762 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 763 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 764 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 765 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 766 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 767 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 768 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 769 + "counters": ~/~/ счетчики 381 381 { 382 - "enabled": "", // Признак включения 383 - "name": "", // Имя задания 384 - "description": "", // Описание задания 385 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 386 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 387 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 388 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 389 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 390 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 391 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 392 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 771 + "mileage": "" , ~/~/ пробег 772 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 773 + "motohours": "" , ~/~/ моточасы 774 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 393 393 }, 394 - ]}}} 776 + "cmsv6Parameters": { ~/~/ параметры CMSv6 777 + "enabled": true, ~/~/ флаг включения 778 + "id": "" , ~/~/ идентификатор 779 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 780 + "login": "" , ~/~/ имя учетной записи 781 + "password": "" ~/~/ пароль учетной записи 782 + }, 783 + "inspectionTasks": ~/~/ задания на ТО 784 + { 785 + "enabled": "" , ~/~/ Признак включения 786 + "name": "" , ~/~/ Имя задания 787 + "description": "" , ~/~/ Описание задания 788 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 789 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 790 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 791 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 792 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 793 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 794 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 795 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 796 + } 395 395 396 -(% style="color:#000000" %) …}798 +(% style="color:#000000" %) } 397 397 398 398 (% style="color:#000000" %)Ответ: 399 399 400 400 (% style="color:#000000" %){ 401 401 402 -(% class="western" %) 403 -{{{ "vehicleId": "", //ID ТС 404 - "parentId": "", //Guid владельца ТС 405 - "name": "", //Имя объекта 406 - "imei": "", //IMEI 407 - "deviceTypeId": "", //ID типа устройства 408 - "modelId": "", //ID модели 409 - "unitId": "", //ID подразделения 410 - "sim1": "", //SIM1 411 - "sim2": "", //SIM2 412 - "consumptionPer100Km": "", //Расход топлива на 100 км 413 - "consumptionIdle": "", //Расход топлива на холостом ходу 414 - "counters": { //Счётчики 415 - "mileageEnabled": true, 416 - "motohoursEnabled": true, 417 - "mileage": "", 418 - "motohours": 345.0 419 - }, 420 - "cmsv6Parameters": { //Параметры CmsV6 421 - "id": null, 422 - "enabled": true, //флаг включения 423 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 424 - "login": "", // имя учетной записи 425 - "password": "" // пароль учетной записи 426 - }, 427 - "inspectionTasks": [ // задания на ТО 428 - { 429 - "id": "", // ID задачи 430 - "enabled": false, // Признак включения 431 - "name": "", // Имя задания 432 - "description": "", // Описание задания 433 - "mileageCondition": "", // Условие по пробегу 434 - "lastMileage": "", // Пробег (в метрах) 435 - "motohoursCondition": "", // Условие по моточасам 436 - "lastMotohours": "", // Моточасы 437 - "periodicCondition": "", // Условие периодичности по времени 438 - "kind": "", // Вид периодичности по времени 439 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 440 - } 441 - ]}}} 804 + "vehicleId": "", ~/~/ID ТС 805 + "parentId": "", ~/~/Guid владельца ТС 806 + "name": "", ~/~/Имя объекта 807 + "imei": "", ~/~/IMEI 808 + "deviceTypeId": "", ~/~/ID типа устройства 809 + "modelId": "", ~/~/ID модели 810 + "unitId": "", ~/~/ID подразделения 811 + "sim1": "", ~/~/SIM1 812 + "sim2": "", ~/~/SIM2 813 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 814 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 815 + "counters": { ~/~/Счётчики 816 + "mileageEnabled": true, 817 + "motohoursEnabled": true, 818 + "mileage": "", 819 + "motohours": 345.0 820 + }, 821 + "cmsv6Parameters": { ~/~/Параметры CmsV6 822 + "id": null, 823 + "enabled": true, ~/~/флаг включения 824 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 825 + "login": "", ~/~/ имя учетной записи 826 + "password": "" ~/~/ пароль учетной записи 827 + }, 828 + "inspectionTasks": { ~/~/ задания на ТО 829 + "id": "", ~/~/ ID задачи 830 + "enabled": false, ~/~/ Признак включения 831 + "name": "", ~/~/ Имя задания 832 + "description": "", ~/~/ Описание задания 833 + "mileageCondition": "", ~/~/ Условие по пробегу 834 + "lastMileage": "", ~/~/ Пробег (в метрах) 835 + "motohoursCondition": "", ~/~/ Условие по моточасам 836 + "lastMotohours": "", ~/~/ Моточасы 837 + "periodicCondition": "", ~/~/ Условие периодичности по времени 838 + "kind": "", ~/~/ Вид периодичности по времени 839 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 840 + } 442 442 443 443 (% style="text-align:left" %) 444 444 (% style="color:#000000" %)} 445 445 845 +**Валидация:** 846 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 847 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 848 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 446 446 447 -(% class="box warningmessage" %) 850 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 851 + 852 +(% class="box successmessage" %) 448 448 ((( 449 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**854 +(% lang="en-US" %)**POST /api/v3/vehicles/find** 450 450 ))) 451 451 452 -(% style="color:#000000" %) редактироватьобъект.Метод позволяетотредактировать объект,указанный в запросе(обязательныйпараметрвзаголовкахзапроса- токенавторизации **«X-Auth»**).857 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 453 453 454 -(% style="color:#000000" %)Метод запроса :**PUT**859 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 455 455 456 -(% style="color:#000000" %) URLзапроса:(%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]861 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 457 457 458 -(% style="color:#000000" %) Взаголовках запроса:X-Auth:Токен авторизации863 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 459 459 865 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 866 + 867 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 868 + 869 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 870 + 871 +(% style="color:#000000" %)Метод запроса: **POST** 872 + 873 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]] 874 + 875 +(% style="color:#000000" %)В заголовках запроса: 876 + 877 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 878 + 879 +(% style="color:#000000" %)− X-Auth: Токен авторизации 880 + 881 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 882 + 460 460 (% style="color:#000000" %)Параметры в теле запроса (JSON): 461 461 462 -(% 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»: «» //Сколько раз выполнить задание } ] } 885 +{ 886 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 887 + "name": null, ~/~/ Имя ТС (string, опционально) 888 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 889 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 890 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 891 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 892 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 893 + "customFields": null ~/~/ значение любого из произвольных полей ТС 894 +} 463 463 896 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 897 + 464 464 (% style="color:#000000" %)Ответ: 465 465 466 -(% lang="en-US" style="text-align:left" %) 467 -(% 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»: «» //Сколько раз выполнить задание } ] } 900 +(% style="color:#000000" %){ 468 468 902 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 903 + "name": "" ~/~/ наименование объекта 904 + "imei": "" ~/~/ IMEI объекта 905 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 906 + "deviceTypeName": "" ~/~/ наименование типа устройства 907 + "sim1": "" ~/~/ первый номер телефона 908 + "sim2": "" ~/~/ второй номер телефона 909 + "parentId": "" ~/~/ идентификатор клиента-родителя 910 + "parentName": "" ~/~/ наименование клиента-родителя 911 + "modelId": "" ~/~/ идентификатор модели объекта 912 + "modelName": "" ~/~/ наименование модели объекта 913 + "unitId": "" ~/~/ идентификатор подразделения 914 + "unitName": "" ~/~/ наименование подразделения 915 + "status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 916 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 917 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 918 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов 919 + "customFields": [ 920 + { 921 + "id": "", ~/~/ идентификатор произвольного поля 922 + "name": "", ~/~/ имя произвольного поля 923 + "value": "", ~/~/ значение произвольного поля 924 + "forClient": true, ~/~/ право на отображение у клиента 925 + "forTooltip": false, ~/~/ право на отображение в подсказке 926 + "forReport": false ~/~/ право на отображение в отчетах 927 + }(%%) 928 +(% style="color:#000000" %)} 469 469 930 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 931 + 932 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == 933 + 470 470 (% class="box successmessage" %) 471 471 ((( 472 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**936 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 473 473 ))) 474 474 475 -(% style="color:#000000" %) получитьосновные параметрыобъектов:наименование, IMEI,типустройства,модель объекта,подразделение,номера телефонови идентификаторклиента,ккоторомуприкрепленобъект (клиент-родитель).939 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 476 476 477 -(% style="color:#000000" %) возвращает информацию об объектах с учетом настроек авторизованногопользователя, указанного в запросе (обязательныйпараметр в заголовках запроса - токен авторизации**«X-Auth»**):941 +(% style="color:#000000" %)Метод запроса: **POST** 478 478 479 -(% style="color:#000000" %) − возвращается информацияоб объектахклиента-родителяавторизованногопользователя и объектах его дочерних клиентов;943 +(% 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} 480 480 481 -(% style="color:#000000" %) − возвращаетинформациюоб объектах с учетомзаданных настроек видимостиобъектов;945 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 482 482 483 -(% style="color:#000000" %) −информация предоставляется с учетом наличия правна просмотр объектов заблокированныхдоговоров (объекты, принадлежащиезаблокированному договору возвращаются при наличиилюбогоиз прав «Видимость объектов заблокированныхдоговоров в панели управления» или «Видимостьобъектовзаблокированных договоров в мониторинге»;947 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 484 484 485 -(% style="color:#000000" %) − информация о телефонах SIM1/SIM2 предоставляется приналичии права«Просмотр номеров телефоновобъектов»;949 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 486 486 487 -(% style="color:#000000" %) − информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».951 +(% style="color:#000000" %){ 488 488 489 -(% style="color:#000000" %)Метод запроса: **POST** 953 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 954 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 955 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 956 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 957 + "description": "", ~/~/ Описание 958 + "data": "", ~/~/ Данные 959 + "overwrite": false, ~/~/ Флаг перезаписи 960 + "stage": "", ~/~/ Состояние, может быть null 490 490 491 -(% style="color:#000000" %) URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]962 +(% style="color:#000000" %)} 492 492 493 -(% style="color:#000000" %) В заголовках запроса:964 +(% style="color:#000000" %)Ответ: 494 494 495 -(% style="color:#000000" %) − Content-Type: application/json966 +(% style="color:#000000" %){ 496 496 497 -(% style="color:#000000" %)− X-Auth: Токен авторизации 968 + "status": "", ~/~/ значение статуса 969 + "date": "", ~/~/ Дата смены статуса 970 + "description": "", ~/~/ Описание 971 + "data": "", ~/~/ Данные 972 + "overwrite": false, ~/~/ Флаг перезаписи 973 + "stage": "", ~/~/ Состояние 498 498 499 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 975 +(% style="text-align:left" %) 976 +(% style="color:#000000" %) } 500 500 501 -(% class="western" style="color:#000000"%)##{"vehicleId":null,~/~/84350, ~/~/ ID ТС (int, опционально)"name": null, ~/~/ Имя ТС (string,опционально)"imei": null,~/~/"710179307",##978 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 502 502 503 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 980 +(% class="box warningmessage" %) 981 +((( 982 +(% lang="en-US" %)**PUT /api/v3/vehicles** 983 +))) 504 504 505 -(% class="western" style="color:#000000" %)##~/~/IDтипаустройства(short,опционально)"parentId": null,~/~/IDклиента(Guid,опционально)"unitId": null##985 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 506 506 507 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения(Guid, опционально)##(% style="color:#000000"%)}987 +(% style="color:#000000" %)Метод запроса: **PUT** 508 508 509 -(% style="color:#000000" %) Фильтрация осуществляетсяпоточномусовпадениюзначений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».989 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]] 510 510 511 -(% style="color:#000000" %) Ответ:[ { «vehicleId»: «», //идентификаторобъекта «name»: «», // наименование объекта«imei»: «», // IMEI объекта«deviceTypeId»: «», // идентификатор типа устройства«deviceTypeName»:«», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»:«», //наименованиеклиента-родителя«modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификаторподразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 512 512 513 -(% style="color:#000000" %) «sim1» и «sim2» содержатсявответе при наличии у авторизованного пользователяправа **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованногопользователя права **«Просмотр статусаобъекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:993 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 514 514 515 -(% style="color:#000000" %) 0- «Блокировка»995 +(% style="color:#000000" %){ 516 516 517 -(% style="color:#000000" %)1 - «Активен», 997 +((( 998 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 999 + "parentId": "", ~/~/ ID клиента 1000 + "name": "", ~/~/ имя ТС 1001 + "imei": "", ~/~/ IMEI 1002 + "deviceTypeId": "", ~/~/ ID типа устройства 1003 + "modelId": "", ~/~/ , ID модели 1004 + "unitId": "", ~/~/ подразделения 1005 + "sim1": "", ~/~/ SIM 1 1006 + "sim2": "", ~/~/ SIM2 (%%) 1007 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1008 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1009 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1010 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1011 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1012 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1013 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1014 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1015 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1016 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1017 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1018 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1019 +(% style="color:#000000" %) "counters": 1020 + { 1021 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1022 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1023 + "mileage": "", ~/~/ пробег, в метрах 1024 + "motohours": "" ~/~/ моточасы, в секундах 1025 + } 1026 + "cmsv6Parameters": ~/~/ параметры CMSv6 1027 + { 1028 + "id": "", ~/~/ идентификатор 1029 + "enabled": true, ~/~/ флаг включения 1030 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1031 + "login": "", ~/~/ имя учетной записи 1032 + "password": "", ~/~/ пароль учетной записи 1033 + } 1034 + "inspectionTasks": ~/~/ задания на ТО 1035 + { 1036 + "id": "", ~/~/ ID задания 1037 + "enabled": false, ~/~/ Признак включения 1038 + "name": "", ~/~/ Имя задания 1039 + "description": "", ~/~/ Описание задания 1040 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1041 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1042 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1043 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1044 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1045 + "kind": "", ~/~/ Вид периодичности по времени 1046 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1047 + } 1048 +))) 518 518 519 -(% style="color:#000000" %) 2 - «Отменен»1050 +(% style="color:#000000" %)} 520 520 521 -(% style="color:#000000" %) 3 - «Оборудован»1052 +(% style="color:#000000" %)Ответ: 522 522 523 -(% style="color:#000000" %)4 - «Диагностика» 1054 +(% lang="en-US" style="text-align:left" %) 1055 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 524 524 525 -(% style="color:#000000" %)5 - «Сервис» 1057 +(% lang="en-US" style="text-align:left" %) 1058 + "vehicleId": "", ~/~/ ID ТС 1059 + "parentId": "", ~/~/ ID клиента 1060 + "name": "", ~/~/ имя ТС 1061 + "imei": "", ~/~/ IMEI 1062 + "deviceTypeId": "", ~/~/ типа устройства 1063 + "modelId": "", ~/~/ ID модели 1064 + "unitId": "", ~/~/ ID подразделения 1065 + "sim1": "", ~/~/ SIM 1 1066 + "sim2": "", ~/~/ SIM2 1067 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1068 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1069 + "counters": 1070 + { 1071 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1072 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1073 + "mileage": "", ~/~/ пробег 1074 + "motohours": "", ~/~/ моточасы 1075 + } 1076 + "cmsv6Parameters": ~/~/ параметры CMSv6 1077 + { 1078 + "id": ~/~/ идентификатор 1079 + "enabled": true, ~/~/ флаг включения 1080 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1081 + "login": "", ~/~/ имя учетной записи 1082 + "password": "", ~/~/ пароль учетной записи 1083 + } 1084 + "inspectionTasks": ~/~/ задания на ТО 1085 + { 1086 + "id": "", ~/~/ ID задания 1087 + "enabled": false, ~/~/ Признак включения 1088 + "name": "", ~/~/ Имя задания 1089 + "description": "", ~/~/ Описание задания 1090 + "mileageCondition": "", ~/~/ Условие по пробегу 1091 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1092 + "motohoursCondition": "", ~/~/ Условие по моточасам 1093 + "lastMotohours": "", ~/~/ Моточасы 1094 + "periodicCondition": "", ~/~/ Условие периодичности по времени 1095 + "kind": "", ~/~/ Вид периодичности по времени 1096 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1097 + } 526 526 527 -(% style="color:#000000" %)6 - «Демонтаж» 1099 +(% lang="en-US" style="text-align:left" %) 1100 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 528 528 529 -(% style="color:#000000" %)7 - «Монтаж» 1102 +**валидация:** 1103 +- сезонный параметр может быть задан только если задана соответствующая обычная норма; 1104 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1105 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания. 530 530 531 -(% style="color:#000000" %) 8- «Дозаказ»1107 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) == 532 532 533 -(% style="color:#000000" %)9 - «Обслужен» 1109 +(% class="box errormessage" %) 1110 +((( 1111 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1112 +))) 534 534 535 -(% style="color:#000000" %) 10-«Списан»1114 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 536 536 537 -(% style="color:#000000" %) 11 - «Неисправен»1116 +(% style="color:#000000" %)Метод запроса: **DELETE** 538 538 539 -(% style="color:#000000" %) 12 - «Проверен»1118 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 540 540 1120 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 1121 + 1122 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1123 + 541 541 (% style="text-align:left" %) 542 -(% style="color:#000000 ; font-weight:normal" %)13-«Неэксплуатируется»1125 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 543 543 1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) = 544 544 545 -(% class="box successmessage" %) 1129 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) == 1130 + 1131 +(% class="box infomessage" %) 546 546 ((( 547 -(% style="color:#000000; line-height:100%" %)** Изменениестатуса объекта —**(% lang="en-US" %)**POSTvehicles/changeStatus/{vehicleId}**1133 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types** 548 548 ))) 549 549 550 -(% style="color:#000000" %) зменить статусбъекта. Методпозволяет изменитьстатус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).1136 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 551 551 552 -(% style="color:#000000" %)Метод запроса: ** POST**1138 +(% style="color:#000000" %)Метод запроса: **GET** 553 553 554 -(% 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}1140 +(% 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]] 555 555 556 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 557 - 558 558 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 559 559 560 -(% style="color:#000000" %) Параметрывтеле запроса (JSON):{1144 +(% style="color:#000000" %)Ответ: 561 561 562 -(% class="western" %) 563 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 564 - "date": "", // Дата смены статуса (null если сменить немедленно) 565 - "description": "", // Описание 566 - "data": "", // Данные 567 - "overwrite": false, // Флаг перезаписи 568 - "stage": "", // Состояние, может быть null}}} 1146 +(% style="color:#000000" %){ 569 569 1148 + "deviceTypeId" : "", ~/~/ ID типа устройства 1149 + "deviceTypeName" : "" ~/~/ Название типа устройства 1150 + 1151 +(% style="text-align:left" %) 570 570 (% style="color:#000000" %)} 571 571 572 -(% style="color:#000000" %) Ответ:{1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 573 573 574 -(% class="western" %) 575 -{{{ "status": "", // значение статуса 576 - "date": "", // Дата смены статуса 577 - "description": "", // Описание 578 - "data": "", // Данные 579 - "overwrite": false, // Флаг перезаписи 580 - "stage": "", // Состояние}}} 1156 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 581 581 1158 +(% class="box infomessage" %) 1159 +((( 1160 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1161 +))) 1162 + 1163 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1164 + 1165 +(% style="color:#000000" %)Метод запроса: **GET** 1166 + 1167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1168 + 1169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1170 + 1171 +(% style="color:#000000" %)Ответ: 1172 + 1173 +(% style="color:#000000" %){ 1174 + 1175 + "id": "", ~/~/ ID типа датчика 1176 + "name": "", ~/~/ Название 1177 + "description": "", ~/~/ Описание 1178 + 582 582 (% style="text-align:left" %) 583 583 (% style="color:#000000" %)} 584 584 1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) = 585 585 1184 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1185 + 1186 +(% class="box infomessage" style="text-align: left;" %) 1187 +((( 1188 +**POST /api/v3/terminalMessages/count** 1189 +))) 1190 + 1191 +(% style="text-align: left;" %) 1192 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 1193 + 1194 +(% style="text-align: left;" %) 1195 +Метод запроса **POST** 1196 + 1197 +(% style="text-align: left;" %) 1198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1199 + 1200 +(% style="text-align: left;" %) 1201 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1202 + 1203 +(% style="text-align: left;" %) 1204 +{ 1205 + "objectIds": [ 1206 + id ~/~/ здесь передается список идентификаторов объектов 1207 + ], 1208 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1209 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1210 +} 1211 + 1212 +(% style="text-align: left;" %) 1213 +Ответ: 1214 + 1215 +(% style="text-align: left;" %) 1216 +[ 1217 + { 1218 + "id": 0, ~/~/ идентификатор объекта 1219 + "count": 0 ~/~/ количество сообщений за период 1220 + } 1221 +] 1222 + 1223 + 586 586 (% class="box" lang="en-US" style="text-align: center;" %) 587 587 ((( 588 588 (% 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]] **