Version 20.7 by Артем Шемяков on 2022/09/01 17:44
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": "", ~/~/ тип клиента1
103 "status": "", ~/~/ статус клиента
104 }
105
106
107 (% 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" %)]
108
109
110 (% class="box" style="text-align: center;" %)
111 (((
112 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
113 )))
114
115 (% class="box successmessage" %)
116 (((
117 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
118 )))
119
120 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
121
122 (% style="color:#000000" %)Метод запроса: **POST**
123
124 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
125
126 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
127
128 (% style="color:#000000" %)Параметры в теле запроса (JSON):
129
130 (% style="color:#000000" %){ 
131 "lastName": "", ~/~/ фамилия
132 "firstName": "", ~/~/ имя
133 "position": "", ~/~/ должность
134 "phone": "", ~/~/ телефон
135 "organization": "", ~/~/ организация
136 "login": "", ~/~/ логин
137 "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 "email": "", ~/~/ email
139 "description": "", ~/~/ описание
140 "isEnabled": "", ~/~/ признак включения
141 "parentId": "", ~/~/ Guid родительского агента
142 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 "groups": "" , ~/~/ группы пользователя, названия групп
148 }
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" %){
155
156 (% style="text-align:left" %)
157 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
158 "lastName": "" , ~/~/ Фамилия ,
159 "firstName": "" , ~/~/ Имя
160 "position": "" , ~/~/ Должность
161 "phone": "" , ~/~/ Телефон
162 "organization": "" , ~/~/ Организация
163 "login": "" , ~/~/ Логин
164 "password": "" , ~/~/ Пароль
165 "email": "" , ~/~/ Email
166 "description": "" , ~/~/ Описание
167 "isEnabled": "" , ~/~/ Признак включения
168 "parentId": "" , ~/~/ Guid родительского агента
169 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 "kind": "" , ~/~/ тип аутентификации
172 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174
175 (% style="text-align:left" %)
176 (% style="color:#000000; font-weight:normal" %) }
177
178
179 (% class="box successmessage" %)
180 (((
181 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
182 )))
183
184 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
185
186 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
187
188 (% style="color:#000000" %)Метод запроса: **POST**
189
190 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
191
192 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
193
194 (% style="color:#000000" %){
195
196 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
200
201 (% style="color:#000000" %) }
202
203 (% style="color:#000000" %)Ответ:
204
205 (% style="color:#000000" %){ (%%)
206
207 "id": "" , ~/~/ идентификатор пользователя
208 "lastName": "" , ~/~/ фамилия
209 "firstName": "" , ~/~/ имя
210 "position": "" , ~/~/ должность
211 "phone": "" , ~/~/ телефон
212 "parentId": "" , ~/~/ идентификатор клиента-родителя
213 "parentName": "" , ~/~/ наименование клиента-родителя
214 "organization": "" , ~/~/ организация
215 "login": "" , ~/~/ логин
216 "email": "" , ~/~/ E-mail
217 "sessionDuration":"", ~/~/ длительность сессии в минутах
218 "status": "1",  ~/~/ статус пользователя
219 "astLogged": "", ~/~/ дата/время последней авторизации
220
221 (% style="color:#000000" %) }
222
223
224 (% class="box warningmessage" %)
225 (((
226 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
227 )))
228
229 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
230
231 (% style="color:#000000" %)Метод запроса: **PUT**
232
233 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
234
235 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
236
237 (% lang="en-US" style="text-align:left" %)
238 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
239
240 (% lang="en-US" style="text-align:left" %)
241 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){
242
243 (% lang="en-US" style="text-align:left" %)
244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
245 "lastName": "" , ~/~/ фамилия
246 "firstName": "" , ~/~/ имя
247 "position": "" , ~/~/ должность
248 "phone": "" , ~/~/ телефон
249 "organization": "" , ~/~/ организация
250 "login": "" , ~/~/ логин
251 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
252 "email": "" , ~/~/ email
253 "description": "" , ~/~/ описание
254 "isEnabled": "" , ~/~/ признак включения
255 "parentId": "" , ~/~/ Guid родительского агента
256 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
257 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
258 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
259 "kind": "" , ~/~/ тип аутентификации
260 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
261 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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" %)//{ //
271
272 (% lang="en-US" style="text-align:left" %)
273 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)// "id": "" , ~/~/ идентификатор пользователя
274 "lastName": "" , ~/~/ фамилия
275 "firstName": "" , ~/~/ имя
276 "position": "" , ~/~/ должность
277 "phone": "" , ~/~/ телефон
278 "organization": "" , ~/~/ организация
279 "login": "" , ~/~/ логин
280 "password": "" , ~/~/ пароль 
281 "email": "" , ~/~/ email
282 "description": "" , ~/~/ описание
283 "isEnabled": "" , ~/~/ признак включения
284 "parentId": "" , ~/~/ Guid родительского агента
285 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
286 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
287 "kind": "" , ~/~/ тип аутентификации
288 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
289 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя//
290
291 (% lang="en-US" style="text-align:left" %)
292 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)// //}
293
294
295 (% class="box warningmessage" %)
296 (((
297 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
298 )))
299
300 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
301
302 (% style="color:#000000" %)Метод запроса: **PUT**
303
304 (% 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}
305
306 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
307
308 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
309
310 (% style="color:#000000" %)Параметры в теле запроса (JSON):
311
312 (% style="color:#000000" %){
313
314 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
315 "description": "" , ~/~/ описание
316 "data": "" , ~/~/ данные, связанные со сменой статуса
317
318 (% style="color:#000000" %)}
319
320 (% style="text-align:left" %)
321 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
322
323
324 (% class="box errormessage" %)
325 (((
326 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
327 )))
328
329 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
330
331 (% style="color:#000000" %)Метод запроса: **DELETE**
332
333 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
334
335 (% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
336
337 (% style="text-align:left" %)
338 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
339
340
341 (% class="box" style="text-align: center;" %)
342 (((
343 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
344 )))
345
346 (% class="box infomessage" %)
347 (((
348 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
349 )))
350
351 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
352
353 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
354
355 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
356
357 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
358
359 (% style="color:#000000" %)Метод запроса: **GET**
360
361 (% 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>
362
363 (% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
364
365 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
366
367 (% style="color:#000000" %)Ответ:
368
369 (% style="color:#000000" %){
370
371 (% class="western" %)
372 {{{ "vehicleId": “”, // идентификатор объекта
373 "name": "", // имя объекта
374 "imei": "", // IMEI объекта
375 "deviceTypeId": “”, // идентификатор устройства объекта
376 "deviceTypeName": "" // наименование устройства объекта
377 "parentId": "", // идентификатор клиента-родителя
378 "parentName": "" // наименование клиента-родителя,
379 "modelId": "", // идентификатор модели объекта
380 "modelName": "" // наименование модели объекта,
381 "unitId": "", // идентификатор подразделения
382 "unitName": "", // наименование подразделения
383 "status": “”, // статус объекта
384 ...
385 },
386 ...}}}
387
388 (% style="color:#000000" %)}
389
390 (% style="text-align:left" %)
391 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
392
393 (% style="text-align:left" %)
394 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
395
396
397 (% class="box successmessage" %)
398 (((
399 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
400 )))
401
402 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
403
404 (% style="color:#000000" %)Метод запроса: **POST**
405
406 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
407
408 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
409
410 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
411
412 (% class="western" %)
413 {{{ "parentId": "", // ID клиента
414 "name": "", // имя ТС
415 "imei": "", // IMEI
416 "deviceTypeId": "",// ID типа устройства
417 "modelId": "",
418 "unitId": "", // ID подразделения
419 "sim1": "", // Номер SIM 1
420 "sim2": "", // Номер SIM2
421 "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
422 "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
423 "consumptionIdle": "",// Расход топлива на холостом ходу
424 "counters": {
425 "mileage": "", // пробег
426 "mileageEnabled": true, // флаг активности счётчика "пробег"
427 "motohours":"", // моточасы
428 "motohoursEnabled": true // флаг активности счётчика "моточасы"
429 },
430 "cmsv6Parameters": { // параметры CMSv6
431 "enabled": true, // флаг включения
432 //"id": "", // идентификатор
433 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
434 "login": "", // имя учетной записи
435 "password": "" // пароль учетной записи
436 },
437 "inspectionTasks": [ // задания на ТО
438 {
439 "enabled": "", // Признак включения
440 "name": "", // Имя задания
441 "description": "", // Описание задания
442 "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
443 "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
444 "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
445 "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
446 "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
447 "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
448 "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
449 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
450 },
451 ]}}}
452
453 (% style="color:#000000" %)… }
454
455 (% style="color:#000000" %)Ответ:
456
457 (% style="color:#000000" %){
458
459 (% class="western" %)
460 {{{ "vehicleId": "", //ID ТС
461 "parentId": "", //Guid владельца ТС
462 "name": "", //Имя объекта
463 "imei": "", //IMEI
464 "deviceTypeId": "", //ID типа устройства
465 "modelId": "", //ID модели
466 "unitId": "", //ID подразделения
467 "sim1": "", //SIM1
468 "sim2": "", //SIM2
469 "consumptionPer100Km": "", //Расход топлива на 100 км
470 "consumptionIdle": "", //Расход топлива на холостом ходу
471 "counters": { //Счётчики
472 "mileageEnabled": true,
473 "motohoursEnabled": true,
474 "mileage": "",
475 "motohours": 345.0
476 },
477 "cmsv6Parameters": { //Параметры CmsV6
478 "id": null,
479 "enabled": true, //флаг включения
480 "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
481 "login": "", // имя учетной записи
482 "password": "" // пароль учетной записи
483 },
484 "inspectionTasks": [ // задания на ТО
485 {
486 "id": "", // ID задачи
487 "enabled": false, // Признак включения
488 "name": "", // Имя задания
489 "description": "", // Описание задания
490 "mileageCondition": "", // Условие по пробегу
491 "lastMileage": "", // Пробег (в метрах)
492 "motohoursCondition": "", // Условие по моточасам
493 "lastMotohours": "", // Моточасы
494 "periodicCondition": "", // Условие периодичности по времени
495 "kind": "", // Вид периодичности по времени
496 "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
497 }
498 ]}}}
499
500 (% style="text-align:left" %)
501 (% style="color:#000000" %)}
502
503
504 (% class="box successmessage" %)
505 (((
506 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
507 )))
508
509 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
510
511 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
512
513 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
514
515 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
516
517 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
518
519 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
520
521 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
522
523 (% style="color:#000000" %)Метод запроса: **POST**
524
525 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
526
527 (% style="color:#000000" %)В заголовках запроса:
528
529 (% style="color:#000000" %)− Content-Type: application/json
530
531 (% style="color:#000000" %)− X-Auth: Токен авторизации
532
533 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
534
535 (% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
536
537 (% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
538
539 (% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
540
541 (% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
542
543 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
544
545 (% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
546
547 (% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
548
549 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
550
551
552 (% class="box successmessage" %)
553 (((
554 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
555 )))
556
557 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
558
559 (% style="color:#000000" %)Метод запроса: **POST**
560
561 (% 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}
562
563 (% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
564
565 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
566
567 (% style="color:#000000" %)Параметры в теле запроса (JSON): {
568
569 (% class="western" %)
570 {{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
571   // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
572   // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
573 "date": "", // Дата смены статуса (null если сменить немедленно)
574 "description": "", // Описание
575 "data": "", // Данные
576 "overwrite": false, // Флаг перезаписи
577 "stage": "", // Состояние, может быть null}}}
578
579 (% style="color:#000000" %)}
580
581 (% style="color:#000000" %)Ответ: {
582
583 (% class="western" %)
584 {{{ "status": "", // значение статуса
585 "date": "", // Дата смены статуса
586 "description": "", // Описание
587 "data": "", // Данные
588 "overwrite": false, // Флаг перезаписи
589 "stage": "", // Состояние}}}
590
591 (% style="text-align:left" %)
592 (% style="color:#000000" %)}
593
594
595 (% class="box warningmessage" %)
596 (((
597 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
598 )))
599
600 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
601
602 (% style="color:#000000" %)Метод запроса: **PUT**
603
604 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
605
606 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
607
608 (% style="color:#000000" %)Параметры в теле запроса (JSON):
609
610 (% 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»: «» //Сколько раз выполнить задание } ] }
611
612 (% style="color:#000000" %)Ответ:
613
614 (% lang="en-US" style="text-align:left" %)
615 (% 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»: «» //Сколько раз выполнить задание } ] }
616
617
618 (% class="box errormessage" %)
619 (((
620 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
621 )))
622
623 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
624
625 (% style="color:#000000" %)Метод запроса: **DELETE**
626
627 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
628
629 (% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
630
631 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
632
633 (% style="text-align:left" %)
634 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
635
636
637 (% class="box" lang="en-US" style="text-align: center;" %)
638 (((
639 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
640 )))
641
642 (% class="box infomessage" %)
643 (((
644 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
645 )))
646
647 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
648
649 (% style="color:#000000" %)Метод запроса: **GET**
650
651 (% 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]]
652
653 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
654
655 (% style="color:#000000" %)Ответ: [
656
657 (% class="western" %)
658 {{{ {
659 "deviceTypeId" : "", // ID типа устройства
660 "deviceTypeName" : "" // Название типа устройства
661 },}}}
662
663 (% style="text-align:left" %)
664 (% style="color:#000000" %)…** **]
665
666
667 (% class="box" style="text-align: center;" %)
668 (((
669 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
670 )))
671
672 (% class="box infomessage" %)
673 (((
674 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
675 )))
676
677 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
678
679 (% style="color:#000000" %)Метод запроса: **GET**
680
681 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
682
683 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
684
685 (% style="color:#000000" %)Ответ: [
686
687 (% class="western" style="margin-bottom:19px" %)
688 {{{ {}}}
689
690 (% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
691
692 (% class="western" %)
693 {{{ "description": "" // Описание
694 },}}}
695
696 (% style="text-align:left" %)
697 (% style="color:#000000" %)… ]
698
699
700 (% class="box" lang="en-US" style="text-align: center;" %)
701 (((
702 (% 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]] **
703 )))

Меню

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