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