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