Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/17 16:44
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -10,7 +10,7 @@ 10 10 11 11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов). 12 12 13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__). 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 35 35 36 36 (% lang="en-US" %) 37 37 (% style="color:#000000" %)**Ответ:** ... ... @@ -44,7 +44,7 @@ 44 44 "User": "" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 - 47 +} 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 ... ... @@ -54,7 +54,7 @@ 54 54 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check** 55 55 ))) 56 56 57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 58 58 59 59 (% style="color:#000000" %)Метод запроса: **GET** 60 60 ... ... @@ -76,19 +76,19 @@ 76 76 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)** 77 77 ))) 78 78 79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 80 80 81 81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»; 82 82 83 83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 84 84 85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам». 85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 86 86 87 87 (% style="color:#000000" %)Метод запроса: **GET** 88 88 89 89 (% 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> 90 90 91 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально) 91 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально) 92 92 93 93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 94 94 ... ... @@ -99,14 +99,11 @@ 99 99 "parentId": "", ~/~/ идентификатор клиента-родителя 100 100 "name": "", ~/~/ наименование клиента 101 101 "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента1 102 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 103 103 "status": "", ~/~/ статус клиента 104 - 104 +} 105 105 106 106 107 -(% 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" %)] 108 - 109 - 110 110 (% class="box" style="text-align: center;" %) 111 111 ((( 112 112 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -117,7 +117,7 @@ 117 117 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users** 118 118 ))) 119 119 120 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 121 121 122 122 (% style="color:#000000" %)Метод запроса: **POST** 123 123 ... ... @@ -145,13 +145,13 @@ 145 145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 147 "groups": "" , ~/~/ группы пользователя, названия групп 148 - 145 +} 149 149 150 150 (% style="text-align:left" %) 151 151 (% style="color:#000000; font-weight:normal" %)Ответ: 152 152 153 153 (% style="text-align:left" %) 154 -(% style="color:#000000; font-weight:normal" %){ 151 +(% style="color:#000000; font-weight:normal" %){ 155 155 156 156 (% style="text-align:left" %) 157 157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -173,7 +173,7 @@ 173 173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 174 174 175 175 (% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %) 173 +(% style="color:#000000; font-weight:normal" %)} 177 177 178 178 179 179 (% class="box successmessage" %) ... ... @@ -183,14 +183,16 @@ 183 183 184 184 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее. 185 185 186 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**. 183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 187 187 188 188 (% style="color:#000000" %)Метод запроса: **POST** 189 189 190 190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 191 191 192 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):189 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 193 193 191 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 192 + 194 194 (% style="color:#000000" %){ 195 195 196 196 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента ... ... @@ -198,11 +198,11 @@ 198 198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 200 200 201 -(% style="color:#000000" %) 200 +(% style="color:#000000" %)} 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 205 -(% style="color:#000000" %){ 204 +(% style="color:#000000" %){ (%%) 206 206 207 207 "id": "" , ~/~/ идентификатор пользователя 208 208 "lastName": "" , ~/~/ фамилия ... ... @@ -218,7 +218,7 @@ 218 218 "status": "1", ~/~/ статус пользователя 219 219 "astLogged": "", ~/~/ дата/время последней авторизации 220 220 221 -(% style="color:#000000" %) 220 +(% style="color:#000000" %)} 222 222 223 223 224 224 (% class="box warningmessage" %) ... ... @@ -226,7 +226,7 @@ 226 226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** 227 227 ))) 228 228 229 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 230 230 231 231 (% style="color:#000000" %)Метод запроса: **PUT** 232 232 ... ... @@ -238,7 +238,7 @@ 238 238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 239 239 240 240 (% lang="en-US" style="text-align:left" %) 241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 240 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 242 242 243 243 (% lang="en-US" style="text-align:left" %) 244 244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -261,16 +261,16 @@ 261 261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 262 262 263 263 (% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) // //__}__263 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 265 265 266 266 (% lang="en-US" style="text-align:left" %) 267 267 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 268 268 269 269 (% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) //{//269 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 271 271 272 272 (% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) //"id": "" , ~/~/ идентификатор пользователя272 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 274 274 "lastName": "" , ~/~/ фамилия 275 275 "firstName": "" , ~/~/ имя 276 276 "position": "" , ~/~/ должность ... ... @@ -286,10 +286,10 @@ 286 286 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 287 "kind": "" , ~/~/ тип аутентификации 288 288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя //288 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 290 290 291 291 (% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) // //}291 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 293 293 294 294 295 295 (% class="box warningmessage" %) ... ... @@ -297,13 +297,13 @@ 297 297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** 298 298 ))) 299 299 300 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 301 301 302 302 (% style="color:#000000" %)Метод запроса: **PUT** 303 303 304 304 (% 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} 305 305 306 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 305 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя 307 307 308 308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 309 309 ... ... @@ -315,7 +315,7 @@ 315 315 "description": "" , ~/~/ описание 316 316 "data": "" , ~/~/ данные, связанные со сменой статуса 317 317 318 - 317 +(% style="color:#000000" %)} 319 319 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** ... ... @@ -326,14 +326,16 @@ 326 326 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}** 327 327 ))) 328 328 329 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 330 330 331 331 (% style="color:#000000" %)Метод запроса: **DELETE** 332 332 333 333 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 334 334 335 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации334 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя 336 336 336 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 337 + 337 337 (% style="text-align:left" %) 338 338 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 339 339 ... ... @@ -350,17 +350,17 @@ 350 350 351 351 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение». 352 352 353 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 354 354 355 355 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; 356 356 357 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**. 358 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**. 358 358 359 359 (% style="color:#000000" %)Метод запроса: **GET** 360 360 361 361 (% 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> 362 362 363 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально) 364 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально) 364 364 365 365 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 366 366 ... ... @@ -368,24 +368,20 @@ 368 368 369 369 (% style="color:#000000" %){ 370 370 371 -(% class="western" %) 372 -{{{ "vehicleId": “”, // идентификатор объекта 373 - "name": "", // имя объекта 374 - "imei": "", // IMEI объекта 375 - "deviceTypeId": “”, // идентификатор устройства объекта 376 - "deviceTypeName": "" // наименование устройства объекта 377 - "parentId": "", // идентификатор клиента-родителя 378 - "parentName": "" // наименование клиента-родителя, 379 - "modelId": "", // идентификатор модели объекта 380 - "modelName": "" // наименование модели объекта, 381 - "unitId": "", // идентификатор подразделения 382 - "unitName": "", // наименование подразделения 383 - "status": “”, // статус объекта 384 - ... 385 - }, 386 - ...}}} 372 + "vehicleId": "" , ~/~/ идентификатор объекта 373 + "name": "" , ~/~/ имя объекта 374 + "imei": "" , ~/~/ IMEI объекта 375 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 376 + "deviceTypeName": "" , ~/~/ наименование устройства объекта 377 + "parentId": "" , ~/~/ идентификатор клиента-родителя 378 + "parentName": "" , ~/~/ наименование клиента-родителя, 379 + "modelId": "" , ~/~/ идентификатор модели объекта 380 + "modelName": "" , ~/~/ наименование модели объекта, 381 + "unitId": "" , ~/~/ идентификатор подразделения 382 + "unitName": "" , ~/~/ наименование подразделения 383 + "status": "" , ~/~/ статус объекта 387 387 388 - (% style="color:#000000" %)}385 +} 389 389 390 390 (% style="text-align:left" %) 391 391 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -399,7 +399,7 @@ 399 399 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles** 400 400 ))) 401 401 402 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**). 399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__). 403 403 404 404 (% style="color:#000000" %)Метод запроса: **POST** 405 405 ... ... @@ -407,95 +407,92 @@ 407 407 408 408 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 409 409 410 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {407 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 411 411 412 -(% class="western" %) 413 -{{{ "parentId": "", // ID клиента 414 - "name": "", // имя ТС 415 - "imei": "", // IMEI 416 - "deviceTypeId": "",// ID типа устройства 417 - "modelId": "", 418 - "unitId": "", // ID подразделения 419 - "sim1": "", // Номер SIM 1 420 - "sim2": "", // Номер SIM2 421 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 422 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 423 - "consumptionIdle": "",// Расход топлива на холостом ходу 424 - "counters": { 425 - "mileage": "", // пробег 426 - "mileageEnabled": true, // флаг активности счётчика "пробег" 427 - "motohours":"", // моточасы 428 - "motohoursEnabled": true // флаг активности счётчика "моточасы" 429 - }, 430 - "cmsv6Parameters": { // параметры CMSv6 431 - "enabled": true, // флаг включения 432 - //"id": "", // идентификатор 433 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 434 - "login": "", // имя учетной записи 435 - "password": "" // пароль учетной записи 409 +(% style="color:#000000" %){ 410 + 411 + "parentId": "" , ~/~/ ID клиента 412 + "name": "" , ~/~/ имя ТС 413 + "imei": "" , ~/~/ IMEI 414 + "deviceTypeId": "" , ~/~/ ID типа устройства 415 + "modelId": "" , ~/~/ ID модели 416 + "unitId": "" , ~/~/ ID подразделения 417 + "sim1": "" , ~/~/ Номер SIM 1 418 + "sim2": "" , ~/~/ Номер SIM2 419 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 420 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 422 + "counters": { 423 + "mileage": "" , ~/~/ пробег 424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 425 + "motohours": "" , ~/~/ моточасы 426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 436 436 }, 437 - "inspectionTasks": [ // задания на ТО 438 - { 439 - "enabled": "", // Признак включения 440 - "name": "", // Имя задания 441 - "description": "", // Описание задания 442 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 443 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 444 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 445 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 446 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 447 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 448 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 449 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 428 + "cmsv6Parameters": { ~/~/ параметры CMSv6 429 + "enabled": true, ~/~/ флаг включения 430 + "id": "" , ~/~/ идентификатор 431 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 432 + "login": "" , ~/~/ имя учетной записи 433 + "password": "" ~/~/ пароль учетной записи 450 450 }, 451 - ]}}} 435 + "inspectionTasks": ~/~/ задания на ТО 436 + { 437 + "enabled": "" , ~/~/ Признак включения 438 + "name": "" , ~/~/ Имя задания 439 + "description": "" , ~/~/ Описание задания 440 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 441 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 442 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 443 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 444 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 445 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 446 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 447 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 448 + } 452 452 453 -(% style="color:#000000" %) …}450 +(% style="color:#000000" %) } 454 454 455 455 (% style="color:#000000" %)Ответ: 456 456 457 457 (% style="color:#000000" %){ 458 458 459 -(% class="western" %) 460 -{{{ "vehicleId": "", //ID ТС 461 - "parentId": "", //Guid владельца ТС 462 - "name": "", //Имя объекта 463 - "imei": "", //IMEI 464 - "deviceTypeId": "", //ID типа устройства 465 - "modelId": "", //ID модели 466 - "unitId": "", //ID подразделения 467 - "sim1": "", //SIM1 468 - "sim2": "", //SIM2 469 - "consumptionPer100Km": "", //Расход топлива на 100 км 470 - "consumptionIdle": "", //Расход топлива на холостом ходу 471 - "counters": { //Счётчики 472 - "mileageEnabled": true, 473 - "motohoursEnabled": true, 474 - "mileage": "", 475 - "motohours": 345.0 476 - }, 477 - "cmsv6Parameters": { //Параметры CmsV6 478 - "id": null, 479 - "enabled": true, //флаг включения 480 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 481 - "login": "", // имя учетной записи 482 - "password": "" // пароль учетной записи 483 - }, 484 - "inspectionTasks": [ // задания на ТО 485 - { 486 - "id": "", // ID задачи 487 - "enabled": false, // Признак включения 488 - "name": "", // Имя задания 489 - "description": "", // Описание задания 490 - "mileageCondition": "", // Условие по пробегу 491 - "lastMileage": "", // Пробег (в метрах) 492 - "motohoursCondition": "", // Условие по моточасам 493 - "lastMotohours": "", // Моточасы 494 - "periodicCondition": "", // Условие периодичности по времени 495 - "kind": "", // Вид периодичности по времени 496 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 497 - } 498 - ]}}} 456 + "vehicleId": "", ~/~/ID ТС 457 + "parentId": "", ~/~/Guid владельца ТС 458 + "name": "", ~/~/Имя объекта 459 + "imei": "", ~/~/IMEI 460 + "deviceTypeId": "", ~/~/ID типа устройства 461 + "modelId": "", ~/~/ID модели 462 + "unitId": "", ~/~/ID подразделения 463 + "sim1": "", ~/~/SIM1 464 + "sim2": "", ~/~/SIM2 465 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 466 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 467 + "counters": { ~/~/Счётчики 468 + "mileageEnabled": true, 469 + "motohoursEnabled": true, 470 + "mileage": "", 471 + "motohours": 345.0 472 + }, 473 + "cmsv6Parameters": { ~/~/Параметры CmsV6 474 + "id": null, 475 + "enabled": true, ~/~/флаг включения 476 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 477 + "login": "", ~/~/ имя учетной записи 478 + "password": "" ~/~/ пароль учетной записи 479 + }, 480 + "inspectionTasks": { ~/~/ задания на ТО 481 + "id": "", ~/~/ ID задачи 482 + "enabled": false, ~/~/ Признак включения 483 + "name": "", ~/~/ Имя задания 484 + "description": "", ~/~/ Описание задания 485 + "mileageCondition": "", ~/~/ Условие по пробегу 486 + "lastMileage": "", ~/~/ Пробег (в метрах) 487 + "motohoursCondition": "", ~/~/ Условие по моточасам 488 + "lastMotohours": "", ~/~/ Моточасы 489 + "periodicCondition": "", ~/~/ Условие периодичности по времени 490 + "kind": "", ~/~/ Вид периодичности по времени 491 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 492 + } 499 499 500 500 (% style="text-align:left" %) 501 501 (% style="color:#000000" %)} ... ... @@ -508,17 +508,17 @@ 508 508 509 509 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 510 510 511 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**): 505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**): 512 512 513 513 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов; 514 514 515 515 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 516 516 517 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 511 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 518 518 519 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 513 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 520 520 521 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 515 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 522 522 523 523 (% style="color:#000000" %)Метод запроса: **POST** 524 524 ... ... @@ -526,26 +526,52 @@ 526 526 527 527 (% style="color:#000000" %)В заголовках запроса: 528 528 529 -(% style="color:#000000" %)− Content-Type: application/json 523 +(% style="color:#000000" %)− Content-Type: __**application/json**__ 530 530 531 531 (% style="color:#000000" %)− X-Auth: Токен авторизации 532 532 533 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):527 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. 534 534 535 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ ИмяТС(string,опционально)"imei":null,~/~/"710179307",##529 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 536 536 537 -(% class="western" style="color:#000000" %)## ~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##531 +(% class="western" style="color:#000000" %)##{## 538 538 539 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 534 + "name": null, ~/~/ Имя ТС (string, опционально) 535 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 536 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 537 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 538 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 540 +(% style="color:#000000" %)} 540 540 541 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed"~/~/IDподразделения(Guid,опционально)##(%style="color:#000000"%)}542 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 542 542 543 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».544 +(% style="color:#000000" %)Ответ: 544 544 545 -(% style="color:#000000" %) Ответ: [{«vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]546 +(% style="color:#000000" %){ 546 546 547 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 548 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 549 + "name": "" ~/~/ наименование объекта 550 + "imei": "" ~/~/ IMEI объекта 551 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 552 + "deviceTypeName": "" ~/~/ наименование типа устройства 553 + "sim1": "" ~/~/ первый номер телефона 554 + "sim2": "" ~/~/ второй номер телефона 555 + "parentId": "" ~/~/ идентификатор клиента-родителя 556 + "parentName": "" ~/~/ наименование клиента-родителя 557 + "modelId": "" ~/~/ идентификатор модели объекта 558 + "modelName": "" ~/~/ наименование модели объекта 559 + "unitId": "" ~/~/ идентификатор подразделения 560 + "unitName": "" ~/~/ наименование подразделения 561 + "status": "" ~/~/ статус объекта 562 + "createdAt": "" ~/~/ дата создания объектов (%%) 563 +(% style="color:#000000" %)} 548 548 565 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 566 + 567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 568 + 549 549 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 550 550 551 551 ... ... @@ -554,42 +554,44 @@ 554 554 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}** 555 555 ))) 556 556 557 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 558 558 559 559 (% style="color:#000000" %)Метод запроса: **POST** 560 560 561 561 (% 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} 562 562 563 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС 583 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС 564 564 565 565 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 566 566 567 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {587 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 568 568 569 -(% class="western" %) 570 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 571 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 572 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 573 - "date": "", // Дата смены статуса (null если сменить немедленно) 574 - "description": "", // Описание 575 - "data": "", // Данные 576 - "overwrite": false, // Флаг перезаписи 577 - "stage": "", // Состояние, может быть null}}} 589 +(% style="color:#000000" %){ 578 578 591 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 592 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 593 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 594 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 595 + "description": "", ~/~/ Описание 596 + "data": "", ~/~/ Данные 597 + "overwrite": false, ~/~/ Флаг перезаписи 598 + "stage": "", ~/~/ Состояние, может быть null 599 + 579 579 (% style="color:#000000" %)} 580 580 581 -(% style="color:#000000" %)Ответ: {602 +(% style="color:#000000" %)Ответ: 582 582 583 -(% class="western" %) 584 -{{{ "status": "", // значение статуса 585 - "date": "", // Дата смены статуса 586 - "description": "", // Описание 587 - "data": "", // Данные 588 - "overwrite": false, // Флаг перезаписи 589 - "stage": "", // Состояние}}} 604 +(% style="color:#000000" %){ 590 590 606 + "status": "", ~/~/ значение статуса 607 + "date": "", ~/~/ Дата смены статуса 608 + "description": "", ~/~/ Описание 609 + "data": "", ~/~/ Данные 610 + "overwrite": false, ~/~/ Флаг перезаписи 611 + "stage": "", ~/~/ Состояние 612 + 591 591 (% style="text-align:left" %) 592 -(% style="color:#000000" %)} 614 +(% style="color:#000000" %) } 593 593 594 594 595 595 (% class="box warningmessage" %) ... ... @@ -597,7 +597,7 @@ 597 597 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles** 598 598 ))) 599 599 600 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 601 601 602 602 (% style="color:#000000" %)Метод запроса: **PUT** 603 603 ... ... @@ -607,26 +607,114 @@ 607 607 608 608 (% style="color:#000000" %)Параметры в теле запроса (JSON): 609 609 610 -(% 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»: «» //Сколько раз выполнить задание } ] }632 +(% style="color:#000000" %){ 611 611 634 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 635 + "parentId": "", ~/~/ ID клиента 636 + "name": "", ~/~/ имя ТС 637 + "imei": "", ~/~/ IMEI 638 + "deviceTypeId": "", ~/~/ ID типа устройства 639 + "modelId": "", ~/~/ , ID модели 640 + "unitId": "", ~/~/ подразделения 641 + "sim1": "", ~/~/ SIM 1 642 + "sim2": "", ~/~/ SIM2 643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 645 + "counters": 646 + { 647 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 648 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 649 + "mileage": «», пробег 650 + "motohours": «» моточасы 651 + } 652 + "cmsv6Parameters": ~/~/ параметры CMSv6 653 + { 654 + "id": "", ~/~/ идентификатор 655 + "enabled": true, ~/~/ флаг включения 656 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 657 + "login": "", ~/~/ имя учетной записи 658 + "password": "", ~/~/ пароль учетной записи 659 + } 660 + "inspectionTasks": ~/~/ задания на ТО 661 + { 662 + "id": "", ~/~/ ID задания 663 + "enabled": false, ~/~/ Признак включения 664 + "name": "", ~/~/ Имя задания 665 + "description": "", ~/~/ Описание задания 666 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 667 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 668 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 669 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 670 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 671 + "kind": "", ~/~/ Вид периодичности по времени 672 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 673 + } 674 + 675 +(% style="color:#000000" %)} 676 + 612 612 (% style="color:#000000" %)Ответ: 613 613 614 614 (% lang="en-US" style="text-align:left" %) 615 -(% 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»: «» //Сколько раз выполнить задание } ] }680 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 616 616 682 +(% lang="en-US" style="text-align:left" %) 683 + "vehicleId": "", ~/~/ ID ТС 684 + "parentId": "", ~/~/ ID клиента 685 + "name": "", ~/~/ имя ТС 686 + "imei": "", ~/~/ IMEI 687 + "deviceTypeId": "", ~/~/ типа устройства 688 + "modelId": "", ~/~/ ID модели 689 + "unitId": "", ~/~/ ID подразделения 690 + "sim1": "", ~/~/ SIM 1 691 + "sim2": "", ~/~/ SIM2 692 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 693 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 694 + "counters": 695 + { 696 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 697 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 698 + "mileage": "", ~/~/ пробег 699 + "motohours": "", ~/~/ моточасы 700 + } 701 + "cmsv6Parameters": ~/~/ параметры CMSv6 702 + { 703 + "id": ~/~/ идентификатор 704 + "enabled": true, ~/~/ флаг включения 705 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 706 + "login": "", ~/~/ имя учетной записи 707 + "password": "", ~/~/ пароль учетной записи 708 + } 709 + "inspectionTasks": ~/~/ задания на ТО 710 + { 711 + "id": "", ~/~/ ID задания 712 + "enabled": false, ~/~/ Признак включения 713 + "name": "", ~/~/ Имя задания 714 + "description": "", ~/~/ Описание задания 715 + "mileageCondition": "", ~/~/ Условие по пробегу 716 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 717 + "motohoursCondition": "", ~/~/ Условие по моточасам 718 + "lastMotohours": "", ~/~/ Моточасы 719 + "periodicCondition": "", ~/~/ Условие периодичности по времени 720 + "kind": "", ~/~/ Вид периодичности по времени 721 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 722 + } 617 617 724 +(% lang="en-US" style="text-align:left" %) 725 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 726 + 727 + 618 618 (% class="box errormessage" %) 619 619 ((( 620 620 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 621 621 ))) 622 622 623 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 624 624 625 625 (% style="color:#000000" %)Метод запроса: **DELETE** 626 626 627 627 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId} 628 628 629 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта 739 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта 630 630 631 631 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 632 632 ... ... @@ -644,7 +644,7 @@ 644 644 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types** 645 645 ))) 646 646 647 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 648 648 649 649 (% style="color:#000000" %)Метод запроса: **GET** 650 650 ... ... @@ -652,16 +652,15 @@ 652 652 653 653 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 654 654 655 -(% style="color:#000000" %)Ответ: [765 +(% style="color:#000000" %)Ответ: 656 656 657 -(% class="western" %) 658 -{{{ { 659 - "deviceTypeId" : "", // ID типа устройства 660 - "deviceTypeName" : "" // Название типа устройства 661 - },}}} 767 +(% style="color:#000000" %){ 662 662 769 + "deviceTypeId" : "", ~/~/ ID типа устройства 770 + "deviceTypeName" : "" ~/~/ Название типа устройства 771 + 663 663 (% style="text-align:left" %) 664 -(% style="color:#000000" %) …** **]773 +(% style="color:#000000" %)} 665 665 666 666 667 667 (% class="box" style="text-align: center;" %) ... ... @@ -674,7 +674,7 @@ 674 674 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types** 675 675 ))) 676 676 677 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**). 786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**). 678 678 679 679 (% style="color:#000000" %)Метод запроса: **GET** 680 680 ... ... @@ -682,19 +682,16 @@ 682 682 683 683 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 684 684 685 -(% style="color:#000000" %)Ответ: [794 +(% style="color:#000000" %)Ответ: 686 686 687 -(% class="western" style="margin-bottom:19px" %) 688 -{{{ {}}} 796 +(% style="color:#000000" %){ 689 689 690 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 798 + "id": "", ~/~/ ID типа датчика 799 + "name": "", ~/~/ Название 800 + "description": "", ~/~/ Описание 691 691 692 -(% class="western" %) 693 -{{{ "description": "" // Описание 694 - },}}} 695 - 696 696 (% style="text-align:left" %) 697 -(% style="color:#000000" %) … ]803 +(% style="color:#000000" %)} 698 698 699 699 700 700 (% class="box" lang="en-US" style="text-align: center;" %)