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
-
... ... @@ -101,7 +101,7 @@ 101 101 "fullName": "", ~/~/ полное наименование клиента 102 102 "agentInfoType": "", ~/~/ тип клиента1 103 103 "status": "", ~/~/ статус клиента 104 -} 104 + } 105 105 106 106 107 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" %)] ... ... @@ -145,13 +145,13 @@ 145 145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email) 146 146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 147 147 "groups": "" , ~/~/ группы пользователя, названия групп 148 -} 148 + } 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" %){ 154 +(% style="color:#000000; font-weight:normal" %){ 155 155 156 156 (% style="text-align:left" %) 157 157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя ... ... @@ -202,9 +202,9 @@ 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 205 -(% style="color:#000000" %){ (%%)205 +(% style="color:#000000" %){ 206 206 207 - "id": "" , ~/~/ идентификатор пользователя 207 +(% style="color:#000000" %) "id": "" , ~/~/ идентификатор пользователя 208 208 "lastName": "" , ~/~/ фамилия 209 209 "firstName": "" , ~/~/ имя 210 210 "position": "" , ~/~/ должность ... ... @@ -214,13 +214,16 @@ 214 214 "organization": "" , ~/~/ организация 215 215 "login": "" , ~/~/ логин 216 216 "email": "" , ~/~/ E-mail 217 - "sessionDuration":"", ~/~/ длительность сессии в минутах 218 - "status": "1", ~/~/ статус пользователя 219 - "astLogged": "", ~/~/ дата/время последней авторизации 220 220 221 221 (% style="color:#000000" %)} 222 222 220 +(% class="western" style="margin-bottom:19px" %) 221 +{{{ "sessionDuration":"", // длительность сессии в минутах}}} 223 223 223 +(% lang="en-US" style="text-align:left" %) 224 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 225 + 226 + 224 224 (% class="box warningmessage" %) 225 225 ((( 226 226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -235,63 +235,9 @@ 235 235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 236 236 237 237 (% lang="en-US" style="text-align:left" %) 238 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 241 +(% 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» //названия групп ] } // 239 239 240 -(% lang="en-US" style="text-align:left" %) 241 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 242 242 243 -(% lang="en-US" style="text-align:left" %) 244 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 245 - "lastName": "" , ~/~/ фамилия 246 - "firstName": "" , ~/~/ имя 247 - "position": "" , ~/~/ должность 248 - "phone": "" , ~/~/ телефон 249 - "organization": "" , ~/~/ организация 250 - "login": "" , ~/~/ логин 251 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 252 - "email": "" , ~/~/ email 253 - "description": "" , ~/~/ описание 254 - "isEnabled": "" , ~/~/ признак включения 255 - "parentId": "" , ~/~/ Guid родительского агента 256 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан) 257 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут) 258 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 259 - "kind": "" , ~/~/ тип аутентификации 260 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 261 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 262 - 263 -(% lang="en-US" style="text-align:left" %) 264 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 265 - 266 -(% lang="en-US" style="text-align:left" %) 267 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 268 - 269 -(% lang="en-US" style="text-align:left" %) 270 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 271 - 272 -(% lang="en-US" style="text-align:left" %) 273 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 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 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 286 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации 287 - "kind": "" , ~/~/ тип аутентификации 288 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес 289 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 290 - 291 -(% lang="en-US" style="text-align:left" %) 292 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 293 - 294 - 295 295 (% class="box warningmessage" %) 296 296 ((( 297 297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -301,20 +301,14 @@ 301 301 302 302 (% style="color:#000000" %)Метод запроса: **PUT** 303 303 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} 253 +(% 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пользователя255 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 307 307 308 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 257 +(% class="western" %) 258 +{{{ "description": "", // описание 259 + "data": "" // данные, связанные со сменой статуса}}} 309 309 310 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 311 - 312 -(% style="color:#000000" %){ 313 - 314 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 - "description": "" , ~/~/ описание 316 - "data": "" , ~/~/ данные, связанные со сменой статуса 317 - 318 318 (% style="color:#000000" %)} 319 319 320 320 (% style="text-align:left" %) ... ... @@ -332,10 +332,8 @@ 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 пользователя 278 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации 336 336 337 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 338 - 339 339 (% style="text-align:left" %) 340 340 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 341 341 ... ... @@ -370,20 +370,24 @@ 370 370 371 371 (% style="color:#000000" %){ 372 372 373 - "vehicleId": "" , ~/~/ идентификатор объекта 374 - "name": "" , ~/~/ имя объекта 375 - "imei": "" , ~/~/ IMEI объекта 376 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 377 - "deviceTypeName": "" , ~/~/ наименование устройства объекта 378 - "parentId": "" , ~/~/ идентификатор клиента-родителя 379 - "parentName": "" , ~/~/ наименование клиента-родителя, 380 - "modelId": "" , ~/~/ идентификатор модели объекта 381 - "modelName": "" , ~/~/ наименование модели объекта, 382 - "unitId": "" , ~/~/ идентификатор подразделения 383 - "unitName": "" , ~/~/ наименование подразделения 384 - "status": "" , ~/~/ статус объекта 314 +(% class="western" %) 315 +{{{ "vehicleId": “”, // идентификатор объекта 316 + "name": "", // имя объекта 317 + "imei": "", // IMEI объекта 318 + "deviceTypeId": “”, // идентификатор устройства объекта 319 + "deviceTypeName": "" // наименование устройства объекта 320 + "parentId": "", // идентификатор клиента-родителя 321 + "parentName": "" // наименование клиента-родителя, 322 + "modelId": "", // идентификатор модели объекта 323 + "modelName": "" // наименование модели объекта, 324 + "unitId": "", // идентификатор подразделения 325 + "unitName": "", // наименование подразделения 326 + "status": “”, // статус объекта 327 + ... 328 + }, 329 + ...}}} 385 385 386 -} 331 +(% style="color:#000000" %)} 387 387 388 388 (% style="text-align:left" %) 389 389 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -405,92 +405,95 @@ 405 405 406 406 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 407 407 408 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 353 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { 409 409 410 -(% style="color:#000000" %){ 411 - 412 - "parentId": "" , ~/~/ ID клиента 413 - "name": "" , ~/~/ имя ТС 414 - "imei": "" , ~/~/ IMEI 415 - "deviceTypeId": "" , ~/~/ ID типа устройства 416 - "modelId": "" , ~/~/ ID модели 417 - "unitId": "" , ~/~/ ID подразделения 418 - "sim1": "" , ~/~/ Номер SIM 1 419 - "sim2": "" , ~/~/ Номер SIM2 420 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 421 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 422 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 423 - "counters": { 424 - "mileage": "" , ~/~/ пробег 425 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 426 - "motohours": "" , ~/~/ моточасы 427 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 355 +(% class="western" %) 356 +{{{ "parentId": "", // ID клиента 357 + "name": "", // имя ТС 358 + "imei": "", // IMEI 359 + "deviceTypeId": "",// ID типа устройства 360 + "modelId": "", 361 + "unitId": "", // ID подразделения 362 + "sim1": "", // Номер SIM 1 363 + "sim2": "", // Номер SIM2 364 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 365 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 366 + "consumptionIdle": "",// Расход топлива на холостом ходу 367 + "counters": { 368 + "mileage": "", // пробег 369 + "mileageEnabled": true, // флаг активности счётчика "пробег" 370 + "motohours":"", // моточасы 371 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 372 + }, 373 + "cmsv6Parameters": { // параметры CMSv6 374 + "enabled": true, // флаг включения 375 + //"id": "", // идентификатор 376 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 377 + "login": "", // имя учетной записи 378 + "password": "" // пароль учетной записи 428 428 }, 429 - "cmsv6Parameters": { ~/~/ параметры CMSv6 430 - "enabled": true, ~/~/ флаг включения 431 - "id": "" , ~/~/ идентификатор 432 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 - "login": "" , ~/~/ имя учетной записи 434 - "password": "" ~/~/ пароль учетной записи 435 - }, 436 - "inspectionTasks": ~/~/ задания на ТО 380 + "inspectionTasks": [ // задания на ТО 437 437 { 438 - "enabled": "" , ~/~/ Признак включения 439 - "name": "" , ~/~/ Имя задания 440 - "description": "" , ~/~/ Описание задания 441 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 442 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 443 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 444 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 445 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 446 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 447 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 448 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 449 - } 382 + "enabled": "", // Признак включения 383 + "name": "", // Имя задания 384 + "description": "", // Описание задания 385 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 386 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 387 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 388 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 389 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 390 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 391 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 392 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 393 + }, 394 + ]}}} 450 450 451 -(% style="color:#000000" %) } 396 +(% style="color:#000000" %)… } 452 452 453 453 (% style="color:#000000" %)Ответ: 454 454 455 455 (% style="color:#000000" %){ 456 456 457 - "vehicleId": "", ~/~/ID ТС 458 - "parentId": "", ~/~/Guid владельца ТС 459 - "name": "", ~/~/Имя объекта 460 - "imei": "", ~/~/IMEI 461 - "deviceTypeId": "", ~/~/ID типа устройства 462 - "modelId": "", ~/~/ID модели 463 - "unitId": "", ~/~/ID подразделения 464 - "sim1": "", ~/~/SIM1 465 - "sim2": "", ~/~/SIM2 466 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 467 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 468 - "counters": { ~/~/Счётчики 469 - "mileageEnabled": true, 470 - "motohoursEnabled": true, 471 - "mileage": "", 472 - "motohours": 345.0 473 - }, 474 - "cmsv6Parameters": { ~/~/Параметры CmsV6 475 - "id": null, 476 - "enabled": true, ~/~/флаг включения 477 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 478 - "login": "", ~/~/ имя учетной записи 479 - "password": "" ~/~/ пароль учетной записи 480 - }, 481 - "inspectionTasks": { ~/~/ задания на ТО 482 - "id": "", ~/~/ ID задачи 483 - "enabled": false, ~/~/ Признак включения 484 - "name": "", ~/~/ Имя задания 485 - "description": "", ~/~/ Описание задания 486 - "mileageCondition": "", ~/~/ Условие по пробегу 487 - "lastMileage": "", ~/~/ Пробег (в метрах) 488 - "motohoursCondition": "", ~/~/ Условие по моточасам 489 - "lastMotohours": "", ~/~/ Моточасы 490 - "periodicCondition": "", ~/~/ Условие периодичности по времени 491 - "kind": "", ~/~/ Вид периодичности по времени 492 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 493 - } 402 +(% class="western" %) 403 +{{{ "vehicleId": "", //ID ТС 404 + "parentId": "", //Guid владельца ТС 405 + "name": "", //Имя объекта 406 + "imei": "", //IMEI 407 + "deviceTypeId": "", //ID типа устройства 408 + "modelId": "", //ID модели 409 + "unitId": "", //ID подразделения 410 + "sim1": "", //SIM1 411 + "sim2": "", //SIM2 412 + "consumptionPer100Km": "", //Расход топлива на 100 км 413 + "consumptionIdle": "", //Расход топлива на холостом ходу 414 + "counters": { //Счётчики 415 + "mileageEnabled": true, 416 + "motohoursEnabled": true, 417 + "mileage": "", 418 + "motohours": 345.0 419 + }, 420 + "cmsv6Parameters": { //Параметры CmsV6 421 + "id": null, 422 + "enabled": true, //флаг включения 423 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 424 + "login": "", // имя учетной записи 425 + "password": "" // пароль учетной записи 426 + }, 427 + "inspectionTasks": [ // задания на ТО 428 + { 429 + "id": "", // ID задачи 430 + "enabled": false, // Признак включения 431 + "name": "", // Имя задания 432 + "description": "", // Описание задания 433 + "mileageCondition": "", // Условие по пробегу 434 + "lastMileage": "", // Пробег (в метрах) 435 + "motohoursCondition": "", // Условие по моточасам 436 + "lastMotohours": "", // Моточасы 437 + "periodicCondition": "", // Условие периодичности по времени 438 + "kind": "", // Вид периодичности по времени 439 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 440 + } 441 + ]}}} 494 494 495 495 (% style="text-align:left" %) 496 496 (% style="color:#000000" %)} ... ... @@ -509,11 +509,11 @@ 509 509 510 510 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 511 511 512 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»**или**«__Видимость объектов заблокированных договоров в мониторинге__»**;460 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 513 513 514 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;462 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 515 515 516 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.464 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 517 517 518 518 (% style="color:#000000" %)Метод запроса: **POST** 519 519 ... ... @@ -527,41 +527,19 @@ 527 527 528 528 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 529 529 530 -(% class="western" style="color:#000000" %)##{## 478 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",## 531 531 532 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 533 - "name": null, ~/~/ Имя ТС (string, опционально) 534 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 535 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 536 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 537 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 538 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 539 -(% style="color:#000000" %)} 480 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 540 540 541 -(% style="color:#000000" %) Фильтрацияосуществляетсяпоточному совпадению значений параметров«vehicleId», «deviceTypeId», «parentId»,«unitId»,ипочастичному - «name», «imei», «sim». Фильтрация по значению параметра«sim»осуществляетсяприналичии у авторизованного пользователя права **«__Просмотрномеровтелефоновобъектов__»**.482 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 542 542 543 -(% style="color:#000000" %) Ответ:484 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 544 544 545 -(% style="color:#000000" %) {486 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 546 546 547 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 548 - "name": "" ~/~/ наименование объекта 549 - "imei": "" ~/~/ IMEI объекта 550 - "deviceTypeId": "" ~/~/ идентификатор типа устройства 551 - "deviceTypeName": "" ~/~/ наименование типа устройства 552 - "sim1": "" ~/~/ первый номер телефона 553 - "sim2": "" ~/~/ второй номер телефона 554 - "parentId": "" ~/~/ идентификатор клиента-родителя 555 - "parentName": "" ~/~/ наименование клиента-родителя 556 - "modelId": "" ~/~/ идентификатор модели объекта 557 - "modelName": "" ~/~/ наименование модели объекта 558 - "unitId": "" ~/~/ идентификатор подразделения 559 - "unitName": "" ~/~/ наименование подразделения 560 - "status": "" ~/~/ статус объекта 561 - "createdAt": "" ~/~/ дата создания объектов (%%) 562 -(% style="color:#000000" %)} 488 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 563 563 564 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **« __Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:490 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 565 565 566 566 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 567 567 ... ... @@ -581,34 +581,32 @@ 581 581 582 582 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 583 583 584 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 510 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { 585 585 586 -(% style="color:#000000" %){ 512 +(% class="western" %) 513 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 514 + // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 515 + // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 516 + "date": "", // Дата смены статуса (null если сменить немедленно) 517 + "description": "", // Описание 518 + "data": "", // Данные 519 + "overwrite": false, // Флаг перезаписи 520 + "stage": "", // Состояние, может быть null}}} 587 587 588 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 589 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 590 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 591 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 592 - "description": "", ~/~/ Описание 593 - "data": "", ~/~/ Данные 594 - "overwrite": false, ~/~/ Флаг перезаписи 595 - "stage": "", ~/~/ Состояние, может быть null 596 - 597 597 (% style="color:#000000" %)} 598 598 599 -(% style="color:#000000" %)Ответ: 524 +(% style="color:#000000" %)Ответ: { 600 600 601 -(% style="color:#000000" %){ 526 +(% class="western" %) 527 +{{{ "status": "", // значение статуса 528 + "date": "", // Дата смены статуса 529 + "description": "", // Описание 530 + "data": "", // Данные 531 + "overwrite": false, // Флаг перезаписи 532 + "stage": "", // Состояние}}} 602 602 603 - "status": "", ~/~/ значение статуса 604 - "date": "", ~/~/ Дата смены статуса 605 - "description": "", ~/~/ Описание 606 - "data": "", ~/~/ Данные 607 - "overwrite": false, ~/~/ Флаг перезаписи 608 - "stage": "", ~/~/ Состояние 609 - 610 610 (% style="text-align:left" %) 611 -(% style="color:#000000" %) 535 +(% style="color:#000000" %)} 612 612 613 613 614 614 (% class="box warningmessage" %) ... ... @@ -626,102 +626,14 @@ 626 626 627 627 (% style="color:#000000" %)Параметры в теле запроса (JSON): 628 628 629 -(% style="color:#000000" %){ 553 +(% 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»: «» //Сколько раз выполнить задание } ] } 630 630 631 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 632 - "parentId": "", ~/~/ ID клиента 633 - "name": "", ~/~/ имя ТС 634 - "imei": "", ~/~/ IMEI 635 - "deviceTypeId": "", ~/~/ ID типа устройства 636 - "modelId": "", ~/~/ , ID модели 637 - "unitId": "", ~/~/ подразделения 638 - "sim1": "", ~/~/ SIM 1 639 - "sim2": "", ~/~/ SIM2 640 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 641 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 642 - "counters": 643 - { 644 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 645 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 646 - "mileage": «», пробег 647 - "motohours": «» моточасы 648 - } 649 - "cmsv6Parameters": ~/~/ параметры CMSv6 650 - { 651 - "id": "", ~/~/ идентификатор 652 - "enabled": true, ~/~/ флаг включения 653 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 654 - "login": "", ~/~/ имя учетной записи 655 - "password": "", ~/~/ пароль учетной записи 656 - } 657 - "inspectionTasks": ~/~/ задания на ТО 658 - { 659 - "id": "", ~/~/ ID задания 660 - "enabled": false, ~/~/ Признак включения 661 - "name": "", ~/~/ Имя задания 662 - "description": "", ~/~/ Описание задания 663 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 664 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 665 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 666 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 667 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 668 - "kind": "", ~/~/ Вид периодичности по времени 669 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 670 - } 671 - 672 -(% style="color:#000000" %)} 673 - 674 674 (% style="color:#000000" %)Ответ: 675 675 676 676 (% lang="en-US" style="text-align:left" %) 677 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 558 +(% 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»: «» //Сколько раз выполнить задание } ] } 678 678 679 -(% lang="en-US" style="text-align:left" %) 680 - "vehicleId": "", ~/~/ ID ТС 681 - "parentId": "", ~/~/ ID клиента 682 - "name": "", ~/~/ имя ТС 683 - "imei": "", ~/~/ IMEI 684 - "deviceTypeId": "", ~/~/ типа устройства 685 - "modelId": "", ~/~/ ID модели 686 - "unitId": "", ~/~/ ID подразделения 687 - "sim1": "", ~/~/ SIM 1 688 - "sim2": "", ~/~/ SIM2 689 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 690 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 691 - "counters": 692 - { 693 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 694 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 695 - "mileage": "", ~/~/ пробег 696 - "motohours": "", ~/~/ моточасы 697 - } 698 - "cmsv6Parameters": ~/~/ параметры CMSv6 699 - { 700 - "id": ~/~/ идентификатор 701 - "enabled": true, ~/~/ флаг включения 702 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 703 - "login": "", ~/~/ имя учетной записи 704 - "password": "", ~/~/ пароль учетной записи 705 - } 706 - "inspectionTasks": ~/~/ задания на ТО 707 - { 708 - "id": "", ~/~/ ID задания 709 - "enabled": false, ~/~/ Признак включения 710 - "name": "", ~/~/ Имя задания 711 - "description": "", ~/~/ Описание задания 712 - "mileageCondition": "", ~/~/ Условие по пробегу 713 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 714 - "motohoursCondition": "", ~/~/ Условие по моточасам 715 - "lastMotohours": "", ~/~/ Моточасы 716 - "periodicCondition": "", ~/~/ Условие периодичности по времени 717 - "kind": "", ~/~/ Вид периодичности по времени 718 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 719 - } 720 720 721 -(% lang="en-US" style="text-align:left" %) 722 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 723 - 724 - 725 725 (% class="box errormessage" %) 726 726 ((( 727 727 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** ... ... @@ -759,15 +759,16 @@ 759 759 760 760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 761 761 762 -(% style="color:#000000" %)Ответ: 598 +(% style="color:#000000" %)Ответ: [ 763 763 764 -(% style="color:#000000" %){ 600 +(% class="western" %) 601 +{{{ { 602 + "deviceTypeId" : "", // ID типа устройства 603 + "deviceTypeName" : "" // Название типа устройства 604 + },}}} 765 765 766 - "deviceTypeId" : "", ~/~/ ID типа устройства 767 - "deviceTypeName" : "" ~/~/ Название типа устройства 768 - 769 769 (% style="text-align:left" %) 770 -(% style="color:#000000" %) }607 +(% style="color:#000000" %)…** **] 771 771 772 772 773 773 (% class="box" style="text-align: center;" %) ... ... @@ -788,16 +788,19 @@ 788 788 789 789 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации 790 790 791 -(% style="color:#000000" %)Ответ: 628 +(% style="color:#000000" %)Ответ: [ 792 792 793 -(% style="color:#000000" %){ 630 +(% class="western" style="margin-bottom:19px" %) 631 +{{{ {}}} 794 794 795 - "id": "", ~/~/ ID типа датчика 796 - "name": "", ~/~/ Название 797 - "description": "", ~/~/ Описание 633 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название 798 798 635 +(% class="western" %) 636 +{{{ "description": "" // Описание 637 + },}}} 638 + 799 799 (% style="text-align:left" %) 800 -(% style="color:#000000" %) }640 +(% style="color:#000000" %)… ] 801 801 802 802 803 803 (% class="box" lang="en-US" style="text-align: center;" %)