Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 42.1 >
edited by Илья Крайнов
on 2022/11/18 17:35
To version < 66.14 >
edited by Илья Крайнов
on 2022/11/24 13:42
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,30 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
2 += Описание ГЛОНАССSoft Public API 3.0 =
3 3  
4 -== ==
5 5  
6 -(% class="box" style="text-align: center;" %)
7 -(((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 -)))
5 +{{toc/}}
10 10  
7 +
8 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
16 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
18 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
19 +
20 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
21 +
22 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
24 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
27 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -39,8 +39,8 @@
39 39   "login": "testuser",
40 40   "password": "testuser"
41 41  }(%%)
42 -
43 43  
42 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
57 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
61 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
64 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,16 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
75 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
77 -(((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 -)))
77 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
81 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
84 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -110,18 +110,159 @@
110 110   "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 111  }
112 112  
111 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
113 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
115 +**POST /api/v3/agents **
117 117  )))
118 118  
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 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
173 +
174 +(% class="box warningmessage" %)
175 +(((
176 +**PUT /api/v3/agents**
177 +)))
178 +
179 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
180 +
181 +Метод запроса: **PUT**
182 +
183 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
184 +
185 +В заголовках запроса: X-Auth: Токен авторизации
186 +
187 +
188 +Параметры в теле запроса (JSON):
189 +
190 +{
191 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
192 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
193 + "name": "string", ~/~/ имя
194 + "fullName": "string", ~/~/ полное наименование
195 + "isForeign": true, ~/~/ иностранный контрагент
196 + "district": "string", ~/~/ округ
197 + "region": "string", ~/~/ регион
198 + "city": "string", ~/~/ город
199 + "inn": "string", ~/~/ ИНН
200 + "kpp": "string", ~/~/ КПП
201 + "address": "string", ~/~/ юридический адрес
202 + "addressFact": "string", ~/~/ фактический адрес
203 + "email": "string", ~/~/ email
204 + "director": "string", ~/~/ ФИО руководителя
205 + "bankName": "string", ~/~/ банк
206 + "bankBIK": "string", ~/~/ БИК
207 + "bankRS": "string", ~/~/ номер счёта
208 + "bankKS": "string" ~/~/ корр. счёт
209 +}
210 +
211 +
212 +Ответ:
213 +
214 +{
215 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
216 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
217 + "name": "string", ~/~/ имя
218 + "fullName": "string", ~/~/ полное наименование
219 + "isForeign": true, ~/~/ иностранный контрагент
220 + "district": "string", ~/~/ округ
221 + "region": "string", ~/~/ регион
222 + "city": "string", ~/~/ город
223 + "inn": "string", ~/~/ ИНН
224 + "kpp": "string", ~/~/ КПП
225 + "address": "string", ~/~/ юридический адрес
226 + "addressFact": "string", ~/~/ фактический адрес
227 + "email": "string", ~/~/ email
228 + "director": "string", ~/~/ ФИО руководителя
229 + "bankName": "string", ~/~/ банк
230 + "bankBIK": "string", ~/~/ БИК
231 + "bankRS": "string", ~/~/ номер счёта
232 + "bankKS": "string" ~/~/ корр. счёт
233 +}
234 +
235 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
236 +
237 +(% class="box errormessage" %)
238 +(((
239 +**DELETE /api/v3/agents/{clientId}**
240 +)))
241 +
242 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
243 +
244 +Метод запроса: **DELETE**
245 +
246 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
247 +
248 +Параметр запроса: **{clientId}** - Guid пользователя
249 +
250 +В заголовках запроса: X-Auth: Токен авторизации
251 +
252 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
253 +
254 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
255 +
256 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
257 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
260 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
263 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -179,13 +179,14 @@
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
321 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
325 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
328 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -226,189 +226,63 @@
226 226  
227 227  (% style="color:#000000" %)}
228 228  
369 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
230 230  (% class="box successmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
373 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
376 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
239 239  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 240  
382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
383 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 244  (((
245 245  {
246 -)))
247 -)))
248 -
249 -(((
250 -(((
251 251   "id": "", ~/~/ GUID пользователя
252 -)))
253 -)))
254 -
255 -(((
256 -(((
257 - "lastName": "", ~/~/ Фамилия
258 -)))
259 -)))
260 -
261 -(((
262 -(((
390 + "lastName": "", ~/~/ Фамилия 
263 263   "firstName": "", ~/~/ Имя
264 -)))
265 -)))
266 -
267 -(((
268 -(((
269 269   "position": "", ~/~/ Должность
270 -)))
271 -)))
272 -
273 -(((
274 -(((
275 275   "phone": "", ~/~/ Номер телефона
276 -)))
277 -)))
278 -
279 -(((
280 -(((
281 281   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
282 -)))
283 -)))
284 -
285 -(((
286 -(((
287 287   "parentName": "", Наименование клиента, которому принадлежит пользователь
288 -)))
289 -)))
290 -
291 -(((
292 -(((
293 293   "organization": "", ~/~/ Организация
294 -)))
295 -)))
296 -
297 -(((
298 -(((
299 299   "login": "", ~/~/ Логин пользователя
300 -)))
301 -)))
302 -
303 -(((
304 -(((
305 305   "email": "", ~/~/ Адрес электронной почты
306 -)))
307 -)))
308 -
309 -(((
310 -(((
311 311   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
312 -)))
313 -)))
314 -
315 -(((
316 -(((
317 317   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
318 -)))
319 -)))
320 -
321 -(((
322 -(((
323 323   "description": "", ~/~/ Описание
324 -)))
325 -)))
326 -
327 -(((
328 -(((
329 329   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
330 -)))
331 -)))
332 -
333 -(((
334 -(((
335 335   "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
336 -)))
337 -)))
338 -
339 -(((
340 -(((
341 341   "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
342 -)))
343 -)))
344 -
345 -(((
346 -(((
347 347   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
348 -)))
349 -)))
350 -
351 -(((
352 -(((
353 353   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
354 -)))
355 -)))
356 -
357 -(((
358 -(((
359 359   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
360 -)))
361 -)))
362 -
363 -(((
364 -(((
365 365   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
366 -)))
367 -)))
368 -
369 -(((
370 -(((
371 371   "groups": [], ~/~/ Список ролей пользователя
372 -)))
373 -)))
374 -
375 -(((
376 -(((
377 377   "customGroups": [], ~/~/ Список клиентских ролей пользователя
378 -)))
379 -)))
380 -
381 -(((
382 -(((
383 383   "authDevices": [ ], ~/~/ Список авторизованных устройств
384 -)))
385 -)))
386 -
387 -(((
388 -(((
389 389   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
390 -)))
391 -)))
392 -
393 -(((
394 -(((
395 395   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
396 -)))
397 -)))
398 -
399 -(((
400 -(((
401 401  }
402 402  )))
403 403  )))
404 404  
418 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
405 405  
406 406  (% class="box warningmessage" %)
407 407  (((
408 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
422 +(% lang="en-US" %)**PUT /api/v3/users**
409 409  )))
410 410  
411 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
425 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
412 412  
413 413  (% style="color:#000000" %)Метод запроса: **PUT**
414 414  
... ... @@ -473,13 +473,14 @@
473 473  (% lang="en-US" style="text-align:left" %)
474 474  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
475 475  
490 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
476 476  
477 477  (% class="box warningmessage" %)
478 478  (((
479 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
494 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
480 480  )))
481 481  
482 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
497 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
483 483  
484 484  (% style="color:#000000" %)Метод запроса: **PUT**
485 485  
... ... @@ -502,10 +502,11 @@
502 502  (% style="text-align:left" %)
503 503  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
504 504  
520 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
505 505  
506 506  (% class="box warningmessage" %)
507 507  (((
508 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
524 +**POST /api/v3/users/disable**
509 509  )))
510 510  
511 511  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -523,10 +523,11 @@
523 523  
524 524  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
525 525  
542 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
526 526  
527 527  (% class="box warningmessage" %)
528 528  (((
529 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
546 +**POST /api/v3/users/enable**
530 530  )))
531 531  
532 532  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -557,15 +557,16 @@
557 557  }
558 558  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
559 559  "users" - массив id пользователей, которых не удалось включить или отключить.
560 -
561 561  )))
562 562  
579 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
580 +
563 563  (% class="box errormessage" %)
564 564  (((
565 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
583 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
566 566  )))
567 567  
568 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
586 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
569 569  
570 570  (% style="color:#000000" %)Метод запроса: **DELETE**
571 571  
... ... @@ -578,20 +578,18 @@
578 578  (% style="text-align:left" %)
579 579  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
580 580  
599 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
581 581  
582 -(% class="box" style="text-align: center;" %)
583 -(((
584 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
585 -)))
601 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
586 586  
587 587  (% class="box infomessage" %)
588 588  (((
589 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
605 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
590 590  )))
591 591  
592 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
608 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
593 593  
594 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
610 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
595 595  
596 596  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
597 597  
... ... @@ -609,145 +609,40 @@
609 609  
610 610  (((
611 611  {
612 -)))
613 -
614 -(((
615 615   "vehicleId": "", ~/~/ ID объекта
616 -)))
617 -
618 -(((
619 619   "name": "", ~/~/ Имя объекта
620 -)))
621 -
622 -(((
623 623   "imei": "", ~/~/ IMEI объекта
624 -)))
625 -
626 -(((
627 627   "deviceTypeId": , ~/~/ ID типа устройства
628 -)))
629 -
630 -(((
631 631   "deviceTypeName": "", ~/~/ Название типа устройства
632 -)))
633 -
634 -(((
635 635   "sim1": "", ~/~/ Номер SIM1
636 -)))
637 -
638 -(((
639 639   "parentId": "", Номер SIM2
640 -)))
641 -
642 -(((
643 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
644 -)))
645 -
646 -(((
635 + "parentName": "", Наименование клиента-родителя
647 647   "modelId": "", ID модели объекта
648 -)))
649 -
650 -(((
651 651   "modelName": "", Имя модели объекта
652 -)))
653 -
654 -(((
655 655   "createdAt": "", Дата создания объекта
656 -)))
657 -
658 -(((
659 659   "mileageCalcMethod": "", Выбранный метод расчета пробега
660 -)))
661 -
662 -(((
663 663   "counters": { ~/~/ Нормы
664 -)))
665 -
666 -(((
667 667   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
668 -)))
669 -
670 -(((
671 671   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
672 -)))
673 -
674 -(((
675 675   "mileage": "", ~/~/ Пробег по нормам в метрах
676 -)))
677 -
678 -(((
679 679   "motohours": "" ~/~/ Моточасы по нормам, в секундах
680 -)))
681 -
682 -(((
683 683   },
684 -)))
685 -
686 -(((
687 687   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
688 -)))
689 -
690 -(((
691 691   {
692 -)))
693 -
694 -(((
695 - "id": "", ~/~/ ID  задания
696 -)))
697 -
698 -(((
648 + "id": "", ~/~/ ID  задания
699 699   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
700 -)))
701 -
702 -(((
703 703   "name": "", ~/~/ Наименование задания
704 -)))
705 -
706 -(((
707 707   "description": "", ~/~/ Описание задания
708 -)))
709 -
710 -(((
711 711   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
712 -)))
713 -
714 -(((
715 715   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
716 -)))
717 -
718 -(((
719 719   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
720 -)))
721 -
722 -(((
723 723   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
724 -)))
725 -
726 -(((
727 727   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
728 -)))
729 -
730 -(((
731 731   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
732 -)))
733 -
734 -(((
735 735   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
736 -)))
737 -
738 -(((
739 739   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
740 -)))
741 -
742 -(((
743 743   }
744 -)))
745 -
746 -(((
747 747   ]
748 -)))
749 -
750 -(((
751 751  }
752 752  )))
753 753  
... ... @@ -757,13 +757,14 @@
757 757  (% style="text-align:left" %)
758 758  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
759 759  
671 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
760 760  
761 761  (% class="box successmessage" %)
762 762  (((
763 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
675 +(% lang="en-US" %)**POST /api/v3/vehicles**
764 764  )))
765 765  
766 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
678 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
767 767  
768 768  (% style="color:#000000" %)Метод запроса: **POST**
769 769  
... ... @@ -876,15 +876,16 @@
876 876  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
877 877  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
878 878  
791 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
879 879  
880 880  (% class="box successmessage" %)
881 881  (((
882 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
795 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
883 883  )))
884 884  
885 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
798 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
886 886  
887 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
800 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
888 888  
889 889  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
890 890  
... ... @@ -910,19 +910,19 @@
910 910  
911 911  (% style="color:#000000" %)Параметры в теле запроса (JSON):
912 912  
913 -(% class="western" style="color:#000000" %)##{##
826 +{
827 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
828 + "name": null, ~/~/ Имя ТС (string, опционально)
829 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
830 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
831 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
832 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
833 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
834 + "customFields": null ~/~/ значение любого из произвольных полей ТС
835 +}
914 914  
915 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
916 - "name": null, ~/~/ Имя ТС (string, опционально) 
917 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
918 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
919 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
920 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
921 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
922 -(% style="color:#000000" %)}
837 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
923 923  
924 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
925 -
926 926  (% style="color:#000000" %)Ответ:
927 927  
928 928  (% style="color:#000000" %){
... ... @@ -943,18 +943,28 @@
943 943   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
944 944   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
945 945   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
946 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
859 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
860 + "customFields": [ 
861 + {
862 + "id": "", ~/~/ идентификатор произвольного поля
863 + "name": "", ~/~/ имя произвольного поля
864 + "value": "", ~/~/ значение произвольного поля
865 + "forClient": true, ~/~/ право на отображение у клиента
866 + "forTooltip": false, ~/~/ право на отображение в подсказке
867 + "forReport": false ~/~/ право на отображение в отчетах
868 + }(%%)
947 947  (% style="color:#000000" %)}
948 948  
949 949  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
950 950  
873 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
951 951  
952 952  (% class="box successmessage" %)
953 953  (((
954 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
877 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
955 955  )))
956 956  
957 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
880 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
958 958  
959 959  (% style="color:#000000" %)Метод запроса: **POST**
960 960  
... ... @@ -993,13 +993,14 @@
993 993  (% style="text-align:left" %)
994 994  (% style="color:#000000" %) }
995 995  
919 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
996 996  
997 997  (% class="box warningmessage" %)
998 998  (((
999 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
923 +(% lang="en-US" %)**PUT /api/v3/vehicles**
1000 1000  )))
1001 1001  
1002 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
926 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1003 1003  
1004 1004  (% style="color:#000000" %)Метод запроса: **PUT**
1005 1005  
... ... @@ -1121,13 +1121,14 @@
1121 1121  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1122 1122  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1123 1123  
1048 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1124 1124  
1125 1125  (% class="box errormessage" %)
1126 1126  (((
1127 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1052 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1128 1128  )))
1129 1129  
1130 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1055 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1131 1131  
1132 1132  (% style="color:#000000" %)Метод запроса: **DELETE**
1133 1133  
... ... @@ -1140,18 +1140,16 @@
1140 1140  (% style="text-align:left" %)
1141 1141  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1142 1142  
1068 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1143 1143  
1144 -(% class="box" lang="en-US" style="text-align: center;" %)
1145 -(((
1146 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1147 -)))
1070 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1148 1148  
1149 1149  (% class="box infomessage" %)
1150 1150  (((
1151 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1074 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1152 1152  )))
1153 1153  
1154 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1077 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1155 1155  
1156 1156  (% style="color:#000000" %)Метод запроса: **GET**
1157 1157  
... ... @@ -1170,17 +1170,17 @@
1170 1170  (% style="color:#000000" %)}
1171 1171  
1172 1172  
1173 -(% class="box" style="text-align: center;" %)
1174 -(((
1175 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1176 -)))
1096 += (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1177 1177  
1098 +
1099 +== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1100 +
1178 1178  (% class="box infomessage" %)
1179 1179  (((
1180 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1103 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1181 1181  )))
1182 1182  
1183 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1106 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1184 1184  
1185 1185  (% style="color:#000000" %)Метод запроса: **GET**
1186 1186  

Меню

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