Редактировал(а) Андрей Калиновский 2025/03/12 10:28
<
От версии < 2.1 >
отредактировано Андрей Калиновский
на 2022/07/21 16:33
К версии < 8.1 >
отредактировано Артем Шемяков
на 2022/09/01 14:45
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Название
... ... @@ -1,1 +1,1 @@
1 -API
1 +Методы API для работы с ГЛОНАССSoft
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.Artem
Содержимое
... ... @@ -1,271 +1,356 @@
1 -== Описание ГЛОНАССSoft Public API ==
1 +(% class="western" %)
2 +== Описание ГЛОНАССSoft Public API
3 + ==
2 2  
3 -== ==
5 +(% class="box" %)
6 +(((
7 +**Действующие ограничения**
8 +)))
4 4  
5 - **Действующие ограничения**
10 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 6  
7 -Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
12 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
8 8  
9 9  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
15 +
10 10  
11 - **Авторизация**
17 +(% class="box" style="text-align: center;" %)
18 +(((
19 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Клиенты**
20 +)))
12 12  
13 -Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
22 +(% class="box infomessage" %)
23 +(((
24 +(% style="color:#000000" %)**Получение основных параметров клиента — (% lang="en-US" %)GET (%%)/(% lang="en-US" %)api/v3/agents(%%)**
25 +)))
14 14  
15 -Метод запроса: GET
27 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
16 16  
17 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
29 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
18 18  
19 -В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
31 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
20 20  
21 -Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
33 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
22 22  
23 - **Получение списка объектов**
35 +(% style="color:#000000" %)Метод запроса: **GET**
24 24  
25 -Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
37 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
26 26  
27 -−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
39 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
28 28  
29 -−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
41 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
30 30  
31 -−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
43 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
32 32  
33 -−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
45 +(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% lang="en-US" style="font-variant: normal; color: rgb(0, 0, 0); font-family: Liberation Serif, serif; font-size: 12pt; font-style: normal; font-weight: normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" lang="en-US" %)]
34 34  
35 -−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
36 36  
37 -Метод запроса: POST
48 +(% class="box" style="text-align: center;" %)
49 +(((
50 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Авторизация**
51 +)))
38 38  
39 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
53 +(% class="box infomessage" %)
54 +(((
55 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Проверка авторизации — G(% lang="en-US" %)ET /api/v3/auth/check(%%)**
56 +)))
40 40  
41 -В заголовках запроса:
58 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**.
42 42  
43 -−Content-Type: application/json
60 +(% style="color:#000000" %)Метод запроса: **GET**
44 44  
45 -−X-Auth: Токен авторизации
62 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
46 46  
47 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
64 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
48 48  
49 -{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
66 +(% lang="en-US" %)
67 +(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
50 50  
51 -Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
52 52  
53 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов  //}, … ]
70 +(% class="box infomessage" %)
71 +(((
72 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Авторизация — GE(% lang="en-US" %)T /api/v3/auth/login(%%)**
73 +)))
54 54  
55 -Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
75 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
56 56  
57 -0 - «Блокировка»
77 +(% style="color:#000000" %)Метод запроса: **GET**
58 58  
59 -1 - «Активен»,
79 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
60 60  
61 -2 - «Отменен»
81 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
62 62  
63 -3 - «Оборудован»
83 +(% lang="en-US" %)
84 +(% style="color:#000000" %)Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
64 64  
65 -4 - «Диагностика»
66 66  
67 -5 - «Сервис»
87 +(% class="box" lang="en-US" style="text-align: center;" %)
88 +(((
89 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел (% lang="ru-RU" %)Устройства(%%)**
90 +)))
68 68  
69 -6 - «Демонтаж»
92 +(% class="box infomessage" %)
93 +(((
94 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов устройств - GE(% lang="en-US" %)T /api/v3/devices/types(%%)**
95 +)))
70 70  
71 -7 - «Монтаж»
97 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
72 72  
73 -8 - «Дозаказ»
99 +(% style="color:#000000" %)Метод запроса: **GET**
74 74  
75 -9 - «Обслужен»
101 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
76 76  
77 -10 - «Списан»
103 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
78 78  
79 -11 - «Неисправен»
105 +(% style="color:#000000" %)Ответ: [
80 80  
81 -12 - «Проверен»
107 +(% class="western" %)
108 +{{{ {
109 + "deviceTypeId" : "", // ID типа устройства
110 + "deviceTypeName" : "" // Название типа устройства
111 + },}}}
82 82  
83 -13 - «Не эксплуатируется»
113 +(% style="text-align:left" %)
114 +(% style="color:#000000" %)…** **]
84 84  
85 - **Получение списка клиентов.**
86 86  
87 -Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
117 +(% class="box" style="text-align: center;" %)
118 +(((
119 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Датчики**
120 +)))
88 88  
89 -−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
122 +(% class="box infomessage" %)
123 +(((
124 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов датчиков - GE(% lang="en-US" %)T /api/v3/sensors/types(%%)**
125 +)))
90 90  
91 -−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
127 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
92 92  
93 -−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
129 +(% style="color:#000000" %)Метод запроса: **GET**
94 94  
95 -Метод запроса: GET
131 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
96 96  
97 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
133 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
98 98  
99 -Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
135 +(% style="color:#000000" %)Ответ: [
100 100  
101 -В заголовках запроса: X-Auth: Токен авторизации
137 +(% class="western" style="margin-bottom:19px" %)
138 +{{{ {}}}
102 102  
103 -Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
140 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
104 104  
105 -Примечание. Возможные значение параметра agentInfoType:
142 +(% class="western" %)
143 +{{{ "description": "" // Описание
144 + },}}}
106 106  
107 - **Получение списка пользователей.**
146 +(% style="text-align:left" %)
147 +(% style="color:#000000" %)… ]
108 108  
109 -Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
110 110  
111 -Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
150 +(% class="box" style="text-align: center;" %)
151 +(((
152 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Пользователи**
153 +)))
112 112  
113 -Метод запроса: POST
155 +(% class="box successmessage" %)
156 +(((
157 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление пользователя — (% lang="en-US" %)POST /api/v3/users(%%)**
158 +)))
114 114  
115 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
160 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
116 116  
117 -Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
162 +(% style="color:#000000" %)Метод запроса: **POST**
118 118  
119 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
120 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
121 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
122 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
164 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
123 123  
124 -}
166 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
125 125  
126 -Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
168 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
127 127  
128 -{{{ "sessionDuration": "", // длительность сессии в минутах}}}
170 +(% style="text-align:left" %)
171 +(% style="color: rgb(0, 0, 0); font-weight: normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
129 129  
130 - «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
131 131  
132 - **Получение списка типов устройств**
174 +(% class="box warningmessage" %)
175 +(((
176 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование пользователя — (% lang="en-US" %)PUT /api/v3/users(%%)**
177 +)))
133 133  
134 -Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
179 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
135 135  
136 -Метод запроса: GET
181 +(% style="color:#000000" %)Метод запроса: **PUT**
137 137  
138 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
183 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
139 139  
140 -В заголовках запроса:X-Auth: Токен авторизации
185 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 141  
142 -Ответ: [
187 +(% lang="en-US" style="text-align:left" %)
188 +(% lang="ru-RU" style="color: rgb(0, 0, 0); font-weight: normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } //
143 143  
144 -{{{ {
145 - "deviceTypeId" : "", // ID типа устройства
146 - "deviceTypeName" : "" // Название типа устройства
147 - },}}}
148 148  
149 -… ]
191 +(% class="box warningmessage" %)
192 +(((
193 +(% style="color:#000000" %)**Изменить статус пользователя**// //**— (% lang="en-US" %)PUT /api/v3/users/status/{id}(%%)**
194 +)))
150 150  
151 - **Получение списка типов датчиков**
196 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
152 152  
153 -Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
198 +(% style="color:#000000" %)Метод запроса: **PUT**
154 154  
155 -Метод запроса: GET
200 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
156 156  
157 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
202 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
158 158  
159 -В заголовках запроса:X-Auth: Токен авторизации
204 +(% class="western" %)
205 +{{{ "description": "", // описание
206 + "data": "" // данные, связанные со сменой статуса}}}
160 160  
161 -Ответ: [
208 +(% style="color:#000000" %)}
162 162  
163 -{{{ {}}}
210 +(% style="text-align:left" %)
211 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
164 164  
165 -«id»: «», //ID типа датчика «name»: «», //Название
166 166  
167 -{{{ "description": "" // Описание
168 - },}}}
214 +(% class="box successmessage" %)
215 +(((
216 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка пользователей — (% lang="en-US" %)POST /api/v3/users/find(%%)**
217 +)))
169 169  
170 -… ]
219 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
171 171  
172 - **Получение информации об объекте**
221 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
173 173  
174 -Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
223 +(% style="color:#000000" %)Метод запроса: **POST**
175 175  
176 -Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
225 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
177 177  
178 -−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
227 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
179 179  
180 -Метод запроса: GET
229 +(% class="western" %)
230 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
231 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
232 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
233 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
181 181  
182 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
235 +(% style="color:#000000" %)}
183 183  
184 -Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
237 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
185 185  
186 -В заголовках запроса: X-Auth: Токен авторизации
239 +(% class="western" style="margin-bottom:19px" %)
240 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
187 187  
188 -Ответ:
242 +(% lang="en-US" style="text-align:left" %)
243 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
189 189  
190 -{
191 191  
192 -{{{ "vehicleId": “”, // идентификатор объекта
193 - "name": "", // имя объекта
194 - "imei": "", // IMEI объекта
195 - "deviceTypeId": “”, // идентификатор устройства объекта
196 - "deviceTypeName": "" // наименование устройства объекта
197 - "parentId": "", // идентификатор клиента-родителя
198 - "parentName": "" // наименование клиента-родителя,
199 - "modelId": "", // идентификатор модели объекта
200 - "modelName": "" // наименование модели объекта,
201 - "unitId": "", // идентификатор подразделения
202 - "unitName": "", // наименование подразделения
203 - "status": “”, // статус объекта
204 - ...
205 - },
206 - ...}}}
246 +(% class="box errormessage" %)
247 +(((
248 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление пользователя — (% lang="en-US" %)DELETE /api/v3/users/{id}(%%)**
249 +)))
207 207  
208 -}
251 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
209 209  
210 -Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
253 +(% style="color:#000000" %)Метод запроса: **DELETE**
211 211  
212 - **Добавление пользователя**
255 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
213 213  
214 -Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
257 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
215 215  
216 -Метод запроса: POST
259 +(% style="text-align:left" %)
260 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
217 217  
218 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
219 219  
220 -В заголовках запроса: X-Auth: Токен авторизации
263 +(% class="box" style="text-align: center;" %)
264 +(((
265 +(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Транспортные средства**
266 +)))
221 221  
222 -Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
268 +(% class="box errormessage" %)
269 +(((
270 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление объекта — D(% lang="en-US" %)ELETE /api/v3/vehicles/{vehicleId}(%%)**
271 +)))
223 223  
224 -Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
273 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
225 225  
226 - **Редактирование пользователя**
275 +(% style="color:#000000" %)Метод запроса: **DELETE**
227 227  
228 -Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
277 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
229 229  
230 -Метод запроса: PUT
279 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
231 231  
232 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
281 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
233 233  
234 -В заголовках запроса: X-Auth: Токен авторизации
283 +(% style="text-align:left" %)
284 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
235 235  
236 -Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
237 237  
238 -{{{ "description": "", // описание
239 - "data": "" // данные, связанные со сменой статуса}}}
287 +(% class="box infomessage" %)
288 +(((
289 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение информации об объекте — (% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}(%%)**
290 +)))
240 240  
241 -}
292 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
242 242  
243 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
294 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
244 244  
245 - **Удаление пользователя**
296 +(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
246 246  
247 -Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
298 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
248 248  
249 -Метод запроса: DELETE
300 +(% style="color:#000000" %)Метод запроса: **GET**
250 250  
251 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
302 +(% 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>
252 252  
253 -Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
304 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
254 254  
255 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
306 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
256 256  
257 - **Добавление объекта**
308 +(% style="color:#000000" %)Ответ:
258 258  
259 -Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
310 +(% style="color:#000000" %){
260 260  
261 -Метод запроса: POST
312 +(% class="western" %)
313 +{{{ "vehicleId": “”, // идентификатор объекта
314 + "name": "", // имя объекта
315 + "imei": "", // IMEI объекта
316 + "deviceTypeId": “”, // идентификатор устройства объекта
317 + "deviceTypeName": "" // наименование устройства объекта
318 + "parentId": "", // идентификатор клиента-родителя
319 + "parentName": "" // наименование клиента-родителя,
320 + "modelId": "", // идентификатор модели объекта
321 + "modelName": "" // наименование модели объекта,
322 + "unitId": "", // идентификатор подразделения
323 + "unitName": "", // наименование подразделения
324 + "status": “”, // статус объекта
325 + ...
326 + },
327 + ...}}}
262 262  
263 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
329 +(% style="color:#000000" %)}
264 264  
265 -В заголовках запроса: X-Auth: Токен авторизации
331 +(% style="text-align:left" %)
332 +Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
266 266  
267 -Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
334 +(% style="text-align:left" %)
335 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
268 268  
337 +
338 +(% class="box successmessage" %)
339 +(((
340 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление объекта — (% lang="en-US" %)POST /api/v3/vehicles(%%)**
341 +)))
342 +
343 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
344 +
345 +(% style="color:#000000" %)Метод запроса: **POST**
346 +
347 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
348 +
349 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
350 +
351 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
352 +
353 +(% class="western" %)
269 269  {{{ "parentId": "", // ID клиента
270 270   "name": "", // имя ТС
271 271   "imei": "", // IMEI
... ... @@ -306,12 +306,13 @@
306 306   },
307 307   ]}}}
308 308  
309 -… }
394 +(% style="color:#000000" %)… }
310 310  
311 -Ответ:
396 +(% style="color:#000000" %)Ответ:
312 312  
313 -{
398 +(% style="color:#000000" %){
314 314  
400 +(% class="western" %)
315 315  {{{ "vehicleId": "", //ID ТС
316 316   "parentId": "", //Guid владельца ТС
317 317   "name": "", //Имя объекта
... ... @@ -346,61 +346,126 @@
346 346   "lastMileage": "", // Пробег (в метрах)
347 347   "motohoursCondition": "", // Условие по моточасам
348 348   "lastMotohours": "", // Моточасы
349 - "periodicCondition": "", // Условие периодичности по времени}}}
350 -
351 -{{{ "kind": "", // Вид периодичности по времени
435 + "periodicCondition": "", // Условие периодичности по времени
436 + "kind": "", // Вид периодичности по времени
352 352   "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
353 353   }
354 354   ]}}}
355 355  
356 -}
441 +(% style="text-align:left" %)
442 +(% style="color:#000000" %)}
357 357  
358 - **Удаление объекта**
359 359  
360 -Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
445 +(% class="box warningmessage" %)
446 +(((
447 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование объекта — (% lang="en-US" %)PUT /api/v3/vehicles(%%)**
448 +)))
361 361  
362 -Метод запроса: DELETE
450 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
363 363  
364 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
452 +(% style="color:#000000" %)Метод запроса: **PUT**
365 365  
366 -Параметр запроса: {id} - Guid объекта
454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
367 367  
368 -В заголовках запроса: X-Auth: Токен авторизации
456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
369 369  
370 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
458 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
371 371  
372 - **Редактирование объекта**
460 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
373 373  
374 -Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
462 +(% style="color:#000000" %)Ответ:
375 375  
376 -Метод запроса: PUT
464 +(% lang="en-US" style="text-align:left" %)
465 +(% lang="ru-RU" style="color: rgb(0, 0, 0); font-weight: normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
377 377  
378 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
379 379  
380 -В заголовках запроса: X-Auth: Токен авторизации
468 +(% class="box successmessage" %)
469 +(((
470 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка объектов — P(% lang="en-US" %)OST /api/v3/vehicles(%%)**
471 +)))
381 381  
382 -Параметры в теле запроса (JSON):
473 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
383 383  
384 -//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
475 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
385 385  
386 -Ответ:
477 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
387 387  
388 -{ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
479 +(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
389 389  
390 - **Изменение статуса объекта**
481 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
391 391  
392 -Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
483 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
393 393  
394 -Метод запроса: POST
485 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
395 395  
396 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
487 +(% style="color:#000000" %)Метод запроса: **POST**
397 397  
398 -Параметр запроса: {vehicleId} - ID ТС
489 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
399 399  
400 -В заголовках запроса: X-Auth: Токен авторизации
491 +(% style="color:#000000" %)В заголовках запроса:
401 401  
402 -Параметры в теле запроса (JSON): {
493 +(% style="color:#000000" %)− Content-Type: application/json
403 403  
495 +(% style="color:#000000" %)− X-Auth: Токен авторизации
496 +
497 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
498 +
499 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307", ~/~/ IMEI (string, опционально) "sim": null,~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5 ~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null ~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
500 +
501 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
502 +
503 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
504 +
505 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
506 +
507 +(% style="color:#000000" %)0 - «Блокировка»
508 +
509 +(% style="color:#000000" %)1 - «Активен»,
510 +
511 +(% style="color:#000000" %)2 - «Отменен»
512 +
513 +(% style="color:#000000" %)3 - «Оборудован»
514 +
515 +(% style="color:#000000" %)4 - «Диагностика»
516 +
517 +(% style="color:#000000" %)5 - «Сервис»
518 +
519 +(% style="color:#000000" %)6 - «Демонтаж»
520 +
521 +(% style="color:#000000" %)7 - «Монтаж»
522 +
523 +(% style="color:#000000" %)8 - «Дозаказ»
524 +
525 +(% style="color:#000000" %)9 - «Обслужен»
526 +
527 +(% style="color:#000000" %)10 - «Списан»
528 +
529 +(% style="color:#000000" %)11 - «Неисправен»
530 +
531 +(% style="color:#000000" %)12 - «Проверен»
532 +
533 +(% style="text-align:left" %)
534 +(% style="font-weight: normal; color: rgb(0, 0, 0)" %)13 - «Не эксплуатируется»
535 +
536 +
537 +(% class="box successmessage" %)
538 +(((
539 +(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Изменение статуса объекта — (% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}(%%)**
540 +)))
541 +
542 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
543 +
544 +(% style="color:#000000" %)Метод запроса: **POST**
545 +
546 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
547 +
548 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
549 +
550 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
551 +
552 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
553 +
554 +(% class="western" %)
404 404  {{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
405 405   "date": "", // Дата смены статуса (null если сменить немедленно)
406 406   "description": "", // Описание
... ... @@ -408,10 +408,11 @@
408 408   "overwrite": false, // Флаг перезаписи
409 409   "stage": "", // Состояние, может быть null}}}
410 410  
411 -}
562 +(% style="color:#000000" %)}
412 412  
413 -Ответ: {
564 +(% style="color:#000000" %)Ответ: {
414 414  
566 +(% class="western" %)
415 415  {{{ "status": "", // значение статуса
416 416   "date": "", // Дата смены статуса
417 417   "description": "", // Описание
... ... @@ -419,18 +419,11 @@
419 419   "overwrite": false, // Флаг перезаписи
420 420   "stage": "", // Состояние}}}
421 421  
422 -}
574 +(% style="text-align:left" %)
575 +(% style="color:#000000" %)}
423 423  
424 - **Проверка авторизации**
425 425  
426 -Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
427 -
428 -Метод запроса: GET
429 -
430 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
431 -
432 -В заголовках запроса: X-Auth: Токен авторизации
433 -
434 -Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
435 -
436 -**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
578 +(% class="box" lang="en-US" style="text-align: center;" %)
579 +(((
580 +(% style="color: rgb(0, 0, 0); font-size: 14pt" lang="ru-RU" %)**Расширенное описание PUBLIC API 3.0 доступно по запросу на support@glonasssoft.ru**
581 +)))

Меню

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