Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 54.1 >
edited by Илья Крайнов
on 2022/11/24 11:15
To version < 22.8 >
edited by Артем Шемяков
on 2022/09/02 10:12
>
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,13 +1,8 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 -~{~{box cssClass="floatinginfobox" title="~*~*Contents~*~*"}}~{~{toc/}}~{~{/box}}
6 -\\= Level 1
7 -\\Hello
8 -\\== Level 2
9 -
10 -
11 11  (% class="box" style="text-align: center;" %)
12 12  (((
13 13  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -15,7 +15,7 @@
15 15  
16 16  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 17  
18 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
19 19  
20 20  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
21 21  
... ... @@ -25,27 +25,20 @@
25 25  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
26 26  )))
27 27  
28 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
29 29  (((
30 - (% 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**
31 31  )))
32 32  
33 33  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
34 34  
35 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
36 36  
37 -(% 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]]
38 38  
39 39  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
40 40  
41 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
42 -
43 -(% style="color:#000000" %){
44 - "login": "testuser",
45 - "password": "testuser"
46 -}(%%)
47 -
48 -
36 +(% lang="en-US" %)
49 49  (% style="color:#000000" %)**Ответ:**
50 50  
51 51  (% lang="en-US" %)
... ... @@ -52,8 +52,8 @@
52 52  (% style="color:#000000" %){
53 53  
54 54  (% lang="en-US" %)
55 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
56 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
57 57  
58 58  (% lang="en-US" %)
59 59  }
... ... @@ -66,7 +66,7 @@
66 66  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
70 70  
71 71  (% style="color:#000000" %)Метод запроса: **GET**
72 72  
... ... @@ -88,7 +88,7 @@
88 88  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
89 89  )))
90 90  
91 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
92 92  
93 93  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
94 94  
... ... @@ -112,152 +112,10 @@
112 112   "name": "", ~/~/ наименование клиента
113 113   "fullName": "", ~/~/ полное наименование клиента
114 114   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
115 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
116 116  }
117 117  
118 118  
119 -(% class="box successmessage" %)
120 -(((
121 -**Добавление клиента — POST /api/v3/agents **
122 -)))
123 -
124 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
125 -
126 -Метод запроса: **POST**
127 -
128 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
129 -
130 -В заголовках запроса: X-Auth: Токен авторизации
131 -
132 -Параметры в теле запроса (JSON):
133 -
134 -{
135 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 - "name": "string", ~/~/ имя
137 - "fullName": "string", ~/~/ полное наименование
138 - "isForeign": true, ~/~/ иностранный контрагент
139 - "district": "string", ~/~/ округ
140 - "region": "string", ~/~/ регион
141 - "city": "string", ~/~/ город
142 - "inn": "string", ~/~/ ИНН
143 - "kpp": "string", ~/~/ КПП
144 - "address": "string", ~/~/ юридический адрес
145 - "addressFact": "string", ~/~/ фактический адрес
146 - "email": "string", ~/~/ email
147 - "director": "string", ~/~/ ФИО руководителя
148 - "bankName": "string", ~/~/ банк
149 - "bankBIK": "string", ~/~/ БИК
150 - "bankRS": "string", ~/~/ номер счёта
151 - "bankKS": "string" ~/~/ корр. счёт
152 -}
153 -
154 -
155 -Ответ:
156 -
157 -{
158 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
159 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 - "name": "string", ~/~/ имя
161 - "fullName": "string", ~/~/ полное наименование
162 - "isForeign": true, ~/~/ иностранный контрагент
163 - "district": "string", ~/~/ округ
164 - "region": "string", ~/~/ регион
165 - "city": "string", ~/~/ город
166 - "inn": "string", ~/~/ ИНН
167 - "kpp": "string", ~/~/ КПП
168 - "address": "string", ~/~/ юридический адрес
169 - "addressFact": "string", ~/~/ фактический адрес
170 - "email": "string", ~/~/ email
171 - "director": "string", ~/~/ ФИО руководителя
172 - "bankName": "string", ~/~/ банк
173 - "bankBIK": "string", ~/~/ БИК
174 - "bankRS": "string", ~/~/ номер счёта
175 - "bankKS": "string" ~/~/ корр. счёт
176 -}
177 -
178 -
179 -(% class="box warningmessage" %)
180 -(((
181 -**Редактирование клиента — PUT /api/v3/agents**
182 -)))
183 -
184 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
185 -
186 -Метод запроса: **PUT**
187 -
188 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
189 -
190 -В заголовках запроса: X-Auth: Токен авторизации
191 -
192 -
193 -Параметры в теле запроса (JSON):
194 -
195 -{
196 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
197 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
198 - "name": "string", ~/~/ имя
199 - "fullName": "string", ~/~/ полное наименование
200 - "isForeign": true, ~/~/ иностранный контрагент
201 - "district": "string", ~/~/ округ
202 - "region": "string", ~/~/ регион
203 - "city": "string", ~/~/ город
204 - "inn": "string", ~/~/ ИНН
205 - "kpp": "string", ~/~/ КПП
206 - "address": "string", ~/~/ юридический адрес
207 - "addressFact": "string", ~/~/ фактический адрес
208 - "email": "string", ~/~/ email
209 - "director": "string", ~/~/ ФИО руководителя
210 - "bankName": "string", ~/~/ банк
211 - "bankBIK": "string", ~/~/ БИК
212 - "bankRS": "string", ~/~/ номер счёта
213 - "bankKS": "string" ~/~/ корр. счёт
214 -}
215 -
216 -
217 -Ответ:
218 -
219 -{
220 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
221 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
222 - "name": "string", ~/~/ имя
223 - "fullName": "string", ~/~/ полное наименование
224 - "isForeign": true, ~/~/ иностранный контрагент
225 - "district": "string", ~/~/ округ
226 - "region": "string", ~/~/ регион
227 - "city": "string", ~/~/ город
228 - "inn": "string", ~/~/ ИНН
229 - "kpp": "string", ~/~/ КПП
230 - "address": "string", ~/~/ юридический адрес
231 - "addressFact": "string", ~/~/ фактический адрес
232 - "email": "string", ~/~/ email
233 - "director": "string", ~/~/ ФИО руководителя
234 - "bankName": "string", ~/~/ банк
235 - "bankBIK": "string", ~/~/ БИК
236 - "bankRS": "string", ~/~/ номер счёта
237 - "bankKS": "string" ~/~/ корр. счёт
238 -}
239 -
240 -
241 -(% class="box errormessage" %)
242 -(((
243 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
244 -)))
245 -
246 -
247 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
248 -
249 -Метод запроса: **DELETE**
250 -
251 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
252 -
253 -Параметр запроса: **{clientId}** - Guid пользователя
254 -
255 -В заголовках запроса: X-Auth: Токен авторизации
256 -
257 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
258 -
259 -
260 -
261 261  (% class="box" style="text-align: center;" %)
262 262  (((
263 263  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -268,7 +268,7 @@
268 268  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
269 269  )))
270 270  
271 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
272 272  
273 273  (% style="color:#000000" %)Метод запроса: **POST**
274 274  
... ... @@ -284,9 +284,9 @@
284 284   "position": "", ~/~/ должность
285 285   "phone": "", ~/~/ телефон
286 286   "organization": "", ~/~/ организация
287 - "login": "", ~/~/ логин (обязателен)
288 - "password": "", ~/~/ пароль (обязателен)
289 - "email": "", ~/~/ email (обязателен)
133 + "login": "", ~/~/ логин
134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 + "email": "", ~/~/ email
290 290   "description": "", ~/~/ описание
291 291   "isEnabled": "", ~/~/ признак включения
292 292   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -295,7 +295,7 @@
295 295   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
296 296   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
297 297   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
298 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
144 + "groups": "" , ~/~/ группы пользователя, названия групп
299 299  }
300 300  
301 301  (% style="text-align:left" %)
... ... @@ -321,7 +321,7 @@
321 321   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
322 322   "kind": "" , ~/~/ тип аутентификации
323 323   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
324 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
325 325  
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -334,7 +334,7 @@
334 334  
335 335  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
336 336  
337 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
338 338  
339 339  (% style="color:#000000" %)Метод запроса: **POST**
340 340  
... ... @@ -374,60 +374,12 @@
374 374  (% style="color:#000000" %)}
375 375  
376 376  
377 -(% class="box successmessage" %)
378 -(((
379 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 -)))
381 -
382 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
383 -
384 -(% style="color:#000000" %)Метод запроса: **GET**
385 -
386 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
387 -
388 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
389 -
390 -(% style="color:#000000" %)Ответ:
391 -
392 -(((
393 -(((
394 -{
395 - "id": "", ~/~/ GUID пользователя
396 - "lastName": "", ~/~/ Фамилия 
397 - "firstName": "", ~/~/ Имя
398 - "position": "", ~/~/ Должность
399 - "phone": "", ~/~/ Номер телефона
400 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
401 - "parentName": "", Наименование клиента, которому принадлежит пользователь
402 - "organization": "", ~/~/ Организация
403 - "login": "", ~/~/ Логин пользователя
404 - "email": "", ~/~/ Адрес электронной почты
405 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
406 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
407 - "description": "", ~/~/ Описание
408 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
411 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
412 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
413 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
414 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
415 - "groups": [], ~/~/ Список ролей пользователя
416 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
417 - "authDevices": [ ], ~/~/ Список авторизованных устройств
418 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
419 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
420 -}
421 -)))
422 -)))
423 -
424 -
425 425  (% class="box warningmessage" %)
426 426  (((
427 427  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
428 428  )))
429 429  
430 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
431 431  
432 432  (% style="color:#000000" %)Метод запроса: **PUT**
433 433  
... ... @@ -435,8 +435,6 @@
435 435  
436 436  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
437 437  
438 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
439 -
440 440  (% lang="en-US" style="text-align:left" %)
441 441  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
442 442  
... ... @@ -450,10 +450,10 @@
450 450   "position": "" , ~/~/ должность
451 451   "phone": "" , ~/~/ телефон
452 452   "organization": "" , ~/~/ организация
453 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
454 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
455 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
456 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
249 + "login": "" , ~/~/ логин
250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 + "email": "" , ~/~/ email
252 + "description": "" , ~/~/ описание
457 457   "isEnabled": "" , ~/~/ признак включения
458 458   "parentId": "" , ~/~/ Guid родительского агента
459 459   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -500,7 +500,7 @@
500 500  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
501 501  )))
502 502  
503 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
504 504  
505 505  (% style="color:#000000" %)Метод запроса: **PUT**
506 506  
... ... @@ -524,69 +524,12 @@
524 524  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
525 525  
526 526  
527 -(% class="box warningmessage" %)
528 -(((
529 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
530 -)))
531 -
532 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
533 -
534 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
535 -
536 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
537 -
538 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
539 -
540 - [ 
541 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
542 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
543 - ]
544 -
545 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
546 -
547 -
548 -(% class="box warningmessage" %)
549 -(((
550 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
551 -)))
552 -
553 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
554 -
555 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
556 -
557 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
558 -
559 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
560 -
561 - [ 
562 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
563 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
564 - ]
565 -
566 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
567 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
568 -
569 -(((
570 -В теле ответа:
571 -{
572 - "errorMessages": [
573 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
574 - ],
575 - "users": [
576 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
577 - ]
578 -}
579 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
580 -"users" - массив id пользователей, которых не удалось включить или отключить.
581 -
582 -)))
583 -
584 584  (% class="box errormessage" %)
585 585  (((
586 586  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
587 587  )))
588 588  
589 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
590 590  
591 591  (% style="color:#000000" %)Метод запроса: **DELETE**
592 592  
... ... @@ -612,7 +612,7 @@
612 612  
613 613  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
614 614  
615 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
616 616  
617 617  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
618 618  
... ... @@ -628,44 +628,22 @@
628 628  
629 629  (% style="color:#000000" %)Ответ:
630 630  
631 -(((
632 -{
633 - "vehicleId": "", ~/~/ ID объекта
634 - "name": "", ~/~/ Имя объекта
635 - "imei": "", ~/~/ IMEI объекта
636 - "deviceTypeId": , ~/~/ ID типа устройства
637 - "deviceTypeName": "", ~/~/ Название типа устройства
638 - "sim1": "", ~/~/ Номер SIM1
639 - "parentId": "", Номер SIM2
640 - "parentName": "", Наименование клиента-родителя
641 - "modelId": "", ID модели объекта
642 - "modelName": "", Имя модели объекта
643 - "createdAt": "", Дата создания объекта
644 - "mileageCalcMethod": "", Выбранный метод расчета пробега
645 - "counters": { ~/~/ Нормы
646 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
647 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
648 - "mileage": "", ~/~/ Пробег по нормам в метрах
649 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
650 - },
651 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
652 - {
653 - "id": "", ~/~/ ID  задания
654 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
655 - "name": "", ~/~/ Наименование задания
656 - "description": "", ~/~/ Описание задания
657 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
659 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
660 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
661 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
662 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
663 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
664 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
665 - }
666 - ]
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 +
667 667  }
668 -)))
669 669  
670 670  (% style="text-align:left" %)
671 671  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -679,7 +679,7 @@
679 679  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
680 680  )))
681 681  
682 -(% 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**).
683 683  
684 684  (% style="color:#000000" %)Метод запроса: **POST**
685 685  
... ... @@ -701,22 +701,12 @@
701 701   "sim2": "" , ~/~/ Номер SIM2
702 702   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
703 703   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
704 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
705 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
706 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
707 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
708 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
709 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
710 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
711 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
712 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
713 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
714 - "counters": ~/~/ счетчики
715 - {
716 - "mileage": "" , ~/~/ пробег
717 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
718 - "motohours": "" , ~/~/ моточасы
719 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
720 720   },
721 721   "cmsv6Parameters": { ~/~/ параметры CMSv6
722 722   "enabled": true, ~/~/ флаг включения
... ... @@ -787,12 +787,7 @@
787 787  (% style="text-align:left" %)
788 788  (% style="color:#000000" %)}
789 789  
790 -**Валидация:**
791 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
792 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
793 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
794 794  
795 -
796 796  (% class="box successmessage" %)
797 797  (((
798 798  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -800,7 +800,7 @@
800 800  
801 801  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
802 802  
803 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
804 804  
805 805  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
806 806  
... ... @@ -826,17 +826,17 @@
826 826  
827 827  (% style="color:#000000" %)Параметры в теле запроса (JSON):
828 828  
829 -{
830 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
831 - "name": null, ~/~/ Имя ТС (string, опционально)
832 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
833 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
834 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
835 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
836 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
837 - "customFields": null ~/~/ значение любого из произвольных полей ТС
838 -}
531 +(% class="western" style="color:#000000" %)##{##
839 839  
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 +
840 840  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
841 841  
842 842  (% style="color:#000000" %)Ответ:
... ... @@ -856,30 +856,23 @@
856 856   "modelName": "" ~/~/ наименование модели объекта
857 857   "unitId": "" ~/~/ идентификатор подразделения
858 858   "unitName": "" ~/~/ наименование подразделения
859 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
860 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
861 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
862 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
863 - "customFields": [ 
864 - {
865 - "id": "", ~/~/ идентификатор произвольного поля
866 - "name": "", ~/~/ имя произвольного поля
867 - "value": "", ~/~/ значение произвольного поля
868 - "forClient": true, ~/~/ право на отображение у клиента
869 - "forTooltip": false, ~/~/ право на отображение в подсказке
870 - "forReport": false ~/~/ право на отображение в отчетах
871 - }(%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
872 872  (% style="color:#000000" %)}
873 873  
874 874  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
875 875  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
876 876  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
877 877  (% class="box successmessage" %)
878 878  (((
879 879  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
880 880  )))
881 881  
882 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
883 883  
884 884  (% style="color:#000000" %)Метод запроса: **POST**
885 885  
... ... @@ -924,7 +924,7 @@
924 924  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
925 925  )))
926 926  
927 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
928 928  
929 929  (% style="color:#000000" %)Метод запроса: **PUT**
930 930  
... ... @@ -936,7 +936,6 @@
936 936  
937 937  (% style="color:#000000" %){    
938 938  
939 -(((
940 940  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
941 941   "parentId": "", ~/~/ ID клиента
942 942   "name": "", ~/~/ имя ТС
... ... @@ -945,25 +945,15 @@
945 945   "modelId": "", ~/~/ , ID модели    
946 946   "unitId": "", ~/~/ подразделения
947 947   "sim1": "", ~/~/ SIM 1
948 - "sim2": "", ~/~/ SIM2     (%%)
949 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
950 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
951 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
952 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
953 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
954 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
955 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
956 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
957 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
958 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
959 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
960 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
961 -(% style="color:#000000" %) "counters": 
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
962 962   {
963 963   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
964 964   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
965 - "mileage": "", ~/~/ пробег, в метрах 
966 - "motohours": "" ~/~/ моточасы, в секундах
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
967 967   }
968 968   "cmsv6Parameters": ~/~/ параметры CMSv6
969 969   {       
... ... @@ -987,7 +987,6 @@
987 987   "kind": "", ~/~/ Вид периодичности по времени
988 988   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
989 989   } 
990 -)))
991 991  
992 992  (% style="color:#000000" %)}
993 993  
... ... @@ -1041,18 +1041,13 @@
1041 1041  (% lang="en-US" style="text-align:left" %)
1042 1042  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1043 1043  
1044 -**валидация:**
1045 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1046 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1047 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1048 1048  
1049 -
1050 1050  (% class="box errormessage" %)
1051 1051  (((
1052 1052  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1053 1053  )))
1054 1054  
1055 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1056 1056  
1057 1057  (% style="color:#000000" %)Метод запроса: **DELETE**
1058 1058  
... ... @@ -1076,7 +1076,7 @@
1076 1076  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1077 1077  )))
1078 1078  
1079 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1080 1080  
1081 1081  (% style="color:#000000" %)Метод запроса: **GET**
1082 1082  
... ... @@ -1105,7 +1105,7 @@
1105 1105  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1106 1106  )))
1107 1107  
1108 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1109 1109  
1110 1110  (% style="color:#000000" %)Метод запроса: **GET**
1111 1111  

Меню

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