Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 91.2 >
edited by Илья Крайнов
on 2023/05/22 15:36
To version < 80.1 >
edited by Илья Крайнов
on 2023/03/29 12:23
>
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" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
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" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
86 86  
87 87  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 88  
... ... @@ -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" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
... ... @@ -161,7 +161,7 @@
161 161  **POST /api/v3/agents **
162 162  )))
163 163  
164 -Метод позволяет добавить клиента, указанного в запросе.
164 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
165 165  
166 166  Метод запроса: **POST**
167 167  
... ... @@ -224,7 +224,7 @@
224 224  **PUT /api/v3/agents**
225 225  )))
226 226  
227 -Метод позволяет отредактировать клиента, указанного в запросе.
227 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
228 228  
229 229  Метод запроса: **PUT**
230 230  
... ... @@ -288,7 +288,7 @@
288 288  **DELETE /api/v3/agents/{clientId}**
289 289  )))
290 290  
291 -Метод позволяет удалить клиента, указанного в строке запроса.
291 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
292 292  
293 293  Метод запроса: **DELETE**
294 294  
... ... @@ -309,7 +309,7 @@
309 309  (% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -436,7 +436,7 @@
436 436   "email": "" , ~/~/ E-mail
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 - "lastLogged": "", ~/~/ дата/время последней авторизации
439 + "astLogged": "", ~/~/ дата/время последней авторизации
440 440  
441 441  (% style="color:#000000" %)}
442 442  
... ... @@ -499,7 +499,7 @@
499 499  (% lang="en-US" %)**PUT /api/v3/users**
500 500  )))
501 501  
502 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
503 503  
504 504  (% style="color:#000000" %)Метод запроса: **PUT**
505 505  
... ... @@ -580,7 +580,7 @@
580 580  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
581 581  )))
582 582  
583 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
584 584  
585 585  (% style="color:#000000" %)Метод запроса: **PUT**
586 586  
... ... @@ -610,7 +610,7 @@
610 610  **POST /api/v3/users/disable**
611 611  )))
612 612  
613 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
613 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
614 614  
615 615  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
616 616  
... ... @@ -632,7 +632,7 @@
632 632  **POST /api/v3/users/enable**
633 633  )))
634 634  
635 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
635 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
636 636  
637 637  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
638 638  
... ... @@ -669,7 +669,7 @@
669 669  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
670 670  )))
671 671  
672 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
673 673  
674 674  (% style="color:#000000" %)Метод запроса: **DELETE**
675 675  
... ... @@ -693,7 +693,7 @@
693 693  
694 694  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
695 695  
696 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
697 697  
698 698  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
699 699  
... ... @@ -701,9 +701,9 @@
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
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}
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>
705 705  
706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
... ... @@ -717,124 +717,20 @@
717 717   "deviceTypeId": , ~/~/ ID типа устройства
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
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": "", ~/~/ Дата создания объекта
720 + "parentId": "", Номер SIM2
721 + "parentName": "", Наименование клиента-родителя
722 + "modelId": "", ID модели объекта
723 + "modelName": "", Имя модели объекта
724 + "createdAt": "", Дата создания объекта
725 + "mileageCalcMethod": "", Выбранный метод расчета пробега
726 + "counters": { ~/~/ Нормы
727 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 + "mileage": "", ~/~/ Пробег по нормам в метрах
730 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
732 732   },
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 -
838 838   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
839 839   {
840 840   "id": "", ~/~/ ID  задания
... ... @@ -850,17 +850,7 @@
850 850   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
851 851   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
852 852   }
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 -
749 + ]
864 864  }
865 865  )))
866 866  
... ... @@ -877,7 +877,7 @@
877 877  (% lang="en-US" %)**POST /api/v3/vehicles**
878 878  )))
879 879  
880 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
881 881  
882 882  (% style="color:#000000" %)Метод запроса: **POST**
883 883  
... ... @@ -909,11 +909,6 @@
909 909   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
910 910   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
911 911   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 -
913 - "mileageCalcMethod": 0,
914 - "mileageCoeff": 0,
915 - "locationByCellId": true,
916 - "dottedLineTrackWhenNoCoords": true,
917 917   "counters": ~/~/ счетчики
918 918   {
919 919   "mileage": "" , ~/~/ пробег
... ... @@ -943,72 +943,7 @@
943 943   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
944 944   }
945 945  
946 -"drivers": [ ~/~/ Водители
947 - {
948 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 - "isDefault": true
950 - }
951 - ],
952 - "commandTemplates": [ ~/~/ Шаблон команды
953 - {
954 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 - "name": "string",
956 - "command": "string",
957 - "retries": 0
958 - }
959 - ],
960 - "sensors": [ ~/~/ Датчики
961 - {
962 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 - "kind": 0,
964 - "type": 0,
965 - "name": "string",
966 - "inputType": 0,
967 - "inputNumber": 0,
968 - "pseudonym": "string",
969 - "medianDegree": 0,
970 - "isInverted": true,
971 - "disabled": true,
972 - "gradeType": 0,
973 - "gradesTables": [
974 - {
975 - "grades": [
976 - {
977 - "input": 0,
978 - "output": 0
979 - }
980 - ],
981 - "relevanceTime": "2023-05-22T12:19:59.728Z"
982 - }
983 - ],
984 - "showInTooltip": true,
985 - "showLastValid": true,
986 - "showAsDutOnGraph": true,
987 - "showWithoutIgn": true,
988 - "agrFunction": 0,
989 - "expr": "string",
990 - "children": [
991 - "string"
992 - ],
993 - "customParams": {
994 - "additionalProp1": "string",
995 - "additionalProp2": "string",
996 - "additionalProp3": "string"
997 - },
998 - "summaryMaxValue": 0
999 - }
1000 - ],
1001 - "customFields": [ ~/~/ Произвольные поля
1002 - {
1003 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 - "name": "string",
1005 - "value": "string",
1006 - "forClient": true,
1007 - "forTooltip": true,
1008 - "forReport": true
1009 - }
1010 - ]
1011 -}
827 +(% style="color:#000000" %) }
1012 1012  
1013 1013  (% style="color:#000000" %)Ответ:
1014 1014  
... ... @@ -1069,7 +1069,7 @@
1069 1069  
1070 1070  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1071 1071  
1072 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1073 1073  
1074 1074  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1075 1075  
... ... @@ -1149,7 +1149,7 @@
1149 1149  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1150 1150  )))
1151 1151  
1152 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1153 1153  
1154 1154  (% style="color:#000000" %)Метод запроса: **POST**
1155 1155  
... ... @@ -1195,7 +1195,7 @@
1195 1195  (% lang="en-US" %)**PUT /api/v3/vehicles**
1196 1196  )))
1197 1197  
1198 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1199 1199  
1200 1200  (% style="color:#000000" %)Метод запроса: **PUT**
1201 1201  
... ... @@ -1205,16 +1205,18 @@
1205 1205  
1206 1206  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1207 1207  
1208 -(% style="color:#000000" %){
1024 +(% style="color:#000000" %){    
1209 1209  
1210 - "parentId": "" , ~/~/ ID клиента
1211 - "name": "" , ~/~/ имя ТС
1212 - "imei": "" , ~/~/ IMEI
1213 - "deviceTypeId": "" , ~/~/ ID типа устройства
1214 - "modelId": "" , ~/~/ ID модели
1215 - "unitId": "" , ~/~/ ID подразделения
1216 - "sim1": "" , ~/~/ Номер SIM 1
1217 - "sim2": "" , ~/~/ Номер SIM2
1026 +(((
1027 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1028 + "parentId": "", ~/~/ ID клиента
1029 + "name": "", ~/~/ имя ТС
1030 + "imei": "", ~/~/ IMEI
1031 + "deviceTypeId": "", ~/~/ ID типа устройства
1032 + "modelId": "", ~/~/ , ID модели    
1033 + "unitId": "", ~/~/ подразделения
1034 + "sim1": "", ~/~/ SIM 1
1035 + "sim2": "", ~/~/ SIM2     (%%)
1218 1218   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1219 1219   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1220 1220   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -1227,107 +1227,39 @@
1227 1227   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1228 1228   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1229 1229   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1048 +(% style="color:#000000" %) "counters": 
1049 + {
1050 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1051 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1052 + "mileage": "", ~/~/ пробег, в метрах 
1053 + "motohours": "" ~/~/ моточасы, в секундах
1054 + }
1055 + "cmsv6Parameters": ~/~/ параметры CMSv6
1056 + {       
1057 + "id": "", ~/~/ идентификатор
1058 + "enabled": true, ~/~/ флаг включения
1059 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1060 + "login": "", ~/~/ имя учетной записи
1061 + "password": "", ~/~/ пароль учетной записи
1062 + }
1063 + "inspectionTasks": ~/~/ задания на ТО
1064 + {
1065 + "id": "", ~/~/ ID задания
1066 + "enabled": false, ~/~/ Признак включения
1067 + "name": "", ~/~/ Имя задания
1068 + "description": "", ~/~/ Описание задания
1069 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1070 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1071 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1072 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1073 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1074 + "kind": "", ~/~/ Вид периодичности по времени
1075 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1076 + } 
1077 +)))
1230 1230  
1231 - "mileageCalcMethod": 0,
1232 - "mileageCoeff": 0,
1233 - "locationByCellId": true,
1234 - "dottedLineTrackWhenNoCoords": true,
1235 - "counters": ~/~/ счетчики
1236 - {
1237 - "mileage": "" , ~/~/ пробег
1238 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1239 - "motohours": "" , ~/~/ моточасы
1240 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1241 - },
1242 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1243 - "enabled": true, ~/~/ флаг включения
1244 - "id": "" , ~/~/ идентификатор
1245 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1246 - "login": "" , ~/~/ имя учетной записи
1247 - "password": "" ~/~/ пароль учетной записи
1248 - },
1249 - "inspectionTasks": ~/~/ задания на ТО
1250 - {
1251 - "enabled": "" , ~/~/ Признак включения
1252 - "name": "" , ~/~/ Имя задания
1253 - "description": "" , ~/~/ Описание задания
1254 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1255 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1256 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1257 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1258 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1259 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1260 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1261 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1262 - }
1079 +(% style="color:#000000" %)}
1263 1263  
1264 -"drivers": [ ~/~/ Водители
1265 - {
1266 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1267 - "isDefault": true
1268 - }
1269 - ],
1270 - "commandTemplates": [ ~/~/ Шаблон команды
1271 - {
1272 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1273 - "name": "string",
1274 - "command": "string",
1275 - "retries": 0
1276 - }
1277 - ],
1278 - "sensors": [ ~/~/ Датчики
1279 - {
1280 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1281 - "kind": 0,
1282 - "type": 0,
1283 - "name": "string",
1284 - "inputType": 0,
1285 - "inputNumber": 0,
1286 - "pseudonym": "string",
1287 - "medianDegree": 0,
1288 - "isInverted": true,
1289 - "disabled": true,
1290 - "gradeType": 0,
1291 - "gradesTables": [
1292 - {
1293 - "grades": [
1294 - {
1295 - "input": 0,
1296 - "output": 0
1297 - }
1298 - ],
1299 - "relevanceTime": "2023-05-22T12:19:59.728Z"
1300 - }
1301 - ],
1302 - "showInTooltip": true,
1303 - "showLastValid": true,
1304 - "showAsDutOnGraph": true,
1305 - "showWithoutIgn": true,
1306 - "agrFunction": 0,
1307 - "expr": "string",
1308 - "children": [
1309 - "string"
1310 - ],
1311 - "customParams": {
1312 - "additionalProp1": "string",
1313 - "additionalProp2": "string",
1314 - "additionalProp3": "string"
1315 - },
1316 - "summaryMaxValue": 0
1317 - }
1318 - ],
1319 - "customFields": [ ~/~/ Произвольные поля
1320 - {
1321 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1322 - "name": "string",
1323 - "value": "string",
1324 - "forClient": true,
1325 - "forTooltip": true,
1326 - "forReport": true
1327 - }
1328 - ]
1329 -}
1330 -
1331 1331  (% style="color:#000000" %)Ответ:
1332 1332  
1333 1333  (% lang="en-US" style="text-align:left" %)
... ... @@ -1378,7 +1378,7 @@
1378 1378  (% lang="en-US" style="text-align:left" %)
1379 1379  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1380 1380  
1381 -**Валидация:**
1131 +**валидация:**
1382 1382  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1383 1383  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1384 1384  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1390,7 +1390,7 @@
1390 1390  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1391 1391  )))
1392 1392  
1393 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1394 1394  
1395 1395  (% style="color:#000000" %)Метод запроса: **DELETE**
1396 1396  
... ... @@ -1412,7 +1412,7 @@
1412 1412  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1413 1413  )))
1414 1414  
1415 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1416 1416  
1417 1417  (% style="color:#000000" %)Метод запроса: **GET**
1418 1418  
... ... @@ -1439,7 +1439,7 @@
1439 1439  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1440 1440  )))
1441 1441  
1442 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1443 1443  
1444 1444  (% style="color:#000000" %)Метод запроса: **GET**
1445 1445  
... ... @@ -1468,7 +1468,7 @@
1468 1468  )))
1469 1469  
1470 1470  (% style="text-align: left;" %)
1471 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1472 1472  
1473 1473  (% style="text-align: left;" %)
1474 1474  Метод запроса **POST**
... ... @@ -1506,7 +1506,7 @@
1506 1506  **POST /api/v3/terminalMessages**
1507 1507  )))
1508 1508  
1509 -Метод возвращает список сообщений терминала объекта за выбранный период.
1259 +Метод возвращает список сообщений терминала объекта за выбранный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1510 1510  
1511 1511  (% style="text-align: left;" %)
1512 1512  Метод запроса **POST**
... ... @@ -1548,206 +1548,7 @@
1548 1548   }
1549 1549  ]
1550 1550  
1551 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1552 1552  
1553 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1554 -
1555 -(% class="box infomessage" %)
1556 -(((
1557 -**POST /api/v3/notifications/find**
1558 -)))
1559 -
1560 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1561 -
1562 -(% style="text-align: left;" %)
1563 -Метод запроса **POST**
1564 -
1565 -(% style="text-align: left;" %)
1566 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1567 -
1568 -(% style="text-align: left;" %)
1569 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1570 -
1571 -{
1572 - "parentId": "" ~/~/ id клиента
1573 -}
1574 -
1575 -Ответ:
1576 -
1577 -[
1578 - {
1579 - "id": 0, ~/~/ ID уведомления
1580 - "name": "string", ~/~/ Название уведомления
1581 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1582 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1583 - "userId": "", ~/~/ Пользователь, создавший уведомление
1584 - "parentId": "", ~/~/ Идентификатор клиента
1585 - "parentName": "string" ~/~/ Имя клиента
1586 - }
1587 -]
1588 -
1589 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1590 -
1591 -(% class="box infomessage" %)
1592 -(((
1593 -**GET /api/v3/notifications/{id}**
1594 -)))
1595 -
1596 -Метод возвращает данные правил формирования выбранного уведомления.
1597 -
1598 -(% style="text-align: left;" %)
1599 -Метод запроса **GET**
1600 -
1601 -(% style="text-align: left;" %)
1602 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1603 -
1604 -(% style="text-align: left;" %)
1605 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1606 -
1607 -(% style="text-align: left;" %)
1608 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1609 -
1610 -(% style="text-align: left;" %)
1611 -(% style="color:#000000" %)Ответ:
1612 -
1613 -(% style="text-align: left;" %)
1614 -(% style="color:#000000" %){
1615 - "id": 0, ~/~/ (%%)id уведомления
1616 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1617 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1618 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1619 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1620 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1621 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1622 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1623 -(% style="color:#000000" %) 0
1624 - ],
1625 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1626 -(% style="color:#000000" %) 0
1627 - ],
1628 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
1629 -(% style="color:#000000" %) 0
1630 - ],
1631 - "settings": { ~/~/ Список параметров уведомления
1632 - "additionalProp1": "string",
1633 - "additionalProp2": "string",
1634 - "additionalProp3": "string"
1635 - },
1636 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1637 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1638 -(% style="color:#000000" %) ""
1639 - ],
1640 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1641 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1642 -(% style="color:#000000" %) "string"
1643 - ],
1644 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1645 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1646 -(% style="color:#000000" %) {
1647 - "id": 0, ~/~/ (%%)Идентификатор участника чата
1648 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1649 -(% style="color:#000000" %) }
1650 - ],
1651 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1652 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1653 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1654 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1655 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1656 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1657 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1658 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1659 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1660 -(% style="color:#000000" %)}
1661 -
1662 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1663 -
1664 -(% class="box warningmessage" %)
1665 -(((
1666 -**PUT /api/v3/notifications/**
1667 -)))
1668 -
1669 -Метод позволяет отредактировать уведомление.
1670 -
1671 -Метод запроса **PUT**
1672 -
1673 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1674 -
1675 -В заголовках запроса: X-Auth: Токен авторизации
1676 -
1677 -Тело запроса:
1678 -{
1679 - "id": 0, ~/~/ id уведомления
1680 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1681 - "userId": "", ~/~/ Пользователь, создавший уведомление
1682 - "parentId": "", ~/~/ Идентификатор клиента
1683 - "parentName": "string", ~/~/ Имя клиента
1684 - "name": "string", ~/~/ Название уведомления
1685 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1686 - "vehicleIds": [ ~/~/ Список id объектов для анализа
1687 - 0
1688 - ],
1689 - "geoids": [ ~/~/ Список id геообъектов для анализа
1690 - 0
1691 - ],
1692 - "fieldids": [ ~/~/ Список id полей для анализа
1693 - 0
1694 - ],
1695 - "settings": { ~/~/ Список параметров уведомления
1696 - "additionalProp1": "string",
1697 - "additionalProp2": "string",
1698 - "additionalProp3": "string"
1699 - },
1700 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1701 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1702 - ""
1703 - ],
1704 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1705 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1706 - "string"
1707 - ],
1708 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1709 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1710 - {
1711 - "id": 0, ~/~/ Идентификатор участника чата
1712 - "info": "string" ~/~/ Дополнительные сведения
1713 - }
1714 - ],
1715 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1716 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1717 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1718 - "kind": 0, ~/~/ Определяет вид уведомления
1719 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1720 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1721 - "timezone": 0, ~/~/ Сдвиг часового пояса
1722 - "validity": 0, ~/~/ Срок действия в днях (1-90)
1723 - "autoProlongation": true ~/~/ Автопродление срока действия
1724 -}
1725 -
1726 -Ответ:
1727 -
1728 -Success
1729 -
1730 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1731 -
1732 -(% class="box errormessage" %)
1733 -(((
1734 -**DELETE /api/v3/notifications/{id}**
1735 -)))
1736 -
1737 -Метод позволяет удалить выбранное уведомление.
1738 -
1739 -Метод запроса **DELETE**
1740 -
1741 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1742 -
1743 -Передаваемый параметр: {id} - id уведомления
1744 -
1745 -В заголовках запроса: X-Auth: Токен авторизации
1746 -
1747 -Ответ:
1748 -
1749 -Success
1750 -
1751 1751  (% class="box" lang="en-US" style="text-align: center;" %)
1752 1752  (((
1753 1753  (% 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 г.