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

Summary

Details

Icon Page properties
Content
... ... @@ -1,13 +1,8 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 +== ==
4 4  
5 -~{~{box cssClass="floatinginfobox" title="~*~*Contents~*~*"}}~{~{toc/}}~{~{/box}}
6 -\\= Level 1
7 -\\Hello
8 -\\== Level 2
9 -
10 -
11 11  (% class="box" style="text-align: center;" %)
12 12  (((
13 13  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -116,148 +116,6 @@
116 116  }
117 117  
118 118  
119 -(% class="box successmessage" %)
120 -(((
121 -**Добавление клиента — POST /api/v3/agents **
122 -)))
123 -
124 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
125 -
126 -Метод запроса: **POST**
127 -
128 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
129 -
130 -В заголовках запроса: X-Auth: Токен авторизации
131 -
132 -Параметры в теле запроса (JSON):
133 -
134 -{
135 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 - "name": "string", ~/~/ имя
137 - "fullName": "string", ~/~/ полное наименование
138 - "isForeign": true, ~/~/ иностранный контрагент
139 - "district": "string", ~/~/ округ
140 - "region": "string", ~/~/ регион
141 - "city": "string", ~/~/ город
142 - "inn": "string", ~/~/ ИНН
143 - "kpp": "string", ~/~/ КПП
144 - "address": "string", ~/~/ юридический адрес
145 - "addressFact": "string", ~/~/ фактический адрес
146 - "email": "string", ~/~/ email
147 - "director": "string", ~/~/ ФИО руководителя
148 - "bankName": "string", ~/~/ банк
149 - "bankBIK": "string", ~/~/ БИК
150 - "bankRS": "string", ~/~/ номер счёта
151 - "bankKS": "string" ~/~/ корр. счёт
152 -}
153 -
154 -
155 -Ответ:
156 -
157 -{
158 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
159 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 - "name": "string", ~/~/ имя
161 - "fullName": "string", ~/~/ полное наименование
162 - "isForeign": true, ~/~/ иностранный контрагент
163 - "district": "string", ~/~/ округ
164 - "region": "string", ~/~/ регион
165 - "city": "string", ~/~/ город
166 - "inn": "string", ~/~/ ИНН
167 - "kpp": "string", ~/~/ КПП
168 - "address": "string", ~/~/ юридический адрес
169 - "addressFact": "string", ~/~/ фактический адрес
170 - "email": "string", ~/~/ email
171 - "director": "string", ~/~/ ФИО руководителя
172 - "bankName": "string", ~/~/ банк
173 - "bankBIK": "string", ~/~/ БИК
174 - "bankRS": "string", ~/~/ номер счёта
175 - "bankKS": "string" ~/~/ корр. счёт
176 -}
177 -
178 -
179 -(% class="box warningmessage" %)
180 -(((
181 -**Редактирование клиента — PUT /api/v3/agents**
182 -)))
183 -
184 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
185 -
186 -Метод запроса: **PUT**
187 -
188 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
189 -
190 -В заголовках запроса: X-Auth: Токен авторизации
191 -
192 -
193 -Параметры в теле запроса (JSON):
194 -
195 -{
196 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
197 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
198 - "name": "string", ~/~/ имя
199 - "fullName": "string", ~/~/ полное наименование
200 - "isForeign": true, ~/~/ иностранный контрагент
201 - "district": "string", ~/~/ округ
202 - "region": "string", ~/~/ регион
203 - "city": "string", ~/~/ город
204 - "inn": "string", ~/~/ ИНН
205 - "kpp": "string", ~/~/ КПП
206 - "address": "string", ~/~/ юридический адрес
207 - "addressFact": "string", ~/~/ фактический адрес
208 - "email": "string", ~/~/ email
209 - "director": "string", ~/~/ ФИО руководителя
210 - "bankName": "string", ~/~/ банк
211 - "bankBIK": "string", ~/~/ БИК
212 - "bankRS": "string", ~/~/ номер счёта
213 - "bankKS": "string" ~/~/ корр. счёт
214 -}
215 -
216 -
217 -Ответ:
218 -
219 -{
220 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
221 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
222 - "name": "string", ~/~/ имя
223 - "fullName": "string", ~/~/ полное наименование
224 - "isForeign": true, ~/~/ иностранный контрагент
225 - "district": "string", ~/~/ округ
226 - "region": "string", ~/~/ регион
227 - "city": "string", ~/~/ город
228 - "inn": "string", ~/~/ ИНН
229 - "kpp": "string", ~/~/ КПП
230 - "address": "string", ~/~/ юридический адрес
231 - "addressFact": "string", ~/~/ фактический адрес
232 - "email": "string", ~/~/ email
233 - "director": "string", ~/~/ ФИО руководителя
234 - "bankName": "string", ~/~/ банк
235 - "bankBIK": "string", ~/~/ БИК
236 - "bankRS": "string", ~/~/ номер счёта
237 - "bankKS": "string" ~/~/ корр. счёт
238 -}
239 -
240 -
241 -(% class="box errormessage" %)
242 -(((
243 -**Удаление клиента — DELETE /api/v3/agents/{clientId}**
244 -)))
245 -
246 -
247 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
248 -
249 -Метод запроса: **DELETE**
250 -
251 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
252 -
253 -Параметр запроса: **{clientId}** - Guid пользователя
254 -
255 -В заголовках запроса: X-Auth: Токен авторизации
256 -
257 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
258 -
259 -
260 -
261 261  (% class="box" style="text-align: center;" %)
262 262  (((
263 263  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -284,9 +284,9 @@
284 284   "position": "", ~/~/ должность
285 285   "phone": "", ~/~/ телефон
286 286   "organization": "", ~/~/ организация
287 - "login": "", ~/~/ логин (обязателен)
288 - "password": "", ~/~/ пароль (обязателен)
289 - "email": "", ~/~/ email (обязателен)
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
290 290   "description": "", ~/~/ описание
291 291   "isEnabled": "", ~/~/ признак включения
292 292   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -295,7 +295,7 @@
295 295   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
296 296   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
297 297   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
298 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
151 + "groups": "" , ~/~/ группы пользователя, названия групп
299 299  }
300 300  
301 301  (% style="text-align:left" %)
... ... @@ -321,7 +321,7 @@
321 321   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
322 322   "kind": "" , ~/~/ тип аутентификации
323 323   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
324 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
325 325  
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -374,54 +374,6 @@
374 374  (% style="color:#000000" %)}
375 375  
376 376  
377 -(% class="box successmessage" %)
378 -(((
379 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 -)))
381 -
382 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
383 -
384 -(% style="color:#000000" %)Метод запроса: **GET**
385 -
386 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
387 -
388 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
389 -
390 -(% style="color:#000000" %)Ответ:
391 -
392 -(((
393 -(((
394 -{
395 - "id": "", ~/~/ GUID пользователя
396 - "lastName": "", ~/~/ Фамилия 
397 - "firstName": "", ~/~/ Имя
398 - "position": "", ~/~/ Должность
399 - "phone": "", ~/~/ Номер телефона
400 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
401 - "parentName": "", Наименование клиента, которому принадлежит пользователь
402 - "organization": "", ~/~/ Организация
403 - "login": "", ~/~/ Логин пользователя
404 - "email": "", ~/~/ Адрес электронной почты
405 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
406 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
407 - "description": "", ~/~/ Описание
408 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
411 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
412 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
413 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
414 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
415 - "groups": [], ~/~/ Список ролей пользователя
416 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
417 - "authDevices": [ ], ~/~/ Список авторизованных устройств
418 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
419 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
420 -}
421 -)))
422 -)))
423 -
424 -
425 425  (% class="box warningmessage" %)
426 426  (((
427 427  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -435,8 +435,6 @@
435 435  
436 436  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
437 437  
438 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
439 -
440 440  (% lang="en-US" style="text-align:left" %)
441 441  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
442 442  
... ... @@ -450,10 +450,10 @@
450 450   "position": "" , ~/~/ должность
451 451   "phone": "" , ~/~/ телефон
452 452   "organization": "" , ~/~/ организация
453 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
454 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
455 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
456 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
457 457   "isEnabled": "" , ~/~/ признак включения
458 458   "parentId": "" , ~/~/ Guid родительского агента
459 459   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -566,7 +566,6 @@
566 566  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
567 567  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
568 568  
569 -(((
570 570  В теле ответа:
571 571  {
572 572   "errorMessages": [
... ... @@ -579,7 +579,6 @@
579 579  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
580 580  "users" - массив id пользователей, которых не удалось включить или отключить.
581 581  
582 -)))
583 583  
584 584  (% class="box errormessage" %)
585 585  (((
... ... @@ -628,44 +628,75 @@
628 628  
629 629  (% style="color:#000000" %)Ответ:
630 630  
631 -(((
632 632  {
633 - "vehicleId": "", ~/~/ ID объекта
634 - "name": "", ~/~/ Имя объекта
635 - "imei": "", ~/~/ IMEI объекта
636 - "deviceTypeId": , ~/~/ ID типа устройства
637 - "deviceTypeName": "", ~/~/ Название типа устройства
638 - "sim1": "", ~/~/ Номер SIM1
639 - "parentId": "", Номер SIM2
640 - "parentName": "", Наименование клиента-родителя
641 - "modelId": "", ID модели объекта
642 - "modelName": "", Имя модели объекта
643 - "createdAt": "", Дата создания объекта
644 - "mileageCalcMethod": "", Выбранный метод расчета пробега
645 - "counters": { ~/~/ Нормы
646 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
647 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
648 - "mileage": "", ~/~/ Пробег по нормам в метрах
649 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
433 +
434 + "vehicleId": ,
435 +
436 + "name": "",
437 +
438 + "imei": "",
439 +
440 + "deviceTypeId": ,
441 +
442 + "deviceTypeName": "",
443 +
444 + "sim1": "",
445 +
446 + "parentId": "",
447 +
448 + "parentName": "",
449 +
450 + "modelId": "",
451 +
452 + "modelName": "",
453 +
454 + "createdAt": "",
455 +
456 + "mileageCalcMethod": "",
457 +
458 + "counters": {
459 +
460 + "mileageEnabled": ,
461 +
462 + "motohoursEnabled": ,
463 +
464 + "mileage": 22438858.137653351, ~/~/ пробег по нормам в метрах
465 +
466 + "motohours": 54545302.0 ~/~/ моточасы по нормам, в секундах
467 +
650 650   },
651 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
469 +
470 + "inspectionTasks": [
471 +
652 652   {
653 - "id": "", ~/~/ ID  задания
654 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
655 - "name": "", ~/~/ Наименование задания
656 - "description": "", ~/~/ Описание задания
657 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
659 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
660 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
661 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
662 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
663 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
664 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
473 +
474 + "id": "",
475 +
476 + "enabled": ,
477 +
478 + "name": "",
479 +
480 + "description": "",
481 +
482 + "mileageCondition": ,
483 +
484 + "lastMileage": ,
485 +
486 + "motohoursCondition": ,
487 +
488 + "lastMotohours": ,
489 +
490 + "periodicCondition": ,
491 +
492 + "kind": "",
493 +
494 + "lastInspectionDate": ""
495 +
665 665   }
497 +
666 666   ]
499 +
667 667  }
668 -)))
669 669  
670 670  (% style="text-align:left" %)
671 671  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -826,17 +826,17 @@
826 826  
827 827  (% style="color:#000000" %)Параметры в теле запроса (JSON):
828 828  
829 -{
830 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
831 - "name": null, ~/~/ Имя ТС (string, опционально)
832 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
833 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
834 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
835 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
836 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
837 - "customFields": null ~/~/ значение любого из произвольных полей ТС
838 -}
661 +(% class="western" style="color:#000000" %)##{##
839 839  
663 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
664 + "name": null, ~/~/ Имя ТС (string, опционально) 
665 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
666 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
667 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
668 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
669 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
670 +(% style="color:#000000" %)}
671 +
840 840  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
841 841  
842 842  (% style="color:#000000" %)Ответ:
... ... @@ -859,16 +859,7 @@
859 859   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
860 860   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
861 861   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
862 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
863 - "customFields": [ 
864 - {
865 - "id": "", ~/~/ идентификатор произвольного поля
866 - "name": "", ~/~/ имя произвольного поля
867 - "value": "", ~/~/ значение произвольного поля
868 - "forClient": true, ~/~/ право на отображение у клиента
869 - "forTooltip": false, ~/~/ право на отображение в подсказке
870 - "forReport": false ~/~/ право на отображение в отчетах
871 - }(%%)
694 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
872 872  (% style="color:#000000" %)}
873 873  
874 874  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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