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
-
... ... @@ -44,7 +44,7 @@ 44 44 "User": "" , ~/~/ имя пользователя 45 45 46 46 (% lang="en-US" %) 47 - 47 +} 48 48 49 49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 50 50 ... ... @@ -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 пользователя ... ... @@ -173,7 +173,7 @@ 173 173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 174 174 175 175 (% style="text-align:left" %) 176 -(% style="color:#000000; font-weight:normal" %) 176 +(% style="color:#000000; font-weight:normal" %)} 177 177 178 178 179 179 (% class="box successmessage" %) ... ... @@ -198,13 +198,13 @@ 198 198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 200 200 201 -(% style="color:#000000" %) 201 +(% style="color:#000000" %)} 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 -(% style="color:#000000" %) 218 +(% 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,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} 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):261 +(% 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 пользователя 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 ~/~/ флаг активности счётчика "моточасы" 428 - }, 429 - "cmsv6Parameters": { ~/~/ параметры CMSv6 430 - "enabled": true, ~/~/ флаг включения 431 - "id": "" , ~/~/ идентификатор 432 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 433 - "login": "" , ~/~/ имя учетной записи 434 - "password": "" ~/~/ пароль учетной записи 435 - }, 436 - "inspectionTasks": ~/~/ задания на ТО 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": "" // пароль учетной записи 379 + }, 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 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 473 473 }, 474 - "cmsv6Parameters": { ~/~/Параметры CmsV6475 - "id": null, 476 - "enabled": true, ~/~/флаг включения477 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6478 - "login": "", ~/~/ имя учетной записи479 - "password": "" ~/~/ пароль учетной записи420 + "cmsv6Parameters": { //Параметры CmsV6 421 + "id": null, 422 + "enabled": true, //флаг включения 423 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6 424 + "login": "", // имя учетной записи 425 + "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 - } 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" %)}