Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 46.1 >
edited by Илья Крайнов
on 2022/11/21 10:27
To version < 22.7 >
edited by Артем Шемяков
on 2022/09/02 10:11
>
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
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -20,27 +20,20 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
23 +(% class="box infomessage" %)
24 24  (((
25 - (% 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**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% 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]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
36 +(% lang="en-US" %)
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -47,8 +47,8 @@
47 47  (% style="color:#000000" %){
48 48  
49 49  (% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
52 52  
53 53  (% lang="en-US" %)
54 54  }
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,7 +83,7 @@
83 83  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -107,7 +107,7 @@
107 107   "name": "", ~/~/ наименование клиента
108 108   "fullName": "", ~/~/ полное наименование клиента
109 109   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
111 111  }
112 112  
113 113  
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин (обязателен)
141 - "password": "", ~/~/ пароль (обязателен)
142 - "email": "", ~/~/ email (обязателен)
133 + "login": "", ~/~/ логин
134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 + "email": "", ~/~/ email
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
144 + "groups": "" , ~/~/ группы пользователя, названия групп
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -187,7 +187,7 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
191 191  
192 192  (% style="color:#000000" %)Метод запроса: **POST**
193 193  
... ... @@ -227,190 +227,12 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
230 -(% class="box successmessage" %)
231 -(((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 -)))
234 -
235 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 -
237 -(% style="color:#000000" %)Метод запроса: **GET**
238 -
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 -
241 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 -
243 -(% style="color:#000000" %)Ответ:
244 -
245 -(((
246 -(((
247 -{
248 -)))
249 -)))
250 -
251 -(((
252 -(((
253 - "id": "", ~/~/ GUID пользователя
254 -)))
255 -)))
256 -
257 -(((
258 -(((
259 - "lastName": "", ~/~/ Фамилия
260 -)))
261 -)))
262 -
263 -(((
264 -(((
265 - "firstName": "", ~/~/ Имя
266 -)))
267 -)))
268 -
269 -(((
270 -(((
271 - "position": "", ~/~/ Должность
272 -)))
273 -)))
274 -
275 -(((
276 -(((
277 - "phone": "", ~/~/ Номер телефона
278 -)))
279 -)))
280 -
281 -(((
282 -(((
283 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 -)))
285 -)))
286 -
287 -(((
288 -(((
289 - "parentName": "", Наименование клиента, которому принадлежит пользователь
290 -)))
291 -)))
292 -
293 -(((
294 -(((
295 - "organization": "", ~/~/ Организация
296 -)))
297 -)))
298 -
299 -(((
300 -(((
301 - "login": "", ~/~/ Логин пользователя
302 -)))
303 -)))
304 -
305 -(((
306 -(((
307 - "email": "", ~/~/ Адрес электронной почты
308 -)))
309 -)))
310 -
311 -(((
312 -(((
313 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 -)))
315 -)))
316 -
317 -(((
318 -(((
319 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 -)))
321 -)))
322 -
323 -(((
324 -(((
325 - "description": "", ~/~/ Описание
326 -)))
327 -)))
328 -
329 -(((
330 -(((
331 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 -)))
333 -)))
334 -
335 -(((
336 -(((
337 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 -)))
339 -)))
340 -
341 -(((
342 -(((
343 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 -)))
345 -)))
346 -
347 -(((
348 -(((
349 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 -)))
351 -)))
352 -
353 -(((
354 -(((
355 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 -)))
357 -)))
358 -
359 -(((
360 -(((
361 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 -)))
363 -)))
364 -
365 -(((
366 -(((
367 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 -)))
369 -)))
370 -
371 -(((
372 -(((
373 - "groups": [], ~/~/ Список ролей пользователя
374 -)))
375 -)))
376 -
377 -(((
378 -(((
379 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 -)))
381 -)))
382 -
383 -(((
384 -(((
385 - "authDevices": [ ], ~/~/ Список авторизованных устройств
386 -)))
387 -)))
388 -
389 -(((
390 -(((
391 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 -)))
393 -)))
394 -
395 -(((
396 -(((
397 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 -)))
399 -)))
400 -
401 -(((
402 -(((
403 -}
404 -)))
405 -)))
406 -
407 -
408 408  (% class="box warningmessage" %)
409 409  (((
410 410  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
411 411  )))
412 412  
413 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
414 414  
415 415  (% style="color:#000000" %)Метод запроса: **PUT**
416 416  
... ... @@ -418,8 +418,6 @@
418 418  
419 419  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
420 420  
421 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
422 -
423 423  (% lang="en-US" style="text-align:left" %)
424 424  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
425 425  
... ... @@ -433,10 +433,10 @@
433 433   "position": "" , ~/~/ должность
434 434   "phone": "" , ~/~/ телефон
435 435   "organization": "" , ~/~/ организация
436 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
249 + "login": "" , ~/~/ логин
250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 + "email": "" , ~/~/ email
252 + "description": "" , ~/~/ описание
440 440   "isEnabled": "" , ~/~/ признак включения
441 441   "parentId": "" , ~/~/ Guid родительского агента
442 442   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -483,7 +483,7 @@
483 483  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
484 484  )))
485 485  
486 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
487 487  
488 488  (% style="color:#000000" %)Метод запроса: **PUT**
489 489  
... ... @@ -507,69 +507,12 @@
507 507  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
508 508  
509 509  
510 -(% class="box warningmessage" %)
511 -(((
512 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
513 -)))
514 -
515 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
516 -
517 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
518 -
519 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
520 -
521 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
522 -
523 - [ 
524 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
525 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
526 - ]
527 -
528 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
529 -
530 -
531 -(% class="box warningmessage" %)
532 -(((
533 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
534 -)))
535 -
536 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
537 -
538 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 -
540 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
541 -
542 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543 -
544 - [ 
545 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 - ]
548 -
549 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
550 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
551 -
552 -(((
553 -В теле ответа:
554 -{
555 - "errorMessages": [
556 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
557 - ],
558 - "users": [
559 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 - ]
561 -}
562 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
563 -"users" - массив id пользователей, которых не удалось включить или отключить.
564 -
565 -)))
566 -
567 567  (% class="box errormessage" %)
568 568  (((
569 569  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
570 570  )))
571 571  
572 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
573 573  
574 574  (% style="color:#000000" %)Метод запроса: **DELETE**
575 575  
... ... @@ -595,7 +595,7 @@
595 595  
596 596  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
597 597  
598 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
599 599  
600 600  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
601 601  
... ... @@ -611,149 +611,22 @@
611 611  
612 612  (% style="color:#000000" %)Ответ:
613 613  
614 -(((
615 -{
616 -)))
370 +(% style="color:#000000" %){
617 617  
618 -(((
619 - "vehicleId": "", ~/~/ ID объекта
620 -)))
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": "" , ~/~/ статус объекта
621 621  
622 -(((
623 - "name": "", ~/~/ Имя объекта
624 -)))
625 -
626 -(((
627 - "imei": "", ~/~/ IMEI объекта
628 -)))
629 -
630 -(((
631 - "deviceTypeId": , ~/~/ ID типа устройства
632 -)))
633 -
634 -(((
635 - "deviceTypeName": "", ~/~/ Название типа устройства
636 -)))
637 -
638 -(((
639 - "sim1": "", ~/~/ Номер SIM1
640 -)))
641 -
642 -(((
643 - "parentId": "", Номер SIM2
644 -)))
645 -
646 -(((
647 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 -)))
649 -
650 -(((
651 - "modelId": "", ID модели объекта
652 -)))
653 -
654 -(((
655 - "modelName": "", Имя модели объекта
656 -)))
657 -
658 -(((
659 - "createdAt": "", Дата создания объекта
660 -)))
661 -
662 -(((
663 - "mileageCalcMethod": "", Выбранный метод расчета пробега
664 -)))
665 -
666 -(((
667 - "counters": { ~/~/ Нормы
668 -)))
669 -
670 -(((
671 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 -)))
673 -
674 -(((
675 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 -)))
677 -
678 -(((
679 - "mileage": "", ~/~/ Пробег по нормам в метрах
680 -)))
681 -
682 -(((
683 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 -)))
685 -
686 -(((
687 - },
688 -)))
689 -
690 -(((
691 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 -)))
693 -
694 -(((
695 - {
696 -)))
697 -
698 -(((
699 - "id": "", ~/~/ ID  задания
700 -)))
701 -
702 -(((
703 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 -)))
705 -
706 -(((
707 - "name": "", ~/~/ Наименование задания
708 -)))
709 -
710 -(((
711 - "description": "", ~/~/ Описание задания
712 -)))
713 -
714 -(((
715 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 -)))
717 -
718 -(((
719 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 -)))
721 -
722 -(((
723 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 -)))
725 -
726 -(((
727 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 -)))
729 -
730 -(((
731 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 -)))
733 -
734 -(((
735 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 -)))
737 -
738 -(((
739 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 -)))
741 -
742 -(((
743 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 -)))
745 -
746 -(((
747 - }
748 -)))
749 -
750 -(((
751 - ]
752 -)))
753 -
754 -(((
755 755  }
756 -)))
757 757  
758 758  (% style="text-align:left" %)
759 759  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -767,7 +767,7 @@
767 767  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
768 768  )))
769 769  
770 -(% 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**).
771 771  
772 772  (% style="color:#000000" %)Метод запроса: **POST**
773 773  
... ... @@ -789,22 +789,12 @@
789 789   "sim2": "" , ~/~/ Номер SIM2
790 790   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
791 791   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
792 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
793 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
794 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
795 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
796 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
797 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
798 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
799 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
800 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
801 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
802 - "counters": ~/~/ счетчики
803 - {
804 - "mileage": "" , ~/~/ пробег
805 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
806 - "motohours": "" , ~/~/ моточасы
807 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
808 808   },
809 809   "cmsv6Parameters": { ~/~/ параметры CMSv6
810 810   "enabled": true, ~/~/ флаг включения
... ... @@ -875,12 +875,7 @@
875 875  (% style="text-align:left" %)
876 876  (% style="color:#000000" %)}
877 877  
878 -**Валидация:**
879 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
880 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
881 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
882 882  
883 -
884 884  (% class="box successmessage" %)
885 885  (((
886 886  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -888,7 +888,7 @@
888 888  
889 889  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
890 890  
891 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
892 892  
893 893  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
894 894  
... ... @@ -914,19 +914,17 @@
914 914  
915 915  (% style="color:#000000" %)Параметры в теле запроса (JSON):
916 916  
531 +(% class="western" style="color:#000000" %)##{##
917 917  
918 -{
919 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
920 - "name": null, ~/~/ Имя ТС (string, опционально)
921 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
922 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
923 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
924 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
925 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
926 - "customFields": null ~/~/ значение любого из произвольных полей ТС
927 -}
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" %)}
928 928  
929 -
930 930  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
931 931  
932 932  (% style="color:#000000" %)Ответ:
... ... @@ -946,27 +946,29 @@
946 946   "modelName": "" ~/~/ наименование модели объекта
947 947   "unitId": "" ~/~/ идентификатор подразделения
948 948   "unitName": "" ~/~/ наименование подразделения
949 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
950 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
951 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
952 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
953 953  (% style="color:#000000" %)}
954 954  
955 955  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
956 956  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
957 957  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
958 958  (% class="box successmessage" %)
959 959  (((
960 960  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
961 961  )))
962 962  
963 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
964 964  
965 965  (% style="color:#000000" %)Метод запроса: **POST**
966 966  
967 967  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
968 968  
969 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
583 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
970 970  
971 971  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
972 972  
... ... @@ -1005,7 +1005,7 @@
1005 1005  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1006 1006  )))
1007 1007  
1008 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1009 1009  
1010 1010  (% style="color:#000000" %)Метод запроса: **PUT**
1011 1011  
... ... @@ -1017,7 +1017,6 @@
1017 1017  
1018 1018  (% style="color:#000000" %){    
1019 1019  
1020 -(((
1021 1021  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1022 1022   "parentId": "", ~/~/ ID клиента
1023 1023   "name": "", ~/~/ имя ТС
... ... @@ -1026,25 +1026,15 @@
1026 1026   "modelId": "", ~/~/ , ID модели    
1027 1027   "unitId": "", ~/~/ подразделения
1028 1028   "sim1": "", ~/~/ SIM 1
1029 - "sim2": "", ~/~/ SIM2     (%%)
1030 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1031 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1032 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1033 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1034 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1035 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1036 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1037 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1038 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1039 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1040 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1042 -(% style="color:#000000" %) "counters": 
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
1043 1043   {
1044 1044   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1045 1045   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1046 - "mileage": "", ~/~/ пробег, в метрах 
1047 - "motohours": "" ~/~/ моточасы, в секундах
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
1048 1048   }
1049 1049   "cmsv6Parameters": ~/~/ параметры CMSv6
1050 1050   {       
... ... @@ -1068,7 +1068,6 @@
1068 1068   "kind": "", ~/~/ Вид периодичности по времени
1069 1069   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1070 1070   } 
1071 -)))
1072 1072  
1073 1073  (% style="color:#000000" %)}
1074 1074  
... ... @@ -1122,24 +1122,19 @@
1122 1122  (% lang="en-US" style="text-align:left" %)
1123 1123  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1124 1124  
1125 -**валидация:**
1126 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1127 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1128 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1129 1129  
1130 -
1131 1131  (% class="box errormessage" %)
1132 1132  (((
1133 1133  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1134 1134  )))
1135 1135  
1136 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1137 1137  
1138 1138  (% style="color:#000000" %)Метод запроса: **DELETE**
1139 1139  
1140 1140  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1141 1141  
1142 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
739 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1143 1143  
1144 1144  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1145 1145  
... ... @@ -1157,7 +1157,7 @@
1157 1157  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1158 1158  )))
1159 1159  
1160 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1161 1161  
1162 1162  (% style="color:#000000" %)Метод запроса: **GET**
1163 1163  
... ... @@ -1186,7 +1186,7 @@
1186 1186  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1187 1187  )))
1188 1188  
1189 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1190 1190  
1191 1191  (% style="color:#000000" %)Метод запроса: **GET**
1192 1192  

Меню

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