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": "" , ~/~/ идентификатор пользователя ... ... @@ -332,8 +332,10 @@ 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: Токен авторизации335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 336 336 337 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 338 + 337 337 (% style="text-align:left" %) 338 338 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 339 339 ... ... @@ -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 - ...}}} 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": "" , ~/~/ статус объекта 387 387 388 - (%style="color:#000000"%)}386 + } 389 389 390 390 (% style="text-align:left" %) 391 391 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: ... ... @@ -407,95 +407,92 @@ 407 407 408 408 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 409 409 410 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {408 +(% 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": "" // пароль учетной записи 436 - }, 437 - "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": ~/~/ задания на ТО 438 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 - однократно) 450 - }, 451 - ]}}} 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 + } 452 452 453 -(% style="color:#000000" %) …}451 +(% 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 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 476 476 }, 477 - 478 - 479 - 480 - 481 - 482 - 474 + "cmsv6Parameters": { ~/~/Параметры CmsV6 475 + "id": null, 476 + "enabled": true, ~/~/флаг включения 477 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 478 + "login": "", ~/~/ имя учетной записи 479 + "password": "" ~/~/ пароль учетной записи 483 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 - ]}}} 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 + } 499 499 500 500 (% style="text-align:left" %) 501 501 (% style="color:#000000" %)} ... ... @@ -532,14 +532,17 @@ 532 532 533 533 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 534 534 535 -(% class="western" style="color:#000000" %)##{ "vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##530 +(% class="western" style="color:#000000" %)##{## 536 536 537 -(% 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" %)} 538 538 539 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null## 540 - 541 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)} 542 - 543 543 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 544 544 545 545 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]