Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 53.1 >
edited by Илья Крайнов
on 2022/11/24 11:10
To version < 23.1 >
edited by Артем Шемяков
on 2022/09/02 10:15
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,6 +1,7 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 5  (% class="box" style="text-align: center;" %)
6 6  (((
... ... @@ -9,7 +9,7 @@
9 9  
10 10  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
13 13  
14 14  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 15  
... ... @@ -19,27 +19,20 @@
19 19  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
20 20  )))
21 21  
22 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
23 23  (((
24 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 25  )))
26 26  
27 27  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 28  
29 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
30 30  
31 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
32 32  
33 33  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 34  
35 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
36 -
37 -(% style="color:#000000" %){
38 - "login": "testuser",
39 - "password": "testuser"
40 -}(%%)
41 -
42 -
36 +(% lang="en-US" %)
43 43  (% style="color:#000000" %)**Ответ:**
44 44  
45 45  (% lang="en-US" %)
... ... @@ -46,8 +46,8 @@
46 46  (% style="color:#000000" %){
47 47  
48 48  (% lang="en-US" %)
49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
50 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
51 51  
52 52  (% lang="en-US" %)
53 53  }
... ... @@ -60,7 +60,7 @@
60 60  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
61 61  )))
62 62  
63 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
64 64  
65 65  (% style="color:#000000" %)Метод запроса: **GET**
66 66  
... ... @@ -82,7 +82,7 @@
82 82  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
83 83  )))
84 84  
85 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
86 86  
87 87  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
88 88  
... ... @@ -106,152 +106,10 @@
106 106   "name": "", ~/~/ наименование клиента
107 107   "fullName": "", ~/~/ полное наименование клиента
108 108   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
109 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
110 110  }
111 111  
112 112  
113 -(% class="box successmessage" %)
114 -(((
115 -**Добавление клиента — POST /api/v3/agents **
116 -)))
117 -
118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
119 -
120 -Метод запроса: **POST**
121 -
122 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
123 -
124 -В заголовках запроса: X-Auth: Токен авторизации
125 -
126 -Параметры в теле запроса (JSON):
127 -
128 -{
129 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 - "name": "string", ~/~/ имя
131 - "fullName": "string", ~/~/ полное наименование
132 - "isForeign": true, ~/~/ иностранный контрагент
133 - "district": "string", ~/~/ округ
134 - "region": "string", ~/~/ регион
135 - "city": "string", ~/~/ город
136 - "inn": "string", ~/~/ ИНН
137 - "kpp": "string", ~/~/ КПП
138 - "address": "string", ~/~/ юридический адрес
139 - "addressFact": "string", ~/~/ фактический адрес
140 - "email": "string", ~/~/ email
141 - "director": "string", ~/~/ ФИО руководителя
142 - "bankName": "string", ~/~/ банк
143 - "bankBIK": "string", ~/~/ БИК
144 - "bankRS": "string", ~/~/ номер счёта
145 - "bankKS": "string" ~/~/ корр. счёт
146 -}
147 -
148 -
149 -Ответ:
150 -
151 -{
152 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
153 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 - "name": "string", ~/~/ имя
155 - "fullName": "string", ~/~/ полное наименование
156 - "isForeign": true, ~/~/ иностранный контрагент
157 - "district": "string", ~/~/ округ
158 - "region": "string", ~/~/ регион
159 - "city": "string", ~/~/ город
160 - "inn": "string", ~/~/ ИНН
161 - "kpp": "string", ~/~/ КПП
162 - "address": "string", ~/~/ юридический адрес
163 - "addressFact": "string", ~/~/ фактический адрес
164 - "email": "string", ~/~/ email
165 - "director": "string", ~/~/ ФИО руководителя
166 - "bankName": "string", ~/~/ банк
167 - "bankBIK": "string", ~/~/ БИК
168 - "bankRS": "string", ~/~/ номер счёта
169 - "bankKS": "string" ~/~/ корр. счёт
170 -}
171 -
172 -
173 -(% class="box warningmessage" %)
174 -(((
175 -**Редактирование клиента — PUT /api/v3/agents**
176 -)))
177 -
178 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
179 -
180 -Метод запроса: **PUT**
181 -
182 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
183 -
184 -В заголовках запроса: X-Auth: Токен авторизации
185 -
186 -
187 -Параметры в теле запроса (JSON):
188 -
189 -{
190 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
191 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
192 - "name": "string", ~/~/ имя
193 - "fullName": "string", ~/~/ полное наименование
194 - "isForeign": true, ~/~/ иностранный контрагент
195 - "district": "string", ~/~/ округ
196 - "region": "string", ~/~/ регион
197 - "city": "string", ~/~/ город
198 - "inn": "string", ~/~/ ИНН
199 - "kpp": "string", ~/~/ КПП
200 - "address": "string", ~/~/ юридический адрес
201 - "addressFact": "string", ~/~/ фактический адрес
202 - "email": "string", ~/~/ email
203 - "director": "string", ~/~/ ФИО руководителя
204 - "bankName": "string", ~/~/ банк
205 - "bankBIK": "string", ~/~/ БИК
206 - "bankRS": "string", ~/~/ номер счёта
207 - "bankKS": "string" ~/~/ корр. счёт
208 -}
209 -
210 -
211 -Ответ:
212 -
213 -{
214 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
215 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
216 - "name": "string", ~/~/ имя
217 - "fullName": "string", ~/~/ полное наименование
218 - "isForeign": true, ~/~/ иностранный контрагент
219 - "district": "string", ~/~/ округ
220 - "region": "string", ~/~/ регион
221 - "city": "string", ~/~/ город
222 - "inn": "string", ~/~/ ИНН
223 - "kpp": "string", ~/~/ КПП
224 - "address": "string", ~/~/ юридический адрес
225 - "addressFact": "string", ~/~/ фактический адрес
226 - "email": "string", ~/~/ email
227 - "director": "string", ~/~/ ФИО руководителя
228 - "bankName": "string", ~/~/ банк
229 - "bankBIK": "string", ~/~/ БИК
230 - "bankRS": "string", ~/~/ номер счёта
231 - "bankKS": "string" ~/~/ корр. счёт
232 -}
233 -
234 -
235 -(% class="box errormessage" %)
236 -(((
237 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
238 -)))
239 -
240 -
241 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
242 -
243 -Метод запроса: **DELETE**
244 -
245 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
246 -
247 -Параметр запроса: **{clientId}** - Guid пользователя
248 -
249 -В заголовках запроса: X-Auth: Токен авторизации
250 -
251 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
252 -
253 -
254 -
255 255  (% class="box" style="text-align: center;" %)
256 256  (((
257 257  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -262,7 +262,7 @@
262 262  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
263 263  )))
264 264  
265 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
266 266  
267 267  (% style="color:#000000" %)Метод запроса: **POST**
268 268  
... ... @@ -278,9 +278,9 @@
278 278   "position": "", ~/~/ должность
279 279   "phone": "", ~/~/ телефон
280 280   "organization": "", ~/~/ организация
281 - "login": "", ~/~/ логин (обязателен)
282 - "password": "", ~/~/ пароль (обязателен)
283 - "email": "", ~/~/ email (обязателен)
133 + "login": "", ~/~/ логин
134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 + "email": "", ~/~/ email
284 284   "description": "", ~/~/ описание
285 285   "isEnabled": "", ~/~/ признак включения
286 286   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -289,7 +289,7 @@
289 289   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
290 290   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
291 291   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
292 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
144 + "groups": "" , ~/~/ группы пользователя, названия групп
293 293  }
294 294  
295 295  (% style="text-align:left" %)
... ... @@ -315,7 +315,7 @@
315 315   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
316 316   "kind": "" , ~/~/ тип аутентификации
317 317   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
318 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
319 319  
320 320  (% style="text-align:left" %)
321 321  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -328,7 +328,7 @@
328 328  
329 329  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
330 330  
331 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
332 332  
333 333  (% style="color:#000000" %)Метод запроса: **POST**
334 334  
... ... @@ -368,60 +368,12 @@
368 368  (% style="color:#000000" %)}
369 369  
370 370  
371 -(% class="box successmessage" %)
372 -(((
373 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 -)))
375 -
376 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
377 -
378 -(% style="color:#000000" %)Метод запроса: **GET**
379 -
380 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
381 -
382 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
383 -
384 -(% style="color:#000000" %)Ответ:
385 -
386 -(((
387 -(((
388 -{
389 - "id": "", ~/~/ GUID пользователя
390 - "lastName": "", ~/~/ Фамилия 
391 - "firstName": "", ~/~/ Имя
392 - "position": "", ~/~/ Должность
393 - "phone": "", ~/~/ Номер телефона
394 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
395 - "parentName": "", Наименование клиента, которому принадлежит пользователь
396 - "organization": "", ~/~/ Организация
397 - "login": "", ~/~/ Логин пользователя
398 - "email": "", ~/~/ Адрес электронной почты
399 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
400 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
401 - "description": "", ~/~/ Описание
402 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
403 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
404 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
405 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
406 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
407 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
408 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
409 - "groups": [], ~/~/ Список ролей пользователя
410 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
411 - "authDevices": [ ], ~/~/ Список авторизованных устройств
412 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
413 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
414 -}
415 -)))
416 -)))
417 -
418 -
419 419  (% class="box warningmessage" %)
420 420  (((
421 421  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
422 422  )))
423 423  
424 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
425 425  
426 426  (% style="color:#000000" %)Метод запроса: **PUT**
427 427  
... ... @@ -429,8 +429,6 @@
429 429  
430 430  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
431 431  
432 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
433 -
434 434  (% lang="en-US" style="text-align:left" %)
435 435  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
436 436  
... ... @@ -444,10 +444,10 @@
444 444   "position": "" , ~/~/ должность
445 445   "phone": "" , ~/~/ телефон
446 446   "organization": "" , ~/~/ организация
447 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
448 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
449 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
450 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
249 + "login": "" , ~/~/ логин
250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 + "email": "" , ~/~/ email
252 + "description": "" , ~/~/ описание
451 451   "isEnabled": "" , ~/~/ признак включения
452 452   "parentId": "" , ~/~/ Guid родительского агента
453 453   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -494,7 +494,7 @@
494 494  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 495  )))
496 496  
497 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
498 498  
499 499  (% style="color:#000000" %)Метод запроса: **PUT**
500 500  
... ... @@ -518,69 +518,12 @@
518 518  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
519 519  
520 520  
521 -(% class="box warningmessage" %)
522 -(((
523 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
524 -)))
525 -
526 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
527 -
528 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
529 -
530 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
531 -
532 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
533 -
534 - [ 
535 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
536 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
537 - ]
538 -
539 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
540 -
541 -
542 -(% class="box warningmessage" %)
543 -(((
544 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
545 -)))
546 -
547 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
548 -
549 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
550 -
551 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
552 -
553 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
554 -
555 - [ 
556 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
557 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
558 - ]
559 -
560 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
561 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
562 -
563 -(((
564 -В теле ответа:
565 -{
566 - "errorMessages": [
567 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
568 - ],
569 - "users": [
570 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
571 - ]
572 -}
573 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
574 -"users" - массив id пользователей, которых не удалось включить или отключить.
575 -
576 -)))
577 -
578 578  (% class="box errormessage" %)
579 579  (((
580 580  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
581 581  )))
582 582  
583 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
584 584  
585 585  (% style="color:#000000" %)Метод запроса: **DELETE**
586 586  
... ... @@ -606,7 +606,7 @@
606 606  
607 607  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
608 608  
609 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
610 610  
611 611  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
612 612  
... ... @@ -622,44 +622,22 @@
622 622  
623 623  (% style="color:#000000" %)Ответ:
624 624  
625 -(((
626 -{
627 - "vehicleId": "", ~/~/ ID объекта
628 - "name": "", ~/~/ Имя объекта
629 - "imei": "", ~/~/ IMEI объекта
630 - "deviceTypeId": , ~/~/ ID типа устройства
631 - "deviceTypeName": "", ~/~/ Название типа устройства
632 - "sim1": "", ~/~/ Номер SIM1
633 - "parentId": "", Номер SIM2
634 - "parentName": "", Наименование клиента-родителя
635 - "modelId": "", ID модели объекта
636 - "modelName": "", Имя модели объекта
637 - "createdAt": "", Дата создания объекта
638 - "mileageCalcMethod": "", Выбранный метод расчета пробега
639 - "counters": { ~/~/ Нормы
640 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
641 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
642 - "mileage": "", ~/~/ Пробег по нормам в метрах
643 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
644 - },
645 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
646 - {
647 - "id": "", ~/~/ ID  задания
648 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
649 - "name": "", ~/~/ Наименование задания
650 - "description": "", ~/~/ Описание задания
651 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
652 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
653 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
654 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
655 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
656 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
657 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
658 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
659 - }
660 - ]
370 +(% style="color:#000000" %){
371 +
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 +
661 661  }
662 -)))
663 663  
664 664  (% style="text-align:left" %)
665 665  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -673,7 +673,7 @@
673 673  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
674 674  )))
675 675  
676 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
677 677  
678 678  (% style="color:#000000" %)Метод запроса: **POST**
679 679  
... ... @@ -695,22 +695,12 @@
695 695   "sim2": "" , ~/~/ Номер SIM2
696 696   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
697 697   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
698 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
699 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
700 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
701 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
702 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
703 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
704 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
705 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
706 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
707 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
708 - "counters": ~/~/ счетчики
709 - {
710 - "mileage": "" , ~/~/ пробег
711 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
712 - "motohours": "" , ~/~/ моточасы
713 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
714 714   },
715 715   "cmsv6Parameters": { ~/~/ параметры CMSv6
716 716   "enabled": true, ~/~/ флаг включения
... ... @@ -781,12 +781,7 @@
781 781  (% style="text-align:left" %)
782 782  (% style="color:#000000" %)}
783 783  
784 -**Валидация:**
785 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
786 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
787 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
788 788  
789 -
790 790  (% class="box successmessage" %)
791 791  (((
792 792  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -794,7 +794,7 @@
794 794  
795 795  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
796 796  
797 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
798 798  
799 799  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
800 800  
... ... @@ -820,17 +820,17 @@
820 820  
821 821  (% style="color:#000000" %)Параметры в теле запроса (JSON):
822 822  
823 -{
824 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
825 - "name": null, ~/~/ Имя ТС (string, опционально)
826 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
827 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
828 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
829 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
830 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
831 - "customFields": null ~/~/ значение любого из произвольных полей ТС
832 -}
531 +(% class="western" style="color:#000000" %)##{##
833 833  
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 + "name": null, ~/~/ Имя ТС (string, опционально) 
535 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
540 +(% style="color:#000000" %)}
541 +
834 834  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
835 835  
836 836  (% style="color:#000000" %)Ответ:
... ... @@ -850,30 +850,23 @@
850 850   "modelName": "" ~/~/ наименование модели объекта
851 851   "unitId": "" ~/~/ идентификатор подразделения
852 852   "unitName": "" ~/~/ наименование подразделения
853 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
854 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
855 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
856 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
857 - "customFields": [ 
858 - {
859 - "id": "", ~/~/ идентификатор произвольного поля
860 - "name": "", ~/~/ имя произвольного поля
861 - "value": "", ~/~/ значение произвольного поля
862 - "forClient": true, ~/~/ право на отображение у клиента
863 - "forTooltip": false, ~/~/ право на отображение в подсказке
864 - "forReport": false ~/~/ право на отображение в отчетах
865 - }(%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
866 866  (% style="color:#000000" %)}
867 867  
868 868  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
869 869  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
870 870  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
871 871  (% class="box successmessage" %)
872 872  (((
873 873  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
874 874  )))
875 875  
876 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
877 877  
878 878  (% style="color:#000000" %)Метод запроса: **POST**
879 879  
... ... @@ -918,7 +918,7 @@
918 918  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
919 919  )))
920 920  
921 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
922 922  
923 923  (% style="color:#000000" %)Метод запроса: **PUT**
924 924  
... ... @@ -930,7 +930,6 @@
930 930  
931 931  (% style="color:#000000" %){    
932 932  
933 -(((
934 934  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
935 935   "parentId": "", ~/~/ ID клиента
936 936   "name": "", ~/~/ имя ТС
... ... @@ -939,25 +939,15 @@
939 939   "modelId": "", ~/~/ , ID модели    
940 940   "unitId": "", ~/~/ подразделения
941 941   "sim1": "", ~/~/ SIM 1
942 - "sim2": "", ~/~/ SIM2     (%%)
943 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
944 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
945 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
946 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
947 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
948 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
949 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
950 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
951 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
952 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
953 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
954 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
955 -(% style="color:#000000" %) "counters": 
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
956 956   {
957 957   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
958 958   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
959 - "mileage": "", ~/~/ пробег, в метрах 
960 - "motohours": "" ~/~/ моточасы, в секундах
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
961 961   }
962 962   "cmsv6Parameters": ~/~/ параметры CMSv6
963 963   {       
... ... @@ -981,7 +981,6 @@
981 981   "kind": "", ~/~/ Вид периодичности по времени
982 982   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
983 983   } 
984 -)))
985 985  
986 986  (% style="color:#000000" %)}
987 987  
... ... @@ -1035,18 +1035,13 @@
1035 1035  (% lang="en-US" style="text-align:left" %)
1036 1036  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1037 1037  
1038 -**валидация:**
1039 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1040 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1041 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1042 1042  
1043 -
1044 1044  (% class="box errormessage" %)
1045 1045  (((
1046 1046  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1047 1047  )))
1048 1048  
1049 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1050 1050  
1051 1051  (% style="color:#000000" %)Метод запроса: **DELETE**
1052 1052  
... ... @@ -1070,7 +1070,7 @@
1070 1070  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1071 1071  )))
1072 1072  
1073 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1074 1074  
1075 1075  (% style="color:#000000" %)Метод запроса: **GET**
1076 1076  
... ... @@ -1099,7 +1099,7 @@
1099 1099  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1100 1100  )))
1101 1101  
1102 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1103 1103  
1104 1104  (% style="color:#000000" %)Метод запроса: **GET**
1105 1105  

Меню

ГЛОНАССSoft wiki - 2024 г.