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

Summary

Details

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

Меню

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