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
-
... ... @@ -34,8 +34,18 @@ 34 34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% lang="en-US" %) 37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**37 +(% style="color:#000000" %)**Ответ:** 38 38 39 +(% lang="en-US" %) 40 +(% style="color:#000000" %){ 41 + 42 +(% lang="en-US" %) 43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации 44 + "User": "" , ~/~/ имя пользователя 45 + 46 +(% lang="en-US" %) 47 + } 48 + 39 39 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 40 40 41 41 ... ... @@ -82,16 +82,18 @@ 82 82 83 83 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 84 84 85 -(% style="color:#000000" %)Ответ: [ { 86 - "agentId": "", ~/~/ идентификатор клиента 87 - "parentId": "", ~/~/ идентификатор клиента-родителя 88 - "name": "", ~/~/ наименование клиента 89 - "fullName": "", ~/~/ полное наименование клиента 90 - "agentInfoType": "", ~/~/ тип клиента1 91 - "status": "", ~/~/ статус клиента 92 - }, … ] 95 +(% style="color:#000000" %)Ответ: 93 93 97 +(% style="color:#000000" %){ 98 + "agentId": "", ~/~/ идентификатор клиента 99 + "parentId": "", ~/~/ идентификатор клиента-родителя 100 + "name": "", ~/~/ наименование клиента 101 + "fullName": "", ~/~/ полное наименование клиента 102 + "agentInfoType": "", ~/~/ тип клиента1 103 + "status": "", ~/~/ статус клиента 104 + } 94 94 106 + 95 95 (% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)] 96 96 97 97 ... ... @@ -116,7 +116,7 @@ 116 116 (% style="color:#000000" %)Параметры в теле запроса (JSON): 117 117 118 118 (% style="color:#000000" %){ 119 - "lastName": "", ~/~/ фамилия 131 + "lastName": "", ~/~/ фамилия 120 120 "firstName": "", ~/~/ имя 121 121 "position": "", ~/~/ должность 122 122 "phone": "", ~/~/ телефон ... ... @@ -142,7 +142,7 @@ 142 142 (% style="color:#000000; font-weight:normal" %){ 143 143 144 144 (% style="text-align:left" %) 145 -(% style="color:#000000; font-weight:normal" %)"id": "" , ~/~/ ID пользователя 157 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 146 146 "lastName": "" , ~/~/ Фамилия , 147 147 "firstName": "" , ~/~/ Имя 148 148 "position": "" , ~/~/ Должность ... ... @@ -161,7 +161,7 @@ 161 161 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 162 162 163 163 (% style="text-align:left" %) 164 -(% style="color:#000000; font-weight:normal" %)} 176 +(% style="color:#000000; font-weight:normal" %) } 165 165 166 166 167 167 (% class="box successmessage" %) ... ... @@ -177,25 +177,38 @@ 177 177 178 178 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]] 179 179 180 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 181 181 182 -(% class="western" %) 183 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента 184 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно 185 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно 186 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}} 194 +(% style="color:#000000" %){ 187 187 188 -(% style="color:#000000" %)} 196 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 197 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 198 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 199 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 189 189 190 -(% style="color:#000000" %) Ответ:[{ «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail201 +(% style="color:#000000" %) } 191 191 192 -(% class="western" style="margin-bottom:19px" %) 193 -{{{ "sessionDuration":"", // длительность сессии в минутах}}} 203 +(% style="color:#000000" %)Ответ: 194 194 195 -(% lang="en-US" style="text-align:left" %) 196 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]** 205 +(% style="color:#000000" %){ (%%) 197 197 207 + "id": "" , ~/~/ идентификатор пользователя 208 + "lastName": "" , ~/~/ фамилия 209 + "firstName": "" , ~/~/ имя 210 + "position": "" , ~/~/ должность 211 + "phone": "" , ~/~/ телефон 212 + "parentId": "" , ~/~/ идентификатор клиента-родителя 213 + "parentName": "" , ~/~/ наименование клиента-родителя 214 + "organization": "" , ~/~/ организация 215 + "login": "" , ~/~/ логин 216 + "email": "" , ~/~/ E-mail 217 + "sessionDuration":"", ~/~/ длительность сессии в минутах 218 + "status": "1", ~/~/ статус пользователя 219 + "astLogged": "", ~/~/ дата/время последней авторизации 198 198 221 +(% style="color:#000000" %) } 222 + 223 + 199 199 (% class="box warningmessage" %) 200 200 ((( 201 201 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -210,9 +210,63 @@ 210 210 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 211 211 212 212 (% lang="en-US" style="text-align:left" %) 213 -(% 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): 214 214 240 +(% lang="en-US" style="text-align:left" %) 241 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 215 215 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 + 216 216 (% class="box warningmessage" %) 217 217 ((( 218 218 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**