Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 76.2 >
edited by Илья Крайнов
on 2023/03/14 14:15
To version < 89.3 >
edited by Илья Крайнов
on 2023/05/22 14:41
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -62,7 +62,7 @@
62 62  (% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -82,7 +82,7 @@
82 82  **GET api/v3/agents/{id}**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
86 86  
87 87  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 88  
... ... @@ -93,9 +93,9 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -
96 +А
97 97  {
98 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 99   "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 100   "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 101   "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
... ... @@ -124,7 +124,7 @@
124 124  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
... ... @@ -161,7 +161,7 @@
161 161  **POST /api/v3/agents **
162 162  )))
163 163  
164 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
165 165  
166 166  Метод запроса: **POST**
167 167  
... ... @@ -224,7 +224,7 @@
224 224  **PUT /api/v3/agents**
225 225  )))
226 226  
227 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
228 228  
229 229  Метод запроса: **PUT**
230 230  
... ... @@ -240,6 +240,7 @@
240 240   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 241   "name": "string", ~/~/ имя
242 242   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
243 243   "isForeign": true, ~/~/ иностранный контрагент
244 244   "district": "string", ~/~/ округ
245 245   "region": "string", ~/~/ регион
... ... @@ -287,7 +287,7 @@
287 287  **DELETE /api/v3/agents/{clientId}**
288 288  )))
289 289  
290 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
291 291  
292 292  Метод запроса: **DELETE**
293 293  
... ... @@ -308,7 +308,7 @@
308 308  (% lang="en-US" %)**POST /api/v3/users**
309 309  )))
310 310  
311 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
312 312  
313 313  (% style="color:#000000" %)Метод запроса: **POST**
314 314  
... ... @@ -318,7 +318,8 @@
318 318  
319 319  (% style="color:#000000" %)Параметры в теле запроса (JSON):
320 320  
321 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
322 322   "lastName": "", ~/~/ фамилия
323 323   "firstName": "", ~/~/ имя
324 324   "position": "", ~/~/ должность
... ... @@ -327,17 +327,41 @@
327 327   "login": "", ~/~/ логин (обязателен)
328 328   "password": "", ~/~/ пароль (обязателен)
329 329   "email": "", ~/~/ email (обязателен)
330 - "description": "", ~/~/ описание
331 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
332 332   "parentId": "", ~/~/ Guid родительского агента
333 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
334 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
335 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
336 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
337 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
338 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
339 339  }
340 340  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
341 341  (% style="text-align:left" %)
342 342  (% style="color:#000000; font-weight:normal" %)Ответ:
343 343  
... ... @@ -410,7 +410,7 @@
410 410   "email": "" , ~/~/ E-mail
411 411   "sessionDuration":"", ~/~/ длительность сессии в минутах
412 412   "status": "1",  ~/~/ статус пользователя
413 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
414 414  
415 415  (% style="color:#000000" %)}
416 416  
... ... @@ -448,8 +448,11 @@
448 448   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
449 449   "description": "", ~/~/ Описание
450 450   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
451 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
452 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
453 453   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
454 454   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
455 455   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -470,7 +470,7 @@
470 470  (% lang="en-US" %)**PUT /api/v3/users**
471 471  )))
472 472  
473 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
474 474  
475 475  (% style="color:#000000" %)Метод запроса: **PUT**
476 476  
... ... @@ -492,7 +492,9 @@
492 492   "phone": "" , ~/~/ телефон
493 493   "organization": "" , ~/~/ организация
494 494   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
495 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
496 496   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
497 497  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
498 498   "isEnabled": "" , ~/~/ признак включения
... ... @@ -499,9 +499,12 @@
499 499   "parentId": "" , ~/~/ Guid родительского агента
500 500   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
501 501   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
502 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
503 - "kind": "" , ~/~/ тип аутентификации
504 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
505 505   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
506 506  
507 507  (% lang="en-US" style="text-align:left" %)
... ... @@ -527,8 +527,12 @@
527 527   "isEnabled": "" , ~/~/ признак включения
528 528   "parentId": "" , ~/~/ Guid родительского агента
529 529   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
530 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
531 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
532 532   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 533   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
534 534  
... ... @@ -542,7 +542,7 @@
542 542  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
543 543  )))
544 544  
545 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
546 546  
547 547  (% style="color:#000000" %)Метод запроса: **PUT**
548 548  
... ... @@ -572,7 +572,7 @@
572 572  **POST /api/v3/users/disable**
573 573  )))
574 574  
575 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
576 576  
577 577  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
578 578  
... ... @@ -594,7 +594,7 @@
594 594  **POST /api/v3/users/enable**
595 595  )))
596 596  
597 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
598 598  
599 599  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
600 600  
... ... @@ -631,7 +631,7 @@
631 631  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
632 632  )))
633 633  
634 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
635 635  
636 636  (% style="color:#000000" %)Метод запроса: **DELETE**
637 637  
... ... @@ -655,7 +655,7 @@
655 655  
656 656  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
657 657  
658 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
659 659  
660 660  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
661 661  
... ... @@ -663,9 +663,9 @@
663 663  
664 664  (% style="color:#000000" %)Метод запроса: **GET**
665 665  
666 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
667 667  
668 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
669 669  
670 670  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
671 671  
... ... @@ -679,18 +679,124 @@
679 679   "deviceTypeId": , ~/~/ ID типа устройства
680 680   "deviceTypeName": "", ~/~/ Название типа устройства
681 681   "sim1": "", ~/~/ Номер SIM1
682 - "parentId": "", Номер SIM2
683 - "parentName": "", Наименование клиента-родителя
684 - "modelId": "", ID модели объекта
685 - "modelName": "", Имя модели объекта
686 - "createdAt": "", Дата создания объекта
687 - "mileageCalcMethod": "", Выбранный метод расчета пробега
688 - "counters": { ~/~/ Нормы
689 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
690 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
691 - "mileage": "", ~/~/ Пробег по нормам в метрах
692 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
720 + "sim2": "", ~/~/ Номер SIM2
721 +
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
693 693   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0,
801 + "gradesTables": [
802 + {
803 + "grades": [
804 + {
805 + "input": 0,
806 + "output": 0
807 + }
808 + ],
809 + "relevanceTime": "2023-05-22T09:57:39.562Z"
810 + }
811 + ],
812 + "showInTooltip": true,
813 + "showLastValid": true,
814 + "showAsDutOnGraph": true,
815 + "showWithoutIgn": true,
816 + "agrFunction": 0,
817 + "expr": "string",
818 + "children": [
819 + "string"
820 + ],
821 + "customParams": {
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 + "summaryMaxValue": 0
827 + }
828 +
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
837 +
694 694   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
695 695   {
696 696   "id": "", ~/~/ ID  задания
... ... @@ -706,7 +706,17 @@
706 706   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
707 707   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
708 708   }
709 - ]
853 + ],
854 +
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
863 +
710 710  }
711 711  )))
712 712  
... ... @@ -723,7 +723,7 @@
723 723  (% lang="en-US" %)**POST /api/v3/vehicles**
724 724  )))
725 725  
726 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
727 727  
728 728  (% style="color:#000000" %)Метод запроса: **POST**
729 729  
... ... @@ -845,7 +845,7 @@
845 845  
846 846  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
847 847  
848 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1002 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
849 849  
850 850  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
851 851  
... ... @@ -925,7 +925,7 @@
925 925  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
926 926  )))
927 927  
928 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1082 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
929 929  
930 930  (% style="color:#000000" %)Метод запроса: **POST**
931 931  
... ... @@ -971,7 +971,7 @@
971 971  (% lang="en-US" %)**PUT /api/v3/vehicles**
972 972  )))
973 973  
974 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1128 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
975 975  
976 976  (% style="color:#000000" %)Метод запроса: **PUT**
977 977  
... ... @@ -1088,7 +1088,7 @@
1088 1088  (% lang="en-US" style="text-align:left" %)
1089 1089  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1090 1090  
1091 -**валидация:**
1245 +**Валидация:**
1092 1092  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1093 1093  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1094 1094  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1100,7 +1100,7 @@
1100 1100  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1101 1101  )))
1102 1102  
1103 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1257 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1104 1104  
1105 1105  (% style="color:#000000" %)Метод запроса: **DELETE**
1106 1106  
... ... @@ -1122,7 +1122,7 @@
1122 1122  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1123 1123  )))
1124 1124  
1125 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1279 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1126 1126  
1127 1127  (% style="color:#000000" %)Метод запроса: **GET**
1128 1128  
... ... @@ -1149,7 +1149,7 @@
1149 1149  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1150 1150  )))
1151 1151  
1152 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1306 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1153 1153  
1154 1154  (% style="color:#000000" %)Метод запроса: **GET**
1155 1155  
... ... @@ -1168,7 +1168,7 @@
1168 1168  (% style="text-align:left" %)
1169 1169  (% style="color:#000000" %)}
1170 1170  
1171 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1325 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1172 1172  
1173 1173  == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1174 1174  
... ... @@ -1178,7 +1178,7 @@
1178 1178  )))
1179 1179  
1180 1180  (% style="text-align: left;" %)
1181 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1335 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1182 1182  
1183 1183  (% style="text-align: left;" %)
1184 1184  Метод запроса **POST**
... ... @@ -1209,7 +1209,255 @@
1209 1209   }
1210 1210  ]
1211 1211  
1366 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1212 1212  
1368 +(% class="box infomessage" %)
1369 +(((
1370 +**POST /api/v3/terminalMessages**
1371 +)))
1372 +
1373 +Метод возвращает список сообщений терминала объекта за выбранный период.
1374 +
1375 +(% style="text-align: left;" %)
1376 +Метод запроса **POST**
1377 +
1378 +(% style="text-align: left;" %)
1379 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1380 +
1381 +(% style="text-align: left;" %)
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1383 +
1384 +{
1385 + "vehicleId": 0, ~/~/ id объекта
1386 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1387 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1388 +}
1389 +
1390 +Ответ:
1391 +
1392 +[
1393 + {
1394 + "messages": [
1395 + {
1396 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1397 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1398 + "speed": 0, ~/~/ Скорость, км/ч
1399 + "altitude": 0, ~/~/ Высота, м
1400 + "latitude": 0, ~/~/ Широта [-90°;90°]
1401 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1402 + "satellites": 0, ~/~/ Кол-во спутников
1403 + "voltage": 0, ~/~/ Напряжение
1404 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1405 + "additionalProp1": "string",
1406 + "additionalProp2": "string",
1407 + "additionalProp3": "string"
1408 + },
1409 + "photoCount": 0 ~/~/ Кол-во фото
1410 + }
1411 + ]
1412 + }
1413 +]
1414 +
1415 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1416 +
1417 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1418 +
1419 +(% class="box infomessage" %)
1420 +(((
1421 +**POST /api/v3/notifications/find**
1422 +)))
1423 +
1424 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1425 +
1426 +(% style="text-align: left;" %)
1427 +Метод запроса **POST**
1428 +
1429 +(% style="text-align: left;" %)
1430 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1431 +
1432 +(% style="text-align: left;" %)
1433 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1434 +
1435 +{
1436 + "parentId": "" ~/~/ id клиента
1437 +}
1438 +
1439 +Ответ:
1440 +
1441 +[
1442 + {
1443 + "id": 0, ~/~/ ID уведомления
1444 + "name": "string", ~/~/ Название уведомления
1445 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1446 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1447 + "userId": "", ~/~/ Пользователь, создавший уведомление
1448 + "parentId": "", ~/~/ Идентификатор клиента
1449 + "parentName": "string" ~/~/ Имя клиента
1450 + }
1451 +]
1452 +
1453 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1454 +
1455 +(% class="box infomessage" %)
1456 +(((
1457 +**GET /api/v3/notifications/{id}**
1458 +)))
1459 +
1460 +Метод возвращает данные правил формирования выбранного уведомления.
1461 +
1462 +(% style="text-align: left;" %)
1463 +Метод запроса **GET**
1464 +
1465 +(% style="text-align: left;" %)
1466 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1467 +
1468 +(% style="text-align: left;" %)
1469 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1470 +
1471 +(% style="text-align: left;" %)
1472 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1473 +
1474 +(% style="text-align: left;" %)
1475 +(% style="color:#000000" %)Ответ:
1476 +
1477 +(% style="text-align: left;" %)
1478 +(% style="color:#000000" %){
1479 + "id": 0, ~/~/ (%%)id уведомления
1480 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1481 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1482 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1483 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1484 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1485 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1486 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1487 +(% style="color:#000000" %) 0
1488 + ],
1489 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1490 +(% style="color:#000000" %) 0
1491 + ],
1492 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1493 +(% style="color:#000000" %) 0
1494 + ],
1495 + "settings": { ~/~/ Список параметров уведомления
1496 + "additionalProp1": "string",
1497 + "additionalProp2": "string",
1498 + "additionalProp3": "string"
1499 + },
1500 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1501 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1502 +(% style="color:#000000" %) ""
1503 + ],
1504 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1505 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1506 +(% style="color:#000000" %) "string"
1507 + ],
1508 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1509 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1510 +(% style="color:#000000" %) {
1511 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1512 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1513 +(% style="color:#000000" %) }
1514 + ],
1515 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1516 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1517 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1518 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1519 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1520 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1521 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1522 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1523 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1524 +(% style="color:#000000" %)}
1525 +
1526 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1527 +
1528 +(% class="box warningmessage" %)
1529 +(((
1530 +**PUT /api/v3/notifications/**
1531 +)))
1532 +
1533 +Метод позволяет отредактировать уведомление.
1534 +
1535 +Метод запроса **PUT**
1536 +
1537 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1538 +
1539 +В заголовках запроса: X-Auth: Токен авторизации
1540 +
1541 +Тело запроса:
1542 +{
1543 + "id": 0, ~/~/ id уведомления
1544 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1545 + "userId": "", ~/~/ Пользователь, создавший уведомление
1546 + "parentId": "", ~/~/ Идентификатор клиента
1547 + "parentName": "string", ~/~/ Имя клиента
1548 + "name": "string", ~/~/ Название уведомления
1549 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1550 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1551 + 0
1552 + ],
1553 + "geoids": [ ~/~/ Список id геообъектов для анализа
1554 + 0
1555 + ],
1556 + "fieldids": [ ~/~/ Список id полей для анализа
1557 + 0
1558 + ],
1559 + "settings": { ~/~/ Список параметров уведомления
1560 + "additionalProp1": "string",
1561 + "additionalProp2": "string",
1562 + "additionalProp3": "string"
1563 + },
1564 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1565 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1566 + ""
1567 + ],
1568 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1569 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1570 + "string"
1571 + ],
1572 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1573 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1574 + {
1575 + "id": 0, ~/~/ Идентификатор участника чата
1576 + "info": "string" ~/~/ Дополнительные сведения
1577 + }
1578 + ],
1579 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1580 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1581 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1582 + "kind": 0, ~/~/ Определяет вид уведомления
1583 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1584 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1585 + "timezone": 0, ~/~/ Сдвиг часового пояса
1586 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1587 + "autoProlongation": true ~/~/ Автопродление срока действия
1588 +}
1589 +
1590 +Ответ:
1591 +
1592 +Success
1593 +
1594 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1595 +
1596 +(% class="box errormessage" %)
1597 +(((
1598 +**DELETE /api/v3/notifications/{id}**
1599 +)))
1600 +
1601 +Метод позволяет удалить выбранное уведомление.
1602 +
1603 +Метод запроса **DELETE**
1604 +
1605 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1606 +
1607 +Передаваемый параметр: {id} - id уведомления
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Ответ:
1612 +
1613 +Success
1614 +
1213 1213  (% class="box" lang="en-US" style="text-align: center;" %)
1214 1214  (((
1215 1215  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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