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

Меню

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