Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -151,7 +151,7 @@ 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,7 +202,7 @@ 202 202 203 203 (% style="color:#000000" %)Ответ: 204 204 205 -(% style="color:#000000" %){ 205 +(% style="color:#000000" %){ (%%) 206 206 207 207 "id": "" , ~/~/ идентификатор пользователя 208 208 "lastName": "" , ~/~/ фамилия ... ... @@ -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" %){ 241 +(% 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 пользователя ... ... @@ -267,7 +267,7 @@ 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" %)//{ 270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{ // 271 271 272 272 (% lang="en-US" style="text-align:left" %) 273 273 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя ... ... @@ -370,24 +370,20 @@ 370 370 371 371 (% style="color:#000000" %){ 372 372 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 - ...}}} 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": "" , ~/~/ статус объекта 389 389 390 - (%style="color:#000000"%)}386 + } 391 391 392 392 (% style="text-align:left" %) 393 393 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -409,95 +409,92 @@ 409 409 410 410 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 411 411 412 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {408 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 413 413 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": "" // пароль учетной записи 438 - }, 439 - "inspectionTasks": [ // задания на ТО 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 ~/~/ флаг активности счётчика "моточасы" 428 + }, 429 + "cmsv6Parameters": { ~/~/ параметры CMSv6 430 + "enabled": true, ~/~/ флаг включения 431 + "id": "" , ~/~/ идентификатор 432 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 + "login": "" , ~/~/ имя учетной записи 434 + "password": "" ~/~/ пароль учетной записи 435 + }, 436 + "inspectionTasks": ~/~/ задания на ТО 440 440 { 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 - ]}}} 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 + } 454 454 455 -(% style="color:#000000" %) …}451 +(% style="color:#000000" %) } 456 456 457 457 (% style="color:#000000" %)Ответ: 458 458 459 459 (% style="color:#000000" %){ 460 460 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 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 478 478 }, 479 - 480 - 481 - 482 - 483 - 484 - 474 + "cmsv6Parameters": { ~/~/Параметры CmsV6 475 + "id": null, 476 + "enabled": true, ~/~/флаг включения 477 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 478 + "login": "", ~/~/ имя учетной записи 479 + "password": "" ~/~/ пароль учетной записи 485 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 - ]}}} 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 + } 501 501 502 502 (% style="text-align:left" %) 503 503 (% style="color:#000000" %)} ... ... @@ -516,11 +516,11 @@ 516 516 517 517 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 518 518 519 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 512 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «__Видимость объектов заблокированных договоров в панели управления__» или «__Видимость объектов заблокированных договоров в мониторинге__»; 520 520 521 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 514 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «__Просмотр номеров телефонов объектов__»; 522 522 523 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 516 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «__Просмотр статуса объекта__». 524 524 525 525 (% style="color:#000000" %)Метод запроса: **POST** 526 526 ... ... @@ -534,16 +534,19 @@ 534 534 535 535 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 536 536 537 -(% class="western" style="color:#000000" %)##{ "vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##530 +(% class="western" style="color:#000000" %)##{## 538 538 539 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 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" %)} 540 540 541 -(% class="western" style="color:#000000" %)##~/~/IDтипа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. 542 542 543 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 544 - 545 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 546 - 547 547 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 548 548 549 549 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: