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
-
... ... @@ -235,9 +235,63 @@ 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): { «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» //названия групп ] } //238 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 239 239 240 +(% lang="en-US" style="text-align:left" %) 241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 240 240 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 + 241 241 (% class="box warningmessage" %) 242 242 ((( 243 243 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}** ... ... @@ -247,16 +247,22 @@ 247 247 248 248 (% style="color:#000000" %)Метод запроса: **PUT** 249 249 250 -(% 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} 251 251 252 -(% style="color:#000000" %) {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизацииПараметрыв телезапроса(JSON): {«status»~:// «»,//статуспользователя(0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 253 253 254 -(% class="western" %) 255 -{{{ "description": "", // описание 256 - "data": "" // данные, связанные со сменой статуса}}} 308 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 257 257 258 -(% style="color:#000000" %) }310 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 259 259 312 +(% style="color:#000000" %){ 313 + 314 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 315 + "description": "" , ~/~/ описание 316 + "data": "" , ~/~/ данные, связанные со сменой статуса 317 + 318 + (% style="color:#000000" %)} 319 + 260 260 (% style="text-align:left" %) 261 261 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»** 262 262 ... ... @@ -272,8 +272,10 @@ 272 272 273 273 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id} 274 274 275 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя 276 276 337 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 338 + 277 277 (% style="text-align:left" %) 278 278 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 279 279 ... ... @@ -308,24 +308,20 @@ 308 308 309 309 (% style="color:#000000" %){ 310 310 311 -(% class="western" %) 312 -{{{ "vehicleId": “”, // идентификатор объекта 313 - "name": "", // имя объекта 314 - "imei": "", // IMEI объекта 315 - "deviceTypeId": “”, // идентификатор устройства объекта 316 - "deviceTypeName": "" // наименование устройства объекта 317 - "parentId": "", // идентификатор клиента-родителя 318 - "parentName": "" // наименование клиента-родителя, 319 - "modelId": "", // идентификатор модели объекта 320 - "modelName": "" // наименование модели объекта, 321 - "unitId": "", // идентификатор подразделения 322 - "unitName": "", // наименование подразделения 323 - "status": “”, // статус объекта 324 - ... 325 - }, 326 - ...}}} 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": "" , ~/~/ статус объекта 327 327 328 - (%style="color:#000000"%)}386 + } 329 329 330 330 (% style="text-align:left" %) 331 331 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: