Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 41.1 >
edited by Илья Крайнов
on 2022/11/18 17:34
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" %)**Раздел Пользователи**
... ... @@ -232,121 +232,47 @@
232 232  (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
382 +(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
239 239  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 240  
388 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
389 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 -{
245 -)))
246 -
247 247  (((
394 +{
248 248   "id": "", ~/~/ GUID пользователя
249 -)))
250 -
251 -(((
252 - "lastName": "", ~/~/ Фамилия
253 -)))
254 -
255 -(((
396 + "lastName": "", ~/~/ Фамилия 
256 256   "firstName": "", ~/~/ Имя
257 -)))
258 -
259 -(((
260 260   "position": "", ~/~/ Должность
261 -)))
262 -
263 -(((
264 264   "phone": "", ~/~/ Номер телефона
265 -)))
266 -
267 -(((
268 268   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 -)))
270 -
271 -(((
272 272   "parentName": "", Наименование клиента, которому принадлежит пользователь
273 -)))
274 -
275 -(((
276 276   "organization": "", ~/~/ Организация
277 -)))
278 -
279 -(((
280 280   "login": "", ~/~/ Логин пользователя
281 -)))
282 -
283 -(((
284 284   "email": "", ~/~/ Адрес электронной почты
285 -)))
286 -
287 -(((
288 288   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 -)))
290 -
291 -(((
292 292   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 -)))
294 -
295 -(((
296 296   "description": "", ~/~/ Описание
297 -)))
298 -
299 -(((
300 300   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 -)))
302 -
303 -(((
304 304   "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 -)))
306 -
307 -(((
308 308   "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 -)))
310 -
311 -(((
312 312   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 -)))
314 -
315 -(((
316 316   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 -)))
318 -
319 -(((
320 320   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 -)))
322 -
323 -(((
324 324   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 -)))
326 -
327 -(((
328 328   "groups": [], ~/~/ Список ролей пользователя
329 -)))
330 -
331 -(((
332 332   "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 -)))
334 -
335 -(((
336 336   "authDevices": [ ], ~/~/ Список авторизованных устройств
337 -)))
338 -
339 -(((
340 340   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 -)))
342 -
343 -(((
344 344   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 -)))
346 -
347 -(((
348 348  }
349 349  )))
422 +)))
350 350  
351 351  
352 352  (% class="box warningmessage" %)
... ... @@ -362,6 +362,8 @@
362 362  
363 363  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
364 364  
438 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
439 +
365 365  (% lang="en-US" style="text-align:left" %)
366 366  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
367 367  
... ... @@ -555,145 +555,40 @@
555 555  
556 556  (((
557 557  {
558 -)))
559 -
560 -(((
561 561   "vehicleId": "", ~/~/ ID объекта
562 -)))
563 -
564 -(((
565 565   "name": "", ~/~/ Имя объекта
566 -)))
567 -
568 -(((
569 569   "imei": "", ~/~/ IMEI объекта
570 -)))
571 -
572 -(((
573 573   "deviceTypeId": , ~/~/ ID типа устройства
574 -)))
575 -
576 -(((
577 577   "deviceTypeName": "", ~/~/ Название типа устройства
578 -)))
579 -
580 -(((
581 581   "sim1": "", ~/~/ Номер SIM1
582 -)))
583 -
584 -(((
585 585   "parentId": "", Номер SIM2
586 -)))
587 -
588 -(((
589 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 -)))
591 -
592 -(((
640 + "parentName": "", Наименование клиента-родителя
593 593   "modelId": "", ID модели объекта
594 -)))
595 -
596 -(((
597 597   "modelName": "", Имя модели объекта
598 -)))
599 -
600 -(((
601 601   "createdAt": "", Дата создания объекта
602 -)))
603 -
604 -(((
605 605   "mileageCalcMethod": "", Выбранный метод расчета пробега
606 -)))
607 -
608 -(((
609 609   "counters": { ~/~/ Нормы
610 -)))
611 -
612 -(((
613 613   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
614 -)))
615 -
616 -(((
617 617   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
618 -)))
619 -
620 -(((
621 621   "mileage": "", ~/~/ Пробег по нормам в метрах
622 -)))
623 -
624 -(((
625 625   "motohours": "" ~/~/ Моточасы по нормам, в секундах
626 -)))
627 -
628 -(((
629 629   },
630 -)))
631 -
632 -(((
633 633   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 -)))
635 -
636 -(((
637 637   {
638 -)))
639 -
640 -(((
641 - "id": "", ~/~/ ID  задания
642 -)))
643 -
644 -(((
653 + "id": "", ~/~/ ID  задания
645 645   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 -)))
647 -
648 -(((
649 649   "name": "", ~/~/ Наименование задания
650 -)))
651 -
652 -(((
653 653   "description": "", ~/~/ Описание задания
654 -)))
655 -
656 -(((
657 657   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 -)))
659 -
660 -(((
661 661   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 -)))
663 -
664 -(((
665 665   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 -)))
667 -
668 -(((
669 669   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 -)))
671 -
672 -(((
673 673   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 -)))
675 -
676 -(((
677 677   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 -)))
679 -
680 -(((
681 681   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
682 -)))
683 -
684 -(((
685 685   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
686 -)))
687 -
688 -(((
689 689   }
690 -)))
691 -
692 -(((
693 693   ]
694 -)))
695 -
696 -(((
697 697  }
698 698  )))
699 699  
... ... @@ -856,17 +856,17 @@
856 856  
857 857  (% style="color:#000000" %)Параметры в теле запроса (JSON):
858 858  
859 -(% 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 +}
860 860  
861 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
862 - "name": null, ~/~/ Имя ТС (string, опционально) 
863 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
864 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
865 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
866 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
867 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
868 -(% style="color:#000000" %)}
869 -
870 870  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
871 871  
872 872  (% style="color:#000000" %)Ответ:
... ... @@ -889,7 +889,16 @@
889 889   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
890 890   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
891 891   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
892 -(% 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 + }(%%)
893 893  (% style="color:#000000" %)}
894 894  
895 895  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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