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

Summary

Details

Icon Page properties
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  
... ... @@ -31,7 +31,7 @@
31 31  
32 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 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 37  (% style="color:#000000" %)**Ответ:**
... ... @@ -44,7 +44,7 @@
44 44   "User": "" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 -}
47 + }
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
... ... @@ -82,13 +82,13 @@
82 82  
83 83  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84 84  
85 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
85 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
86 86  
87 87  (% style="color:#000000" %)Метод запроса: **GET**
88 88  
89 89  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
91 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
92 92  
93 93  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94 94  
... ... @@ -99,11 +99,14 @@
99 99   "parentId": "", ~/~/ идентификатор клиента-родителя
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
102 + "agentInfoType": "", ~/~/ тип клиента1
103 103   "status": "", ~/~/ статус клиента
104 -}
104 + }
105 105  
106 106  
107 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
108 +
109 +
107 107  (% class="box" style="text-align: center;" %)
108 108  (((
109 109  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -142,7 +142,7 @@
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 144   "groups": "" , ~/~/ группы пользователя, названия групп
145 -}
148 + }
146 146  
147 147  (% style="text-align:left" %)
148 148  (% style="color:#000000; font-weight:normal" %)Ответ:
... ... @@ -170,7 +170,7 @@
170 170   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
171 171  
172 172  (% style="text-align:left" %)
173 -(% style="color:#000000; font-weight:normal" %)}
176 +(% style="color:#000000; font-weight:normal" %) }
174 174  
175 175  
176 176  (% class="box successmessage" %)
... ... @@ -186,10 +186,8 @@
186 186  
187 187  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
188 188  
189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
190 190  
191 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
192 -
193 193  (% style="color:#000000" %){
194 194  
195 195   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -197,7 +197,7 @@
197 197   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
198 198   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
199 199  
200 -(% style="color:#000000" %)}
201 +(% style="color:#000000" %) }
201 201  
202 202  (% style="color:#000000" %)Ответ:
203 203  
... ... @@ -217,7 +217,7 @@
217 217   "status": "1",  ~/~/ статус пользователя
218 218   "astLogged": "", ~/~/ дата/время последней авторизации
219 219  
220 -(% style="color:#000000" %)}
221 +(% style="color:#000000" %) }
221 221  
222 222  
223 223  (% class="box warningmessage" %)
... ... @@ -260,16 +260,16 @@
260 260   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
261 261  
262 262  (% lang="en-US" style="text-align:left" %)
263 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //__}__
264 264  
265 265  (% lang="en-US" style="text-align:left" %)
266 266  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
267 267  
268 268  (% lang="en-US" style="text-align:left" %)
269 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
270 270  
271 271  (% lang="en-US" style="text-align:left" %)
272 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
273 273   "lastName": "" , ~/~/ фамилия
274 274   "firstName": "" , ~/~/ имя
275 275   "position": "" , ~/~/ должность
... ... @@ -285,10 +285,10 @@
285 285   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
286 286   "kind": "" , ~/~/ тип аутентификации
287 287   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
288 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
289 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
289 289  
290 290  (% lang="en-US" style="text-align:left" %)
291 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
292 292  
293 293  
294 294  (% class="box warningmessage" %)
... ... @@ -302,7 +302,7 @@
302 302  
303 303  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
304 304  
305 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
306 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
306 306  
307 307  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
308 308  
... ... @@ -314,7 +314,7 @@
314 314   "description": "" , ~/~/ описание
315 315   "data": "" , ~/~/ данные, связанные со сменой статуса
316 316  
317 -(% style="color:#000000" %)}
318 + (% style="color:#000000" %)}
318 318  
319 319  (% style="text-align:left" %)
320 320  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
... ... @@ -331,7 +331,7 @@
331 331  
332 332  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
333 333  
334 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
335 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
335 335  
336 336  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337 337  
... ... @@ -355,13 +355,13 @@
355 355  
356 356  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
357 357  
358 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
359 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
359 359  
360 360  (% style="color:#000000" %)Метод запроса: **GET**
361 361  
362 362  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
363 363  
364 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
365 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
365 365  
366 366  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
367 367  
... ... @@ -382,7 +382,7 @@
382 382   "unitName": "" , ~/~/ наименование подразделения
383 383   "status": "" , ~/~/ статус объекта
384 384  
385 -}
386 + }
386 386  
387 387  (% style="text-align:left" %)
388 388  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -424,7 +424,7 @@
424 424   "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 425   "motohours": "" , ~/~/ моточасы
426 426   "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
427 - },
428 + },
428 428   "cmsv6Parameters": { ~/~/ параметры CMSv6
429 429   "enabled": true, ~/~/ флаг включения
430 430   "id": "" , ~/~/ идентификатор
... ... @@ -431,7 +431,7 @@
431 431   "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 432   "login": "" , ~/~/ имя учетной записи
433 433   "password": "" ~/~/ пароль учетной записи
434 - },
435 + },
435 435   "inspectionTasks": ~/~/ задания на ТО
436 436   {
437 437   "enabled": "" , ~/~/ Признак включения
... ... @@ -469,7 +469,7 @@
469 469   "motohoursEnabled": true,
470 470   "mileage": "",
471 471   "motohours": 345.0
472 - },
473 + },
473 473   "cmsv6Parameters": { ~/~/Параметры CmsV6
474 474   "id": null,
475 475   "enabled": true, ~/~/флаг включения
... ... @@ -476,7 +476,7 @@
476 476   "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
477 477   "login": "", ~/~/ имя учетной записи
478 478   "password": "" ~/~/ пароль учетной записи
479 - },
480 + },
480 480   "inspectionTasks": { ~/~/ задания на ТО
481 481   "id": "", ~/~/ ID задачи
482 482   "enabled": false, ~/~/ Признак включения
... ... @@ -489,7 +489,7 @@
489 489   "periodicCondition": "", ~/~/ Условие периодичности по времени
490 490   "kind": "", ~/~/ Вид периодичности по времени 
491 491   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
492 - }
493 + }
493 493  
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
... ... @@ -520,14 +520,12 @@
520 520  
521 521  (% style="color:#000000" %)В заголовках запроса:
522 522  
523 -(% style="color:#000000" %)− Content-Type: __**application/json**__
524 +(% style="color:#000000" %)− Content-Type: application/json
524 524  
525 525  (% style="color:#000000" %)− X-Auth: Токен авторизации
526 526  
527 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
528 528  
529 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
530 -
531 531  (% class="western" style="color:#000000" %)##{##
532 532  
533 533  (% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
... ... @@ -539,7 +539,7 @@
539 539   "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
540 540  (% style="color:#000000" %)}
541 541  
542 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
543 543  
544 544  (% style="color:#000000" %)Ответ:
545 545  
... ... @@ -562,10 +562,8 @@
562 562   "createdAt": "" ~/~/ дата создания объектов  (%%)
563 563  (% style="color:#000000" %)}
564 564  
565 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
564 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
566 566  
567 -(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
568 -
569 569  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 570  
571 571  
... ... @@ -580,7 +580,7 @@
580 580  
581 581  (% 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}
582 582  
583 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
580 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
584 584  
585 585  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
586 586  
... ... @@ -597,7 +597,7 @@
597 597   "overwrite": false, ~/~/ Флаг перезаписи
598 598   "stage": "", ~/~/ Состояние, может быть null
599 599  
600 -(% style="color:#000000" %)}
597 + (% style="color:#000000" %)}
601 601  
602 602  (% style="color:#000000" %)Ответ:
603 603  
... ... @@ -611,7 +611,7 @@
611 611   "stage": "", ~/~/ Состояние
612 612  
613 613  (% style="text-align:left" %)
614 -(% style="color:#000000" %) }
611 +(% style="color:#000000" %)}
615 615  
616 616  
617 617  (% class="box warningmessage" %)
... ... @@ -629,7 +629,7 @@
629 629  
630 630  (% style="color:#000000" %)Параметры в теле запроса (JSON):
631 631  
632 -(% style="color:#000000" %){    
629 +(% style="color:#000000" %) {
633 633  
634 634  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
635 635   "parentId": "", ~/~/ ID клиента
... ... @@ -670,7 +670,7 @@
670 670   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
671 671   "kind": "", ~/~/ Вид периодичности по времени
672 672   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
673 - } 
670 + }
674 674  
675 675  (% style="color:#000000" %)}
676 676  
... ... @@ -677,7 +677,7 @@
677 677  (% style="color:#000000" %)Ответ:
678 678  
679 679  (% lang="en-US" style="text-align:left" %)
680 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
677 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
681 681  
682 682  (% lang="en-US" style="text-align:left" %)
683 683   "vehicleId": "", ~/~/ ID ТС
... ... @@ -736,7 +736,7 @@
736 736  
737 737  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
738 738  
739 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
736 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
740 740  
741 741  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
742 742  
... ... @@ -762,15 +762,16 @@
762 762  
763 763  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
764 764  
765 -(% style="color:#000000" %)Ответ:
762 +(% style="color:#000000" %)Ответ: [
766 766  
767 -(% style="color:#000000" %){
764 +(% class="western" %)
765 +{{{ {
766 + "deviceTypeId" : "", // ID типа устройства
767 + "deviceTypeName" : "" // Название типа устройства
768 + },}}}
768 768  
769 - "deviceTypeId" : "", ~/~/ ID типа устройства
770 - "deviceTypeName" : "" ~/~/ Название типа устройства
771 -
772 772  (% style="text-align:left" %)
773 -(% style="color:#000000" %)}
771 +(% style="color:#000000" %)…** **]
774 774  
775 775  
776 776  (% class="box" style="text-align: center;" %)
... ... @@ -791,16 +791,19 @@
791 791  
792 792  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
793 793  
794 -(% style="color:#000000" %)Ответ:
792 +(% style="color:#000000" %)Ответ: [
795 795  
796 -(% style="color:#000000" %){
794 +(% class="western" style="margin-bottom:19px" %)
795 +{{{ {}}}
797 797  
798 - "id": "", ~/~/ ID типа датчика 
799 - "name": "", ~/~/ Название
800 - "description": "", ~/~/ Описание
797 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
801 801  
799 +(% class="western" %)
800 +{{{ "description": "" // Описание
801 + },}}}
802 +
802 802  (% style="text-align:left" %)
803 -(% style="color:#000000" %)}
804 +(% style="color:#000000" %)… ]
804 804  
805 805  
806 806  (% class="box" lang="en-US" style="text-align: center;" %)

Меню

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