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

Summary

Details

Icon Page properties
Content
... ... @@ -1,7 +1,6 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  == Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 -== ==
5 5  
6 6  (% class="box" style="text-align: center;" %)
7 7  (((
... ... @@ -111,6 +111,148 @@
111 111  }
112 112  
113 113  
113 +(% class="box successmessage" %)
114 +(((
115 +**Добавление клиента — POST /api/v3/agents**
116 +)))
117 +
118 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
119 +
120 +Метод запроса: **POST**
121 +
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
123 +
124 +В заголовках запроса: X-Auth: Токен авторизации
125 +
126 +Параметры в теле запроса (JSON):
127 +
128 +{
129 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 + "name": "string", ~/~/ имя
131 + "fullName": "string", ~/~/ полное наименование
132 + "isForeign": true, ~/~/ иностранный контрагент
133 + "district": "string", ~/~/ округ
134 + "region": "string", ~/~/ регион
135 + "city": "string", ~/~/ город
136 + "inn": "string", ~/~/ ИНН
137 + "kpp": "string", ~/~/ КПП
138 + "address": "string", ~/~/ юридический адрес
139 + "addressFact": "string", ~/~/ фактический адрес
140 + "email": "string", ~/~/ email
141 + "director": "string", ~/~/ ФИО руководителя
142 + "bankName": "string", ~/~/ банк
143 + "bankBIK": "string", ~/~/ БИК
144 + "bankRS": "string", ~/~/ номер счёта
145 + "bankKS": "string" ~/~/ корр. счёт
146 +}
147 +
148 +
149 +Ответ:
150 +
151 +{
152 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
153 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 + "name": "string", ~/~/ имя
155 + "fullName": "string", ~/~/ полное наименование
156 + "isForeign": true, ~/~/ иностранный контрагент
157 + "district": "string", ~/~/ округ
158 + "region": "string", ~/~/ регион
159 + "city": "string", ~/~/ город
160 + "inn": "string", ~/~/ ИНН
161 + "kpp": "string", ~/~/ КПП
162 + "address": "string", ~/~/ юридический адрес
163 + "addressFact": "string", ~/~/ фактический адрес
164 + "email": "string", ~/~/ email
165 + "director": "string", ~/~/ ФИО руководителя
166 + "bankName": "string", ~/~/ банк
167 + "bankBIK": "string", ~/~/ БИК
168 + "bankRS": "string", ~/~/ номер счёта
169 + "bankKS": "string" ~/~/ корр. счёт
170 +}
171 +
172 +
173 +(% class="box warningmessage" %)
174 +(((
175 +**Редактирование клиента — PUT /api/v3/agents**
176 +)))
177 +
178 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
179 +
180 +Метод запроса: **PUT**
181 +
182 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
183 +
184 +В заголовках запроса: X-Auth: Токен авторизации
185 +
186 +
187 +Параметры в теле запроса (JSON):
188 +
189 +{
190 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
191 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
192 + "name": "string", ~/~/ имя
193 + "fullName": "string", ~/~/ полное наименование
194 + "isForeign": true, ~/~/ иностранный контрагент
195 + "district": "string", ~/~/ округ
196 + "region": "string", ~/~/ регион
197 + "city": "string", ~/~/ город
198 + "inn": "string", ~/~/ ИНН
199 + "kpp": "string", ~/~/ КПП
200 + "address": "string", ~/~/ юридический адрес
201 + "addressFact": "string", ~/~/ фактический адрес
202 + "email": "string", ~/~/ email
203 + "director": "string", ~/~/ ФИО руководителя
204 + "bankName": "string", ~/~/ банк
205 + "bankBIK": "string", ~/~/ БИК
206 + "bankRS": "string", ~/~/ номер счёта
207 + "bankKS": "string" ~/~/ корр. счёт
208 +}
209 +
210 +
211 +Ответ:
212 +
213 +{
214 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
215 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
216 + "name": "string", ~/~/ имя
217 + "fullName": "string", ~/~/ полное наименование
218 + "isForeign": true, ~/~/ иностранный контрагент
219 + "district": "string", ~/~/ округ
220 + "region": "string", ~/~/ регион
221 + "city": "string", ~/~/ город
222 + "inn": "string", ~/~/ ИНН
223 + "kpp": "string", ~/~/ КПП
224 + "address": "string", ~/~/ юридический адрес
225 + "addressFact": "string", ~/~/ фактический адрес
226 + "email": "string", ~/~/ email
227 + "director": "string", ~/~/ ФИО руководителя
228 + "bankName": "string", ~/~/ банк
229 + "bankBIK": "string", ~/~/ БИК
230 + "bankRS": "string", ~/~/ номер счёта
231 + "bankKS": "string" ~/~/ корр. счёт
232 +}
233 +
234 +
235 +(% class="box errormessage" %)
236 +(((
237 +**Удаление клиента — DELETE /api/v3/agents/{clientId}**
238 +)))
239 +
240 +
241 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
242 +
243 +Метод запроса: **DELETE**
244 +
245 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
246 +
247 +Параметр запроса: **{clientId}** - Guid пользователя
248 +
249 +В заголовках запроса: X-Auth: Токен авторизации
250 +
251 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
252 +
253 +
254 +
114 114  (% class="box" style="text-align: center;" %)
115 115  (((
116 116  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
... ... @@ -232,172 +232,44 @@
232 232  (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
376 +(% 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  
382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
383 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 244  (((
245 245  {
246 -)))
247 -)))
248 -
249 -(((
250 -(((
251 251   "id": "", ~/~/ GUID пользователя
252 -)))
253 -)))
254 -
255 -(((
256 -(((
257 - "lastName": "", ~/~/ Фамилия
258 -)))
259 -)))
260 -
261 -(((
262 -(((
390 + "lastName": "", ~/~/ Фамилия 
263 263   "firstName": "", ~/~/ Имя
264 -)))
265 -)))
266 -
267 -(((
268 -(((
269 269   "position": "", ~/~/ Должность
270 -)))
271 -)))
272 -
273 -(((
274 -(((
275 275   "phone": "", ~/~/ Номер телефона
276 -)))
277 -)))
278 -
279 -(((
280 -(((
281 281   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
282 -)))
283 -)))
284 -
285 -(((
286 -(((
287 287   "parentName": "", Наименование клиента, которому принадлежит пользователь
288 -)))
289 -)))
290 -
291 -(((
292 -(((
293 293   "organization": "", ~/~/ Организация
294 -)))
295 -)))
296 -
297 -(((
298 -(((
299 299   "login": "", ~/~/ Логин пользователя
300 -)))
301 -)))
302 -
303 -(((
304 -(((
305 305   "email": "", ~/~/ Адрес электронной почты
306 -)))
307 -)))
308 -
309 -(((
310 -(((
311 311   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
312 -)))
313 -)))
314 -
315 -(((
316 -(((
317 317   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
318 -)))
319 -)))
320 -
321 -(((
322 -(((
323 323   "description": "", ~/~/ Описание
324 -)))
325 -)))
326 -
327 -(((
328 -(((
329 329   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
330 -)))
331 -)))
332 -
333 -(((
334 -(((
335 335   "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
336 -)))
337 -)))
338 -
339 -(((
340 -(((
341 341   "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
342 -)))
343 -)))
344 -
345 -(((
346 -(((
347 347   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
348 -)))
349 -)))
350 -
351 -(((
352 -(((
353 353   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
354 -)))
355 -)))
356 -
357 -(((
358 -(((
359 359   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
360 -)))
361 -)))
362 -
363 -(((
364 -(((
365 365   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
366 -)))
367 -)))
368 -
369 -(((
370 -(((
371 371   "groups": [], ~/~/ Список ролей пользователя
372 -)))
373 -)))
374 -
375 -(((
376 -(((
377 377   "customGroups": [], ~/~/ Список клиентских ролей пользователя
378 -)))
379 -)))
380 -
381 -(((
382 -(((
383 383   "authDevices": [ ], ~/~/ Список авторизованных устройств
384 -)))
385 -)))
386 -
387 -(((
388 -(((
389 389   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
390 -)))
391 -)))
392 -
393 -(((
394 -(((
395 395   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
396 -)))
397 -)))
398 -
399 -(((
400 -(((
401 401  }
402 402  )))
403 403  )))
... ... @@ -416,6 +416,8 @@
416 416  
417 417  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
418 418  
432 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
433 +
419 419  (% lang="en-US" style="text-align:left" %)
420 420  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
421 421  
... ... @@ -609,145 +609,40 @@
609 609  
610 610  (((
611 611  {
612 -)))
613 -
614 -(((
615 615   "vehicleId": "", ~/~/ ID объекта
616 -)))
617 -
618 -(((
619 619   "name": "", ~/~/ Имя объекта
620 -)))
621 -
622 -(((
623 623   "imei": "", ~/~/ IMEI объекта
624 -)))
625 -
626 -(((
627 627   "deviceTypeId": , ~/~/ ID типа устройства
628 -)))
629 -
630 -(((
631 631   "deviceTypeName": "", ~/~/ Название типа устройства
632 -)))
633 -
634 -(((
635 635   "sim1": "", ~/~/ Номер SIM1
636 -)))
637 -
638 -(((
639 639   "parentId": "", Номер SIM2
640 -)))
641 -
642 -(((
643 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
644 -)))
645 -
646 -(((
634 + "parentName": "", Наименование клиента-родителя
647 647   "modelId": "", ID модели объекта
648 -)))
649 -
650 -(((
651 651   "modelName": "", Имя модели объекта
652 -)))
653 -
654 -(((
655 655   "createdAt": "", Дата создания объекта
656 -)))
657 -
658 -(((
659 659   "mileageCalcMethod": "", Выбранный метод расчета пробега
660 -)))
661 -
662 -(((
663 663   "counters": { ~/~/ Нормы
664 -)))
665 -
666 -(((
667 667   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
668 -)))
669 -
670 -(((
671 671   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
672 -)))
673 -
674 -(((
675 675   "mileage": "", ~/~/ Пробег по нормам в метрах
676 -)))
677 -
678 -(((
679 679   "motohours": "" ~/~/ Моточасы по нормам, в секундах
680 -)))
681 -
682 -(((
683 683   },
684 -)))
685 -
686 -(((
687 687   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
688 -)))
689 -
690 -(((
691 691   {
692 -)))
693 -
694 -(((
695 - "id": "", ~/~/ ID  задания
696 -)))
697 -
698 -(((
647 + "id": "", ~/~/ ID  задания
699 699   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
700 -)))
701 -
702 -(((
703 703   "name": "", ~/~/ Наименование задания
704 -)))
705 -
706 -(((
707 707   "description": "", ~/~/ Описание задания
708 -)))
709 -
710 -(((
711 711   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
712 -)))
713 -
714 -(((
715 715   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
716 -)))
717 -
718 -(((
719 719   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
720 -)))
721 -
722 -(((
723 723   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
724 -)))
725 -
726 -(((
727 727   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
728 -)))
729 -
730 -(((
731 731   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
732 -)))
733 -
734 -(((
735 735   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
736 -)))
737 -
738 -(((
739 739   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
740 -)))
741 -
742 -(((
743 743   }
744 -)))
745 -
746 -(((
747 747   ]
748 -)))
749 -
750 -(((
751 751  }
752 752  )))
753 753  
... ... @@ -910,17 +910,17 @@
910 910  
911 911  (% style="color:#000000" %)Параметры в теле запроса (JSON):
912 912  
913 -(% class="western" style="color:#000000" %)##{##
823 +{
824 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
825 + "name": null, ~/~/ Имя ТС (string, опционально)
826 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
827 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
828 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
829 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
830 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
831 + "customFields": null ~/~/ значение любого из произвольных полей ТС
832 +}
914 914  
915 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
916 - "name": null, ~/~/ Имя ТС (string, опционально) 
917 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
918 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
919 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
920 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
921 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
922 -(% style="color:#000000" %)}
923 -
924 924  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
925 925  
926 926  (% style="color:#000000" %)Ответ:
... ... @@ -943,7 +943,16 @@
943 943   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
944 944   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
945 945   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
946 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
856 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
857 + "customFields": [ 
858 + {
859 + "id": "", ~/~/ идентификатор произвольного поля
860 + "name": "", ~/~/ имя произвольного поля
861 + "value": "", ~/~/ значение произвольного поля
862 + "forClient": true, ~/~/ право на отображение у клиента
863 + "forTooltip": false, ~/~/ право на отображение в подсказке
864 + "forReport": false ~/~/ право на отображение в отчетах
865 + }(%%)
947 947  (% style="color:#000000" %)}
948 948  
949 949  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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