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

Summary

Details

Icon Page properties
Content
... ... @@ -1,8 +1,13 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
5 +~{~{box cssClass="floatinginfobox" title="~*~*Contents~*~*"}}~{~{toc/}}~{~{/box}}
6 +\\= Level 1
7 +\\Hello
8 +\\== Level 2
9 +
10 +
6 6  (% class="box" style="text-align: center;" %)
7 7  (((
8 8  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -111,6 +111,148 @@
111 111  }
112 112  
113 113  
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 +
114 114  (% class="box" style="text-align: center;" %)
115 115  (((
116 116  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -227,6 +227,54 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
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 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -240,6 +240,8 @@
240 240  
241 241  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 242  
438 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
439 +
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245 245  
... ... @@ -253,9 +253,9 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин (% style="color:#000000" %)(Если null - менять не надо)(%%)
453 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
257 257  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
258 - "email": "" , ~/~/ email  (% style="color:#000000" %)(Если null - менять не надо)(%%)
455 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
259 259  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
569 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -381,6 +381,7 @@
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 383  
582 +)))
384 384  
385 385  (% class="box errormessage" %)
386 386  (((
... ... @@ -429,77 +429,44 @@
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
631 +(((
432 432  {
433 -
434 434   "vehicleId": "", ~/~/ ID объекта
435 -
436 436   "name": "", ~/~/ Имя объекта
437 -
438 438   "imei": "", ~/~/ IMEI объекта
439 -
440 440   "deviceTypeId": , ~/~/ ID типа устройства
441 -
442 442   "deviceTypeName": "", ~/~/ Название типа устройства
443 -
444 444   "sim1": "", ~/~/ Номер SIM1
445 -
446 446   "parentId": "", Номер SIM2
447 -
448 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 -
640 + "parentName": "", Наименование клиента-родителя
450 450   "modelId": "", ID модели объекта
451 -
452 452   "modelName": "", Имя модели объекта
453 -
454 454   "createdAt": "", Дата создания объекта
455 -
456 456   "mileageCalcMethod": "", Выбранный метод расчета пробега
457 -
458 458   "counters": { ~/~/ Нормы
459 -
460 460   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 -
462 462   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 -
464 464   "mileage": "", ~/~/ Пробег по нормам в метрах
465 -
466 466   "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 -
468 468   },
469 -
470 470   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 -
472 472   {
473 -
474 - "id": "", ~/~/ ID  задания
475 -
653 + "id": "", ~/~/ ID  задания
476 476   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 -
478 478   "name": "", ~/~/ Наименование задания
479 -
480 480   "description": "", ~/~/ Описание задания
481 -
482 482   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 -
484 484   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 -
486 486   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 -
488 488   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 -
490 490   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 -
492 492   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 -
494 494   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 -
496 496   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 -
498 498   }
499 -
500 500   ]
501 -
502 502  }
668 +)))
503 503  
504 504  (% style="text-align:left" %)
505 505  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -660,17 +660,17 @@
660 660  
661 661  (% style="color:#000000" %)Параметры в теле запроса (JSON):
662 662  
663 -(% class="western" style="color:#000000" %)##{##
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 +}
664 664  
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 -
674 674  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
675 675  
676 676  (% style="color:#000000" %)Ответ:
... ... @@ -693,7 +693,16 @@
693 693   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 694   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 695   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
862 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
863 + "customFields": [ 
864 + {
865 + "id": "", ~/~/ идентификатор произвольного поля
866 + "name": "", ~/~/ имя произвольного поля
867 + "value": "", ~/~/ значение произвольного поля
868 + "forClient": true, ~/~/ право на отображение у клиента
869 + "forTooltip": false, ~/~/ право на отображение в подсказке
870 + "forReport": false ~/~/ право на отображение в отчетах
871 + }(%%)
697 697  (% style="color:#000000" %)}
698 698  
699 699  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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