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

Summary

Details

Icon Page properties
Content
... ... @@ -1,8 +1,11 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
5 +{{toc/}}
6 +
7 +
8 +
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  
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 +
114 114  (% class="box" style="text-align: center;" %)
115 115  (((
116 116  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
285 + "login": "", ~/~/ логин (обязателен)
286 + "password": "", ~/~/ пароль (обязателен)
287 + "email": "", ~/~/ email (обязателен)
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
296 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
322 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -227,6 +227,54 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
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 +
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  
436 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
437 +
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245 245  
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
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": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -369,6 +369,7 @@
369 369  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 370  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371 371  
567 +(((
372 372  В теле ответа:
373 373  {
374 374   "errorMessages": [
... ... @@ -381,6 +381,7 @@
381 381  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 382  "users" - массив id пользователей, которых не удалось включить или отключить.
383 383  
580 +)))
384 384  
385 385  (% class="box errormessage" %)
386 386  (((
... ... @@ -429,22 +429,44 @@
429 429  
430 430  (% style="color:#000000" %)Ответ:
431 431  
432 -(% style="color:#000000" %){
433 -
434 - "vehicleId": "" , ~/~/ идентификатор объекта
435 - "name": "" , ~/~/ имя объекта
436 - "imei": "" , ~/~/ IMEI объекта
437 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
438 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
439 - "parentId": "" , ~/~/ идентификатор клиента-родителя
440 - "parentName": "" , ~/~/ наименование клиента-родителя,
441 - "modelId": "" , ~/~/ идентификатор модели объекта
442 - "modelName": "" , ~/~/ наименование модели объекта,
443 - "unitId": "" , ~/~/ идентификатор подразделения
444 - "unitName": "" , ~/~/ наименование подразделения
445 - "status": "" , ~/~/ статус объекта
446 -
629 +(((
630 +{
631 + "vehicleId": "", ~/~/ ID объекта
632 + "name": "", ~/~/ Имя объекта
633 + "imei": "", ~/~/ IMEI объекта
634 + "deviceTypeId": , ~/~/ ID типа устройства
635 + "deviceTypeName": "", ~/~/ Название типа устройства
636 + "sim1": "", ~/~/ Номер SIM1
637 + "parentId": "", Номер SIM2
638 + "parentName": "", Наименование клиента-родителя
639 + "modelId": "", ID модели объекта
640 + "modelName": "", Имя модели объекта
641 + "createdAt": "", Дата создания объекта
642 + "mileageCalcMethod": "", Выбранный метод расчета пробега
643 + "counters": { ~/~/ Нормы
644 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
645 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
646 + "mileage": "", ~/~/ Пробег по нормам в метрах
647 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
648 + },
649 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
650 + {
651 + "id": "", ~/~/ ID  задания
652 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
653 + "name": "", ~/~/ Наименование задания
654 + "description": "", ~/~/ Описание задания
655 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
656 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
657 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
658 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
659 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
660 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
661 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
662 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
663 + }
664 + ]
447 447  }
666 +)))
448 448  
449 449  (% style="text-align:left" %)
450 450  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -605,17 +605,17 @@
605 605  
606 606  (% style="color:#000000" %)Параметры в теле запроса (JSON):
607 607  
608 -(% class="western" style="color:#000000" %)##{##
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 +}
609 609  
610 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
611 - "name": null, ~/~/ Имя ТС (string, опционально) 
612 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
613 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
614 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
615 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
616 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
617 -(% style="color:#000000" %)}
618 -
619 619  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
620 620  
621 621  (% style="color:#000000" %)Ответ:
... ... @@ -638,7 +638,16 @@
638 638   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
639 639   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
640 640   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
641 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
860 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
861 + "customFields": [ 
862 + {
863 + "id": "", ~/~/ идентификатор произвольного поля
864 + "name": "", ~/~/ имя произвольного поля
865 + "value": "", ~/~/ значение произвольного поля
866 + "forClient": true, ~/~/ право на отображение у клиента
867 + "forTooltip": false, ~/~/ право на отображение в подсказке
868 + "forReport": false ~/~/ право на отображение в отчетах
869 + }(%%)
642 642  (% style="color:#000000" %)}
643 643  
644 644  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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