Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -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" %)**Ответ:** ... ... @@ -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" %)**Раздел Пользователи** ... ... @@ -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 - для текущего агента ... ... @@ -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 ... ... @@ -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 ... ... @@ -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