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

Меню

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