Version 22.4 by Артем Шемяков on 2022/09/02 10:05
Show last authors
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 == Описание ГЛОНАССSoft Public API 3.0 ==
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; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **GET**
31
32 (% 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]]
33
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35
36 (% lang="en-US" %)
37 (% style="color:#000000" %)**Ответ:**
38
39 (% lang="en-US" %)
40 (% style="color:#000000" %){
41
42 (% lang="en-US" %)
43 (% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 "User": "" , ~/~/ имя пользователя
45
46 (% lang="en-US" %)
47 }
48
49 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50
51
52 (% class="box infomessage" %)
53 (((
54 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
55 )))
56
57 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
58
59 (% style="color:#000000" %)Метод запроса: **GET**
60
61 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
62
63 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
64
65 (% lang="en-US" %)
66 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
67
68
69 (% class="box" style="text-align: center;" %)
70 (((
71 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
72 )))
73
74 (% class="box infomessage" %)
75 (((
76 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
77 )))
78
79 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
80
81 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82
83 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
84
85 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86
87 (% style="color:#000000" %)Метод запроса: **GET**
88
89 (% 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>
90
91 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
92
93 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
94
95 (% style="color:#000000" %)Ответ:
96
97 (% style="color:#000000" %){
98 "agentId": "", ~/~/ идентификатор клиента
99 "parentId": "", ~/~/ идентификатор клиента-родителя
100 "name": "", ~/~/ наименование клиента
101 "fullName": "", ~/~/ полное наименование клиента
102 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 "status": "", ~/~/ статус клиента
104 }
105
106
107 (% class="box" style="text-align: center;" %)
108 (((
109 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
110 )))
111
112 (% class="box successmessage" %)
113 (((
114 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
115 )))
116
117 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
118
119 (% style="color:#000000" %)Метод запроса: **POST**
120
121 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
122
123 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
124
125 (% style="color:#000000" %)Параметры в теле запроса (JSON):
126
127 (% style="color:#000000" %){ 
128 "lastName": "", ~/~/ фамилия
129 "firstName": "", ~/~/ имя
130 "position": "", ~/~/ должность
131 "phone": "", ~/~/ телефон
132 "organization": "", ~/~/ организация
133 "login": "", ~/~/ логин
134 "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 "email": "", ~/~/ email
136 "description": "", ~/~/ описание
137 "isEnabled": "", ~/~/ признак включения
138 "parentId": "", ~/~/ Guid родительского агента
139 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
140 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
141 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 "groups": "" , ~/~/ группы пользователя, названия групп
145 }
146
147 (% style="text-align:left" %)
148 (% style="color:#000000; font-weight:normal" %)Ответ:
149
150 (% style="text-align:left" %)
151 (% style="color:#000000; font-weight:normal" %){    
152
153 (% style="text-align:left" %)
154 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
155 "lastName": "" , ~/~/ Фамилия ,
156 "firstName": "" , ~/~/ Имя
157 "position": "" , ~/~/ Должность
158 "phone": "" , ~/~/ Телефон
159 "organization": "" , ~/~/ Организация
160 "login": "" , ~/~/ Логин
161 "password": "" , ~/~/ Пароль
162 "email": "" , ~/~/ Email
163 "description": "" , ~/~/ Описание
164 "isEnabled": "" , ~/~/ Признак включения
165 "parentId": "" , ~/~/ Guid родительского агента
166 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
167 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 "kind": "" , ~/~/ тип аутентификации
169 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
171
172 (% style="text-align:left" %)
173 (% style="color:#000000; font-weight:normal" %)}
174
175
176 (% class="box successmessage" %)
177 (((
178 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
179 )))
180
181 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
182
183 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
184
185 (% style="color:#000000" %)Метод запроса: **POST**
186
187 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
188
189 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
190
191 (% style="color:#000000" %){
192
193 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
194 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
195 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
196 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
197
198 (% style="color:#000000" %)}
199
200 (% style="color:#000000" %)Ответ:
201
202 (% style="color:#000000" %){         (%%)
203
204 "id": "" , ~/~/ идентификатор пользователя
205 "lastName": "" , ~/~/ фамилия
206 "firstName": "" , ~/~/ имя
207 "position": "" , ~/~/ должность
208 "phone": "" , ~/~/ телефон
209 "parentId": "" , ~/~/ идентификатор клиента-родителя
210 "parentName": "" , ~/~/ наименование клиента-родителя
211 "organization": "" , ~/~/ организация
212 "login": "" , ~/~/ логин
213 "email": "" , ~/~/ E-mail
214 "sessionDuration":"", ~/~/ длительность сессии в минутах
215 "status": "1",  ~/~/ статус пользователя
216 "astLogged": "", ~/~/ дата/время последней авторизации
217
218 (% style="color:#000000" %)}
219
220
221 (% class="box warningmessage" %)
222 (((
223 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
224 )))
225
226 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
227
228 (% style="color:#000000" %)Метод запроса: **PUT**
229
230 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
231
232 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
233
234 (% lang="en-US" style="text-align:left" %)
235 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
236
237 (% lang="en-US" style="text-align:left" %)
238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
239
240 (% lang="en-US" style="text-align:left" %)
241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
242 "lastName": "" , ~/~/ фамилия
243 "firstName": "" , ~/~/ имя
244 "position": "" , ~/~/ должность
245 "phone": "" , ~/~/ телефон
246 "organization": "" , ~/~/ организация
247 "login": "" , ~/~/ логин
248 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
249 "email": "" , ~/~/ email
250 "description": "" , ~/~/ описание
251 "isEnabled": "" , ~/~/ признак включения
252 "parentId": "" , ~/~/ Guid родительского агента
253 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
254 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
255 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
256 "kind": "" , ~/~/ тип аутентификации
257 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
258 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
259
260 (% lang="en-US" style="text-align:left" %)
261 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
262
263 (% lang="en-US" style="text-align:left" %)
264 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
265
266 (% lang="en-US" style="text-align:left" %)
267 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
268
269 (% lang="en-US" style="text-align:left" %)
270 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
271 "lastName": "" , ~/~/ фамилия
272 "firstName": "" , ~/~/ имя
273 "position": "" , ~/~/ должность
274 "phone": "" , ~/~/ телефон
275 "organization": "" , ~/~/ организация
276 "login": "" , ~/~/ логин
277 "password": "" , ~/~/ пароль 
278 "email": "" , ~/~/ email
279 "description": "" , ~/~/ описание
280 "isEnabled": "" , ~/~/ признак включения
281 "parentId": "" , ~/~/ Guid родительского агента
282 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
283 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
284 "kind": "" , ~/~/ тип аутентификации
285 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
286 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
287
288 (% lang="en-US" style="text-align:left" %)
289 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
290
291
292 (% class="box warningmessage" %)
293 (((
294 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
295 )))
296
297 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
298
299 (% style="color:#000000" %)Метод запроса: **PUT**
300
301 (% 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}
302
303 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
304
305 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
306
307 (% style="color:#000000" %)Параметры в теле запроса (JSON):
308
309 (% style="color:#000000" %){
310
311 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
312 "description": "" , ~/~/ описание
313 "data": "" , ~/~/ данные, связанные со сменой статуса
314
315 (% style="color:#000000" %)}
316
317 (% style="text-align:left" %)
318 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
319
320
321 (% class="box errormessage" %)
322 (((
323 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
324 )))
325
326 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
327
328 (% style="color:#000000" %)Метод запроса: **DELETE**
329
330 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
331
332 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
333
334 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
335
336 (% style="text-align:left" %)
337 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
338
339
340 (% class="box" style="text-align: center;" %)
341 (((
342 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
343 )))
344
345 (% class="box infomessage" %)
346 (((
347 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
348 )))
349
350 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
351
352 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
353
354 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
355
356 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
357
358 (% style="color:#000000" %)Метод запроса: **GET**
359
360 (% 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>
361
362 (% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
363
364 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
365
366 (% style="color:#000000" %)Ответ:
367
368 (% style="color:#000000" %){
369
370 "vehicleId": "" , ~/~/ идентификатор объекта
371 "name": "" , ~/~/ имя объекта
372 "imei": "" , ~/~/ IMEI объекта
373 "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
374 "deviceTypeName": "" , ~/~/ наименование устройства объекта
375 "parentId": "" , ~/~/ идентификатор клиента-родителя
376 "parentName": "" , ~/~/ наименование клиента-родителя,
377 "modelId": "" , ~/~/ идентификатор модели объекта
378 "modelName": "" , ~/~/ наименование модели объекта,
379 "unitId": "" , ~/~/ идентификатор подразделения
380 "unitName": "" , ~/~/ наименование подразделения
381 "status": "" , ~/~/ статус объекта
382
383 }
384
385 (% style="text-align:left" %)
386 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
387
388 (% style="text-align:left" %)
389 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
390
391
392 (% class="box successmessage" %)
393 (((
394 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
395 )))
396
397 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
398
399 (% style="color:#000000" %)Метод запроса: **POST**
400
401 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
402
403 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
404
405 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
406
407 (% style="color:#000000" %){
408
409 "parentId": "" , ~/~/ ID клиента
410 "name": "" , ~/~/ имя ТС
411 "imei": "" , ~/~/ IMEI
412 "deviceTypeId": "" , ~/~/ ID типа устройства
413 "modelId": "" , ~/~/ ID модели
414 "unitId": "" , ~/~/ ID подразделения
415 "sim1": "" , ~/~/ Номер SIM 1
416 "sim2": "" , ~/~/ Номер SIM2
417 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
418 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
419 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
420 "counters": {
421 "mileage": "" , ~/~/ пробег
422 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
423 "motohours": "" , ~/~/ моточасы
424 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
425 },
426 "cmsv6Parameters": { ~/~/ параметры CMSv6
427 "enabled": true, ~/~/ флаг включения
428 "id": "" , ~/~/ идентификатор
429 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
430 "login": "" , ~/~/ имя учетной записи
431 "password": "" ~/~/ пароль учетной записи
432 },
433 "inspectionTasks": ~/~/ задания на ТО
434 {
435 "enabled": "" , ~/~/ Признак включения
436 "name": "" , ~/~/ Имя задания
437 "description": "" , ~/~/ Описание задания
438 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
439 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
440 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
441 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
442 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
443 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
444 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
445 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
446 }
447
448 (% style="color:#000000" %) }
449
450 (% style="color:#000000" %)Ответ:
451
452 (% style="color:#000000" %){
453
454 "vehicleId": "", ~/~/ID ТС 
455 "parentId": "", ~/~/Guid владельца ТС
456 "name": "", ~/~/Имя объекта
457 "imei": "", ~/~/IMEI
458 "deviceTypeId": "", ~/~/ID типа устройства
459 "modelId": "", ~/~/ID модели
460 "unitId": "", ~/~/ID подразделения
461 "sim1": "", ~/~/SIM1
462 "sim2": "", ~/~/SIM2
463 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
464 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
465 "counters": { ~/~/Счётчики
466 "mileageEnabled": true,
467 "motohoursEnabled": true,
468 "mileage": "",
469 "motohours": 345.0
470 },
471 "cmsv6Parameters": { ~/~/Параметры CmsV6
472 "id": null,
473 "enabled": true, ~/~/флаг включения
474 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
475 "login": "", ~/~/ имя учетной записи
476 "password": "" ~/~/ пароль учетной записи
477 },
478 "inspectionTasks": { ~/~/ задания на ТО
479 "id": "", ~/~/ ID задачи
480 "enabled": false, ~/~/ Признак включения
481 "name": "", ~/~/ Имя задания
482 "description": "", ~/~/ Описание задания
483 "mileageCondition": "", ~/~/ Условие по пробегу
484 "lastMileage": "", ~/~/ Пробег (в метрах)
485 "motohoursCondition": "", ~/~/ Условие по моточасам
486 "lastMotohours": "", ~/~/ Моточасы
487 "periodicCondition": "", ~/~/ Условие периодичности по времени
488 "kind": "", ~/~/ Вид периодичности по времени 
489 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
490 }
491
492 (% style="text-align:left" %)
493 (% style="color:#000000" %)}
494
495
496 (% class="box successmessage" %)
497 (((
498 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
499 )))
500
501 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
502
503 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
504
505 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
506
507 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
508
509 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
510
511 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
512
513 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
514
515 (% style="color:#000000" %)Метод запроса: **POST**
516
517 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
518
519 (% style="color:#000000" %)В заголовках запроса:
520
521 (% style="color:#000000" %)− Content-Type: application/json
522
523 (% style="color:#000000" %)− X-Auth: Токен авторизации
524
525 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
526
527 (% class="western" style="color:#000000" %)##{##
528
529 (% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
530 "name": null, ~/~/ Имя ТС (string, опционально) 
531 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
532 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
533 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
534 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
535 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
536 (% style="color:#000000" %)}
537
538 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
539
540 (% style="color:#000000" %)Ответ:
541
542 (% style="color:#000000" %){
543
544 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
545 "name": "" ~/~/ наименование объекта
546 "imei": "" ~/~/ IMEI объекта
547 "deviceTypeId": "" ~/~/ идентификатор типа устройства
548 "deviceTypeName": "" ~/~/ наименование типа устройства
549 "sim1": "" ~/~/ первый номер телефона
550 "sim2": "" ~/~/ второй номер телефона
551 "parentId": "" ~/~/ идентификатор клиента-родителя
552 "parentName": "" ~/~/ наименование клиента-родителя
553 "modelId": "" ~/~/ идентификатор модели объекта
554 "modelName": "" ~/~/ наименование модели объекта
555 "unitId": "" ~/~/ идентификатор подразделения
556 "unitName": "" ~/~/ наименование подразделения
557 "status": "" ~/~/ статус объекта         
558 "createdAt": "" ~/~/ дата создания объектов  (%%)
559 (% style="color:#000000" %)}
560
561 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
562
563 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
564
565
566 (% class="box successmessage" %)
567 (((
568 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
569 )))
570
571 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
572
573 (% style="color:#000000" %)Метод запроса: **POST**
574
575 (% 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}
576
577 (% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
578
579 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
580
581 (% style="color:#000000" %)Параметры в теле запроса (JSON):
582
583 (% style="color:#000000" %){
584
585 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
586 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
587 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
588 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
589 "description": "", ~/~/ Описание
590 "data": "", ~/~/ Данные
591 "overwrite": false, ~/~/ Флаг перезаписи
592 "stage": "", ~/~/ Состояние, может быть null
593
594 (% style="color:#000000" %)}
595
596 (% style="color:#000000" %)Ответ:
597
598 (% style="color:#000000" %){
599
600 "status": "", ~/~/ значение статуса
601 "date": "", ~/~/ Дата смены статуса 
602 "description": "", ~/~/ Описание
603 "data": "", ~/~/ Данные
604 "overwrite": false, ~/~/ Флаг перезаписи
605 "stage": "", ~/~/ Состояние
606
607 (% style="text-align:left" %)
608 (% style="color:#000000" %) }
609
610
611 (% class="box warningmessage" %)
612 (((
613 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
614 )))
615
616 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
617
618 (% style="color:#000000" %)Метод запроса: **PUT**
619
620 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
621
622 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
623
624 (% style="color:#000000" %)Параметры в теле запроса (JSON):
625
626 (% style="color:#000000" %){    
627
628 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
629 "parentId": "", ~/~/ ID клиента
630 "name": "", ~/~/ имя ТС
631 "imei": "", ~/~/ IMEI
632 "deviceTypeId": "", ~/~/ ID типа устройства
633 "modelId": "", ~/~/ , ID модели    
634 "unitId": "", ~/~/ подразделения
635 "sim1": "", ~/~/ SIM 1
636 "sim2": "", ~/~/ SIM2
637 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
638 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
639 "counters": 
640 {
641 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
642 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
643 "mileage": «», пробег
644 "motohours": «» моточасы
645 }
646 "cmsv6Parameters": ~/~/ параметры CMSv6
647 {       
648 "id": "", ~/~/ идентификатор
649 "enabled": true, ~/~/ флаг включения
650 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
651 "login": "", ~/~/ имя учетной записи
652 "password": "", ~/~/ пароль учетной записи
653 }
654 "inspectionTasks": ~/~/ задания на ТО
655 {
656 "id": "", ~/~/ ID задания
657 "enabled": false, ~/~/ Признак включения
658 "name": "", ~/~/ Имя задания
659 "description": "", ~/~/ Описание задания
660 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
661 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
663 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
664 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
665 "kind": "", ~/~/ Вид периодичности по времени
666 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
667 } 
668
669 (% style="color:#000000" %)}
670
671 (% style="color:#000000" %)Ответ:
672
673 (% lang="en-US" style="text-align:left" %)
674 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
675
676 (% lang="en-US" style="text-align:left" %)
677 "vehicleId": "", ~/~/ ID ТС
678 "parentId": "", ~/~/ ID клиента
679 "name": "", ~/~/ имя ТС
680 "imei": "", ~/~/ IMEI
681 "deviceTypeId": "", ~/~/ типа устройства
682 "modelId": "", ~/~/ ID модели
683 "unitId": "", ~/~/ ID подразделения
684 "sim1": "", ~/~/ SIM 1
685 "sim2": "", ~/~/ SIM2
686 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
687 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
688 "counters": 
689 {
690 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
691 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
692 "mileage": "", ~/~/ пробег
693 "motohours": "", ~/~/ моточасы
694 }
695 "cmsv6Parameters": ~/~/ параметры CMSv6
696 {
697 "id": ~/~/ идентификатор
698 "enabled": true, ~/~/ флаг включения
699 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
700 "login": "", ~/~/ имя учетной записи
701 "password": "", ~/~/ пароль учетной записи
702 }
703 "inspectionTasks": ~/~/ задания на ТО
704 {
705 "id": "", ~/~/ ID задания
706 "enabled": false, ~/~/ Признак включения
707 "name": "", ~/~/ Имя задания
708 "description": "", ~/~/ Описание задания
709 "mileageCondition": "", ~/~/ Условие по пробегу
710 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
711 "motohoursCondition": "", ~/~/ Условие по моточасам
712 "lastMotohours": "", ~/~/ Моточасы
713 "periodicCondition": "", ~/~/ Условие периодичности по времени
714 "kind": "", ~/~/ Вид периодичности по времени
715 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
716 }
717
718 (% lang="en-US" style="text-align:left" %)
719 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
720
721
722 (% class="box errormessage" %)
723 (((
724 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
725 )))
726
727 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
728
729 (% style="color:#000000" %)Метод запроса: **DELETE**
730
731 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
732
733 (% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
734
735 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
736
737 (% style="text-align:left" %)
738 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
739
740
741 (% class="box" lang="en-US" style="text-align: center;" %)
742 (((
743 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
744 )))
745
746 (% class="box infomessage" %)
747 (((
748 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
749 )))
750
751 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
752
753 (% style="color:#000000" %)Метод запроса: **GET**
754
755 (% 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]]
756
757 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
758
759 (% style="color:#000000" %)Ответ:
760
761 (% style="color:#000000" %){
762
763 "deviceTypeId" : "", ~/~/ ID типа устройства
764 "deviceTypeName" : "" ~/~/ Название типа устройства
765
766 (% style="text-align:left" %)
767 (% style="color:#000000" %)}
768
769
770 (% class="box" style="text-align: center;" %)
771 (((
772 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
773 )))
774
775 (% class="box infomessage" %)
776 (((
777 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
778 )))
779
780 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
781
782 (% style="color:#000000" %)Метод запроса: **GET**
783
784 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
785
786 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
787
788 (% style="color:#000000" %)Ответ:
789
790 (% style="color:#000000" %){
791
792 "id": "", ~/~/ ID типа датчика 
793 "name": "", ~/~/ Название
794 "description": "", ~/~/ Описание
795
796 (% style="text-align:left" %)
797 (% style="color:#000000" %)}
798
799
800 (% class="box" lang="en-US" style="text-align: center;" %)
801 (((
802 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
803 )))
ГЛОНАССSoft wiki - 2024 г.