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": "" , ~/~/ идентификатор пользователя ... ... @@ -301,22 +301,16 @@ 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} 304 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса: 305 305 306 -(% style="color:#000000" %)Параметр запроса: { id}- Guidпользователя306 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 307 307 308 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 308 +(% class="western" %) 309 +{{{ "description": "", // описание 310 + "data": "" // данные, связанные со сменой статуса}}} 309 309 310 -(% style="color:#000000" %) Параметры в теле запроса (JSON):312 +(% style="color:#000000" %)} 311 311 312 -(% style="color:#000000" %){ 313 - 314 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 - "description": "" , ~/~/ описание 316 - "data": "" , ~/~/ данные, связанные со сменой статуса 317 - 318 - (% style="color:#000000" %)} 319 - 320 320 (% style="text-align:left" %) 321 321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 322 322 ... ... @@ -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 пользователя 329 +(% 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": "" , ~/~/ статус объекта 365 +(% class="western" %) 366 +{{{ "vehicleId": “”, // идентификатор объекта 367 + "name": "", // имя объекта 368 + "imei": "", // IMEI объекта 369 + "deviceTypeId": “”, // идентификатор устройства объекта 370 + "deviceTypeName": "" // наименование устройства объекта 371 + "parentId": "", // идентификатор клиента-родителя 372 + "parentName": "" // наименование клиента-родителя, 373 + "modelId": "", // идентификатор модели объекта 374 + "modelName": "" // наименование модели объекта, 375 + "unitId": "", // идентификатор подразделения 376 + "unitName": "", // наименование подразделения 377 + "status": “”, // статус объекта 378 + ... 379 + }, 380 + ...}}} 385 385 386 - 382 +(% 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 404 +(% 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 ~/~/ флаг активности счётчика "моточасы" 428 - }, 429 - "cmsv6Parameters": { ~/~/ параметры CMSv6 430 - "enabled": true, ~/~/ флаг включения 431 - "id": "" , ~/~/ идентификатор 432 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 - "login": "" , ~/~/ имя учетной записи 434 - "password": "" ~/~/ пароль учетной записи 435 - }, 436 - "inspectionTasks": ~/~/ задания на ТО 406 +(% class="western" %) 407 +{{{ "parentId": "", // ID клиента 408 + "name": "", // имя ТС 409 + "imei": "", // IMEI 410 + "deviceTypeId": "",// ID типа устройства 411 + "modelId": "", 412 + "unitId": "", // ID подразделения 413 + "sim1": "", // Номер SIM 1 414 + "sim2": "", // Номер SIM2 415 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 416 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 417 + "consumptionIdle": "",// Расход топлива на холостом ходу 418 + "counters": { 419 + "mileage": "", // пробег 420 + "mileageEnabled": true, // флаг активности счётчика "пробег" 421 + "motohours":"", // моточасы 422 + "motohoursEnabled": true // флаг активности счётчика "моточасы" 423 + }, 424 + "cmsv6Parameters": { // параметры CMSv6 425 + "enabled": true, // флаг включения 426 + //"id": "", // идентификатор 427 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 428 + "login": "", // имя учетной записи 429 + "password": "" // пароль учетной записи 430 + }, 431 + "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 - } 433 + "enabled": "", // Признак включения 434 + "name": "", // Имя задания 435 + "description": "", // Описание задания 436 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает) 437 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно) 438 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает) 439 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно) 440 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает) 441 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 442 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано) 443 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 444 + }, 445 + ]}}} 450 450 451 -(% style="color:#000000" %) } 447 +(% 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 453 +(% class="western" %) 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 473 473 }, 474 - "cmsv6Parameters": { ~/~/Параметры CmsV6475 - "id": null, 476 - "enabled": true, ~/~/флаг включения477 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6478 - "login": "", ~/~/ имя учетной записи479 - "password": "" ~/~/ пароль учетной записи471 + "cmsv6Parameters": { //Параметры CmsV6 472 + "id": null, 473 + "enabled": true, //флаг включения 474 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 475 + "login": "", // имя учетной записи 476 + "password": "" // пароль учетной записи 480 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 - } 478 + "inspectionTasks": [ // задания на ТО 479 + { 480 + "id": "", // ID задачи 481 + "enabled": false, // Признак включения 482 + "name": "", // Имя задания 483 + "description": "", // Описание задания 484 + "mileageCondition": "", // Условие по пробегу 485 + "lastMileage": "", // Пробег (в метрах) 486 + "motohoursCondition": "", // Условие по моточасам 487 + "lastMotohours": "", // Моточасы 488 + "periodicCondition": "", // Условие периодичности по времени 489 + "kind": "", // Вид периодичности по времени 490 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 491 + } 492 + ]}}} 494 494 495 495 (% style="text-align:left" %) 496 496 (% style="color:#000000" %)}