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 ... ... @@ -82,13 +82,13 @@ 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,11 +99,14 @@ 99 99 "parentId": "", ~/~/ идентификатор клиента-родителя 100 100 "name": "", ~/~/ наименование клиента 101 101 "fullName": "", ~/~/ полное наименование клиента 102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент,1-Партнер,2-Группа,3-Административнаягруппа, 4 - Тестовый клиент, 5 - Договор)102 + "agentInfoType": "", ~/~/ тип клиента1 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 + 107 107 (% class="box" style="text-align: center;" %) 108 108 ((( 109 109 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи** ... ... @@ -142,13 +142,13 @@ 142 142 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 143 143 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 144 144 "groups": "" , ~/~/ группы пользователя, названия групп 145 -} 148 + } 146 146 147 147 (% style="text-align:left" %) 148 148 (% style="color:#000000; font-weight:normal" %)Ответ: 149 149 150 150 (% style="text-align:left" %) 151 -(% style="color:#000000; font-weight:normal" %){ 154 +(% style="color:#000000; font-weight:normal" %){ 152 152 153 153 (% style="text-align:left" %) 154 154 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -170,7 +170,7 @@ 170 170 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 171 171 172 172 (% style="text-align:left" %) 173 -(% style="color:#000000; font-weight:normal" %)} 176 +(% style="color:#000000; font-weight:normal" %) } 174 174 175 175 176 176 (% class="box successmessage" %) ... ... @@ -195,11 +195,11 @@ 195 195 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 196 196 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 197 197 198 -(% style="color:#000000" %)} 201 +(% style="color:#000000" %) } 199 199 200 200 (% style="color:#000000" %)Ответ: 201 201 202 -(% style="color:#000000" %){ 205 +(% style="color:#000000" %){ (%%) 203 203 204 204 "id": "" , ~/~/ идентификатор пользователя 205 205 "lastName": "" , ~/~/ фамилия ... ... @@ -215,7 +215,7 @@ 215 215 "status": "1", ~/~/ статус пользователя 216 216 "astLogged": "", ~/~/ дата/время последней авторизации 217 217 218 -(% style="color:#000000" %)} 221 +(% style="color:#000000" %) } 219 219 220 220 221 221 (% class="box warningmessage" %) ... ... @@ -235,7 +235,7 @@ 235 235 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 236 236 237 237 (% lang="en-US" style="text-align:left" %) 238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 239 239 240 240 (% lang="en-US" style="text-align:left" %) 241 241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -258,16 +258,16 @@ 258 258 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 259 259 260 260 (% lang="en-US" style="text-align:left" %) 261 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__ 262 262 263 263 (% lang="en-US" style="text-align:left" %) 264 264 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 265 265 266 266 (% lang="en-US" style="text-align:left" %) 267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 270 +(% 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" %) "id": "" , ~/~/ идентификатор пользователя 273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя 271 271 "lastName": "" , ~/~/ фамилия 272 272 "firstName": "" , ~/~/ имя 273 273 "position": "" , ~/~/ должность ... ... @@ -283,10 +283,10 @@ 283 283 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 284 284 "kind": "" , ~/~/ тип аутентификации 285 285 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 286 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя// 287 287 288 288 (% lang="en-US" style="text-align:left" %) 289 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //} 290 290 291 291 292 292 (% class="box warningmessage" %) ... ... @@ -300,7 +300,7 @@ 300 300 301 301 (% 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} 302 302 303 -(% style="color:#000000" %)Параметр запроса: { __**id**__} - Guid пользователя306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 304 304 305 305 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 306 306 ... ... @@ -312,7 +312,7 @@ 312 312 "description": "" , ~/~/ описание 313 313 "data": "" , ~/~/ данные, связанные со сменой статуса 314 314 315 -(% style="color:#000000" %)} 318 + (% style="color:#000000" %)} 316 316 317 317 (% style="text-align:left" %) 318 318 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** ... ... @@ -367,20 +367,24 @@ 367 367 368 368 (% style="color:#000000" %){ 369 369 370 - "vehicleId": "" , ~/~/ идентификатор объекта 371 - "name": "" , ~/~/ имя объекта 372 - "imei": "" , ~/~/ IMEI объекта 373 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 374 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 375 - "parentId": "" , ~/~/ идентификатор клиента-родителя 376 - "parentName": "" , ~/~/ наименование клиента-родителя, 377 - "modelId": "" , ~/~/ идентификатор модели объекта 378 - "modelName": "" , ~/~/ наименование модели объекта, 379 - "unitId": "" , ~/~/ идентификатор подразделения 380 - "unitName": "" , ~/~/ наименование подразделения 381 - "status": "" , ~/~/ статус объекта 373 +(% class="western" %) 374 +{{{ "vehicleId": “”, // идентификатор объекта 375 + "name": "", // имя объекта 376 + "imei": "", // IMEI объекта 377 + "deviceTypeId": “”, // идентификатор устройства объекта 378 + "deviceTypeName": "" // наименование устройства объекта 379 + "parentId": "", // идентификатор клиента-родителя 380 + "parentName": "" // наименование клиента-родителя, 381 + "modelId": "", // идентификатор модели объекта 382 + "modelName": "" // наименование модели объекта, 383 + "unitId": "", // идентификатор подразделения 384 + "unitName": "", // наименование подразделения 385 + "status": “”, // статус объекта 386 + ... 387 + }, 388 + ...}}} 382 382 383 -} 390 +(% style="color:#000000" %)} 384 384 385 385 (% style="text-align:left" %) 386 386 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -402,92 +402,95 @@ 402 402 403 403 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 404 404 405 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 412 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 406 406 407 -(% style="color:#000000" %){ 408 - 409 - "parentId": "" , ~/~/ ID клиента 410 - "name": "" , ~/~/ имя ТС 411 - "imei": "" , ~/~/ IMEI 412 - "deviceTypeId": "" , ~/~/ ID типа устройства 413 - "modelId": "" , ~/~/ ID модели 414 - "unitId": "" , ~/~/ ID подразделения 415 - "sim1": "" , ~/~/ Номер SIM 1 416 - "sim2": "" , ~/~/ Номер SIM2 417 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 418 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 419 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 420 - "counters": { 421 - "mileage": "" , ~/~/ пробег 422 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 423 - "motohours": "" , ~/~/ моточасы 424 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 414 +(% class="western" %) 415 +{{{ "parentId": "", // ID клиента 416 + "name": "", // имя ТС 417 + "imei": "", // IMEI 418 + "deviceTypeId": "",// ID типа устройства 419 + "modelId": "", 420 + "unitId": "", // ID подразделения 421 + "sim1": "", // Номер SIM 1 422 + "sim2": "", // Номер SIM2 423 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 424 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 425 + "consumptionIdle": "",// Расход топлива на холостом ходу 426 + "counters": { 427 + "mileage": "", // пробег 428 + "mileageEnabled": true, // флаг активности счётчика "пробег" 429 + "motohours":"", // моточасы 430 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 431 + }, 432 + "cmsv6Parameters": { // параметры CMSv6 433 + "enabled": true, // флаг включения 434 + //"id": "", // идентификатор 435 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 436 + "login": "", // имя учетной записи 437 + "password": "" // пароль учетной записи 425 425 }, 426 - "cmsv6Parameters": { ~/~/ параметры CMSv6 427 - "enabled": true, ~/~/ флаг включения 428 - "id": "" , ~/~/ идентификатор 429 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 430 - "login": "" , ~/~/ имя учетной записи 431 - "password": "" ~/~/ пароль учетной записи 432 - }, 433 - "inspectionTasks": ~/~/ задания на ТО 439 + "inspectionTasks": [ // задания на ТО 434 434 { 435 - "enabled": "" , ~/~/ Признак включения 436 - "name": "" , ~/~/ Имя задания 437 - "description": "" , ~/~/ Описание задания 438 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 439 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 440 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 441 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 442 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 443 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 444 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 445 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 446 - } 441 + "enabled": "", // Признак включения 442 + "name": "", // Имя задания 443 + "description": "", // Описание задания 444 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 445 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 446 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 447 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 448 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 449 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 450 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 451 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 452 + }, 453 + ]}}} 447 447 448 -(% style="color:#000000" %) } 455 +(% style="color:#000000" %)… } 449 449 450 450 (% style="color:#000000" %)Ответ: 451 451 452 452 (% style="color:#000000" %){ 453 453 454 - "vehicleId": "", ~/~/ID ТС 455 - "parentId": "", ~/~/Guid владельца ТС 456 - "name": "", ~/~/Имя объекта 457 - "imei": "", ~/~/IMEI 458 - "deviceTypeId": "", ~/~/ID типа устройства 459 - "modelId": "", ~/~/ID модели 460 - "unitId": "", ~/~/ID подразделения 461 - "sim1": "", ~/~/SIM1 462 - "sim2": "", ~/~/SIM2 463 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 464 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 465 - "counters": { ~/~/Счётчики 466 - "mileageEnabled": true, 467 - "motohoursEnabled": true, 468 - "mileage": "", 469 - "motohours": 345.0 470 - }, 471 - "cmsv6Parameters": { ~/~/Параметры CmsV6 472 - "id": null, 473 - "enabled": true, ~/~/флаг включения 474 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 475 - "login": "", ~/~/ имя учетной записи 476 - "password": "" ~/~/ пароль учетной записи 477 - }, 478 - "inspectionTasks": { ~/~/ задания на ТО 479 - "id": "", ~/~/ ID задачи 480 - "enabled": false, ~/~/ Признак включения 481 - "name": "", ~/~/ Имя задания 482 - "description": "", ~/~/ Описание задания 483 - "mileageCondition": "", ~/~/ Условие по пробегу 484 - "lastMileage": "", ~/~/ Пробег (в метрах) 485 - "motohoursCondition": "", ~/~/ Условие по моточасам 486 - "lastMotohours": "", ~/~/ Моточасы 487 - "periodicCondition": "", ~/~/ Условие периодичности по времени 488 - "kind": "", ~/~/ Вид периодичности по времени 489 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 490 - } 461 +(% class="western" %) 462 +{{{ "vehicleId": "", //ID ТС 463 + "parentId": "", //Guid владельца ТС 464 + "name": "", //Имя объекта 465 + "imei": "", //IMEI 466 + "deviceTypeId": "", //ID типа устройства 467 + "modelId": "", //ID модели 468 + "unitId": "", //ID подразделения 469 + "sim1": "", //SIM1 470 + "sim2": "", //SIM2 471 + "consumptionPer100Km": "", //Расход топлива на 100 км 472 + "consumptionIdle": "", //Расход топлива на холостом ходу 473 + "counters": { //Счётчики 474 + "mileageEnabled": true, 475 + "motohoursEnabled": true, 476 + "mileage": "", 477 + "motohours": 345.0 478 + }, 479 + "cmsv6Parameters": { //Параметры CmsV6 480 + "id": null, 481 + "enabled": true, //флаг включения 482 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 483 + "login": "", // имя учетной записи 484 + "password": "" // пароль учетной записи 485 + }, 486 + "inspectionTasks": [ // задания на ТО 487 + { 488 + "id": "", // ID задачи 489 + "enabled": false, // Признак включения 490 + "name": "", // Имя задания 491 + "description": "", // Описание задания 492 + "mileageCondition": "", // Условие по пробегу 493 + "lastMileage": "", // Пробег (в метрах) 494 + "motohoursCondition": "", // Условие по моточасам 495 + "lastMotohours": "", // Моточасы 496 + "periodicCondition": "", // Условие периодичности по времени 497 + "kind": "", // Вид периодичности по времени 498 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 499 + } 500 + ]}}} 491 491 492 492 (% style="text-align:left" %) 493 493 (% style="color:#000000" %)} ... ... @@ -506,11 +506,11 @@ 506 506 507 507 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 508 508 509 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;519 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 510 510 511 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;521 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 512 512 513 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.523 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 514 514 515 515 (% style="color:#000000" %)Метод запроса: **POST** 516 516 ... ... @@ -524,41 +524,19 @@ 524 524 525 525 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 526 526 527 -(% class="western" style="color:#000000" %)##{## 537 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 528 528 529 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 530 - "name": null, ~/~/ Имя ТС (string, опционально) 531 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 532 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 533 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 534 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 535 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 536 -(% style="color:#000000" %)} 539 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 537 537 538 -(% style="color:#000000" %) Фильтрацияосуществляетсяпоточному совпадению значений параметров«vehicleId», «deviceTypeId», «parentId»,«unitId»,ипочастичному - «name», «imei», «sim». Фильтрация по значению параметра«sim»осуществляетсяприналичии у авторизованного пользователя права **«__Просмотрномеровтелефоновобъектов__»**.541 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 539 539 540 -(% style="color:#000000" %) Ответ:543 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 541 541 542 -(% style="color:#000000" %) {545 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 543 543 544 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 545 - "name": "" ~/~/ наименование объекта 546 - "imei": "" ~/~/ IMEI объекта 547 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 548 - "deviceTypeName": "" ~/~/ наименование типа устройства 549 - "sim1": "" ~/~/ первый номер телефона 550 - "sim2": "" ~/~/ второй номер телефона 551 - "parentId": "" ~/~/ идентификатор клиента-родителя 552 - "parentName": "" ~/~/ наименование клиента-родителя 553 - "modelId": "" ~/~/ идентификатор модели объекта 554 - "modelName": "" ~/~/ наименование модели объекта 555 - "unitId": "" ~/~/ идентификатор подразделения 556 - "unitName": "" ~/~/ наименование подразделения 557 - "status": "" ~/~/ статус объекта 558 - "createdAt": "" ~/~/ дата создания объектов (%%) 559 -(% style="color:#000000" %)} 547 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 560 560 561 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **« __Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:549 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 562 562 563 563 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 564 564 ... ... @@ -578,34 +578,32 @@ 578 578 579 579 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 580 580 581 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 569 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 582 582 583 -(% style="color:#000000" %){ 571 +(% class="western" %) 572 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 573 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 574 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 575 + "date": "", // Дата смены статуса (null если сменить немедленно) 576 + "description": "", // Описание 577 + "data": "", // Данные 578 + "overwrite": false, // Флаг перезаписи 579 + "stage": "", // Состояние, может быть null}}} 584 584 585 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 586 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 587 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 588 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 589 - "description": "", ~/~/ Описание 590 - "data": "", ~/~/ Данные 591 - "overwrite": false, ~/~/ Флаг перезаписи 592 - "stage": "", ~/~/ Состояние, может быть null 593 - 594 594 (% style="color:#000000" %)} 595 595 596 -(% style="color:#000000" %)Ответ: 583 +(% style="color:#000000" %)Ответ: { 597 597 598 -(% style="color:#000000" %){ 585 +(% class="western" %) 586 +{{{ "status": "", // значение статуса 587 + "date": "", // Дата смены статуса 588 + "description": "", // Описание 589 + "data": "", // Данные 590 + "overwrite": false, // Флаг перезаписи 591 + "stage": "", // Состояние}}} 599 599 600 - "status": "", ~/~/ значение статуса 601 - "date": "", ~/~/ Дата смены статуса 602 - "description": "", ~/~/ Описание 603 - "data": "", ~/~/ Данные 604 - "overwrite": false, ~/~/ Флаг перезаписи 605 - "stage": "", ~/~/ Состояние 606 - 607 607 (% style="text-align:left" %) 608 -(% style="color:#000000" %) 594 +(% style="color:#000000" %)} 609 609 610 610 611 611 (% class="box warningmessage" %) ... ... @@ -623,102 +623,14 @@ 623 623 624 624 (% style="color:#000000" %)Параметры в теле запроса (JSON): 625 625 626 -(% style="color:#000000" %){ 612 +(% 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»: «» //Сколько раз выполнить задание } ] } 627 627 628 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 629 - "parentId": "", ~/~/ ID клиента 630 - "name": "", ~/~/ имя ТС 631 - "imei": "", ~/~/ IMEI 632 - "deviceTypeId": "", ~/~/ ID типа устройства 633 - "modelId": "", ~/~/ , ID модели 634 - "unitId": "", ~/~/ подразделения 635 - "sim1": "", ~/~/ SIM 1 636 - "sim2": "", ~/~/ SIM2 637 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 638 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 639 - "counters": 640 - { 641 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 642 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 643 - "mileage": «», пробег 644 - "motohours": «» моточасы 645 - } 646 - "cmsv6Parameters": ~/~/ параметры CMSv6 647 - { 648 - "id": "", ~/~/ идентификатор 649 - "enabled": true, ~/~/ флаг включения 650 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 651 - "login": "", ~/~/ имя учетной записи 652 - "password": "", ~/~/ пароль учетной записи 653 - } 654 - "inspectionTasks": ~/~/ задания на ТО 655 - { 656 - "id": "", ~/~/ ID задания 657 - "enabled": false, ~/~/ Признак включения 658 - "name": "", ~/~/ Имя задания 659 - "description": "", ~/~/ Описание задания 660 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 661 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 662 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 663 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 664 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 665 - "kind": "", ~/~/ Вид периодичности по времени 666 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 667 - } 668 - 669 -(% style="color:#000000" %)} 670 - 671 671 (% style="color:#000000" %)Ответ: 672 672 673 673 (% lang="en-US" style="text-align:left" %) 674 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 617 +(% 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»: «» //Сколько раз выполнить задание } ] } 675 675 676 -(% lang="en-US" style="text-align:left" %) 677 - "vehicleId": "", ~/~/ ID ТС 678 - "parentId": "", ~/~/ ID клиента 679 - "name": "", ~/~/ имя ТС 680 - "imei": "", ~/~/ IMEI 681 - "deviceTypeId": "", ~/~/ типа устройства 682 - "modelId": "", ~/~/ ID модели 683 - "unitId": "", ~/~/ ID подразделения 684 - "sim1": "", ~/~/ SIM 1 685 - "sim2": "", ~/~/ SIM2 686 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 687 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 688 - "counters": 689 - { 690 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 691 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 692 - "mileage": "", ~/~/ пробег 693 - "motohours": "", ~/~/ моточасы 694 - } 695 - "cmsv6Parameters": ~/~/ параметры CMSv6 696 - { 697 - "id": ~/~/ идентификатор 698 - "enabled": true, ~/~/ флаг включения 699 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 700 - "login": "", ~/~/ имя учетной записи 701 - "password": "", ~/~/ пароль учетной записи 702 - } 703 - "inspectionTasks": ~/~/ задания на ТО 704 - { 705 - "id": "", ~/~/ ID задания 706 - "enabled": false, ~/~/ Признак включения 707 - "name": "", ~/~/ Имя задания 708 - "description": "", ~/~/ Описание задания 709 - "mileageCondition": "", ~/~/ Условие по пробегу 710 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 711 - "motohoursCondition": "", ~/~/ Условие по моточасам 712 - "lastMotohours": "", ~/~/ Моточасы 713 - "periodicCondition": "", ~/~/ Условие периодичности по времени 714 - "kind": "", ~/~/ Вид периодичности по времени 715 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 716 - } 717 717 718 -(% lang="en-US" style="text-align:left" %) 719 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 720 - 721 - 722 722 (% class="box errormessage" %) 723 723 ((( 724 724 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -756,15 +756,16 @@ 756 756 757 757 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 758 758 759 -(% style="color:#000000" %)Ответ: 657 +(% style="color:#000000" %)Ответ: [ 760 760 761 -(% style="color:#000000" %){ 659 +(% class="western" %) 660 +{{{ { 661 + "deviceTypeId" : "", // ID типа устройства 662 + "deviceTypeName" : "" // Название типа устройства 663 + },}}} 762 762 763 - "deviceTypeId" : "", ~/~/ ID типа устройства 764 - "deviceTypeName" : "" ~/~/ Название типа устройства 765 - 766 766 (% style="text-align:left" %) 767 -(% style="color:#000000" %) }666 +(% style="color:#000000" %)…** **] 768 768 769 769 770 770 (% class="box" style="text-align: center;" %) ... ... @@ -785,16 +785,19 @@ 785 785 786 786 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 787 787 788 -(% style="color:#000000" %)Ответ: 687 +(% style="color:#000000" %)Ответ: [ 789 789 790 -(% style="color:#000000" %){ 689 +(% class="western" style="margin-bottom:19px" %) 690 +{{{ {}}} 791 791 792 - "id": "", ~/~/ ID типа датчика 793 - "name": "", ~/~/ Название 794 - "description": "", ~/~/ Описание 692 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 795 795 694 +(% class="western" %) 695 +{{{ "description": "" // Описание 696 + },}}} 697 + 796 796 (% style="text-align:left" %) 797 -(% style="color:#000000" %) }699 +(% style="color:#000000" %)… ] 798 798 799 799 800 800 (% class="box" lang="en-US" style="text-align: center;" %)