Version 26.2 by Артем Шемяков on 2022/09/15 15:19
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": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
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" %)Условия фильтрации объектов задаются в теле запроса.
190
191 (% style="color:#000000" %)Параметры в теле запроса (JSON):
192
193 (% style="color:#000000" %){
194
195 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
196 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
197 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
198 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
199
200 (% style="color:#000000" %)}
201
202 (% style="color:#000000" %)Ответ:
203
204 (% style="color:#000000" %){         (%%)
205
206 "id": "" , ~/~/ идентификатор пользователя
207 "lastName": "" , ~/~/ фамилия
208 "firstName": "" , ~/~/ имя
209 "position": "" , ~/~/ должность
210 "phone": "" , ~/~/ телефон
211 "parentId": "" , ~/~/ идентификатор клиента-родителя
212 "parentName": "" , ~/~/ наименование клиента-родителя
213 "organization": "" , ~/~/ организация
214 "login": "" , ~/~/ логин
215 "email": "" , ~/~/ E-mail
216 "sessionDuration":"", ~/~/ длительность сессии в минутах
217 "status": "1",  ~/~/ статус пользователя
218 "astLogged": "", ~/~/ дата/время последней авторизации
219
220 (% style="color:#000000" %)}
221
222
223 (% class="box warningmessage" %)
224 (((
225 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
226 )))
227
228 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
229
230 (% style="color:#000000" %)Метод запроса: **PUT**
231
232 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
233
234 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235
236 (% lang="en-US" style="text-align:left" %)
237 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
238
239 (% lang="en-US" style="text-align:left" %)
240 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
241
242 (% lang="en-US" style="text-align:left" %)
243 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
244 "lastName": "" , ~/~/ фамилия
245 "firstName": "" , ~/~/ имя
246 "position": "" , ~/~/ должность
247 "phone": "" , ~/~/ телефон
248 "organization": "" , ~/~/ организация
249 "login": "" , ~/~/ логин
250 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 "email": "" , ~/~/ email
252 "description": "" , ~/~/ описание
253 "isEnabled": "" , ~/~/ признак включения
254 "parentId": "" , ~/~/ Guid родительского агента
255 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
256 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
257 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
258 "kind": "" , ~/~/ тип аутентификации
259 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
260 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
261
262 (% lang="en-US" style="text-align:left" %)
263 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
264
265 (% lang="en-US" style="text-align:left" %)
266 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
267
268 (% lang="en-US" style="text-align:left" %)
269 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
270
271 (% lang="en-US" style="text-align:left" %)
272 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
273 "lastName": "" , ~/~/ фамилия
274 "firstName": "" , ~/~/ имя
275 "position": "" , ~/~/ должность
276 "phone": "" , ~/~/ телефон
277 "organization": "" , ~/~/ организация
278 "login": "" , ~/~/ логин
279 "password": "" , ~/~/ пароль 
280 "email": "" , ~/~/ email
281 "description": "" , ~/~/ описание
282 "isEnabled": "" , ~/~/ признак включения
283 "parentId": "" , ~/~/ Guid родительского агента
284 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
285 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
286 "kind": "" , ~/~/ тип аутентификации
287 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
288 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
289
290 (% lang="en-US" style="text-align:left" %)
291 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
292
293
294 (% class="box warningmessage" %)
295 (((
296 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
297 )))
298
299 (% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300
301 (% style="color:#000000" %)Метод запроса: **PUT**
302
303 (% 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}
304
305 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
306
307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
308
309 (% style="color:#000000" %)Параметры в теле запроса (JSON):
310
311 (% style="color:#000000" %){
312
313 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
314 "description": "" , ~/~/ описание
315 "data": "" , ~/~/ данные, связанные со сменой статуса
316
317 (% style="color:#000000" %)}
318
319 (% style="text-align:left" %)
320 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
321
322
323 (% class="box errormessage" %)
324 (((
325 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
326 )))
327
328 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
329
330 (% style="color:#000000" %)Метод запроса: **DELETE**
331
332 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
333
334 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
335
336 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
337
338 (% style="text-align:left" %)
339 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
340
341
342 (% class="box" style="text-align: center;" %)
343 (((
344 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
345 )))
346
347 (% class="box infomessage" %)
348 (((
349 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
350 )))
351
352 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
353
354 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
355
356 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
357
358 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
359
360 (% style="color:#000000" %)Метод запроса: **GET**
361
362 (% 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>
363
364 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
365
366 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
367
368 (% style="color:#000000" %)Ответ:
369
370 (% style="color:#000000" %){
371
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 (% style="text-align:left" %)
388 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
389
390 (% style="text-align:left" %)
391 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
392
393
394 (% class="box successmessage" %)
395 (((
396 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
397 )))
398
399 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
400
401 (% style="color:#000000" %)Метод запроса: **POST**
402
403 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
404
405 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
406
407 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
408
409 (% style="color:#000000" %){
410
411 "parentId": "" , ~/~/ ID клиента
412 "name": "" , ~/~/ имя ТС
413 "imei": "" , ~/~/ IMEI
414 "deviceTypeId": "" , ~/~/ ID типа устройства
415 "modelId": "" , ~/~/ ID модели
416 "unitId": "" , ~/~/ ID подразделения
417 "sim1": "" , ~/~/ Номер SIM 1
418 "sim2": "" , ~/~/ Номер SIM2
419 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 "counters": {
423 "mileage": "" , ~/~/ пробег
424 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 "motohours": "" , ~/~/ моточасы
426 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
427 },
428 "cmsv6Parameters": { ~/~/ параметры CMSv6
429 "enabled": true, ~/~/ флаг включения
430 "id": "" , ~/~/ идентификатор
431 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
432 "login": "" , ~/~/ имя учетной записи
433 "password": "" ~/~/ пароль учетной записи
434 },
435 "inspectionTasks": ~/~/ задания на ТО
436 {
437 "enabled": "" , ~/~/ Признак включения
438 "name": "" , ~/~/ Имя задания
439 "description": "" , ~/~/ Описание задания
440 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
441 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
442 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
443 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
444 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
445 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
446 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
447 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
448 }
449
450 (% style="color:#000000" %) }
451
452 (% style="color:#000000" %)Ответ:
453
454 (% style="color:#000000" %){
455
456 "vehicleId": "", ~/~/ID ТС 
457 "parentId": "", ~/~/Guid владельца ТС
458 "name": "", ~/~/Имя объекта
459 "imei": "", ~/~/IMEI
460 "deviceTypeId": "", ~/~/ID типа устройства
461 "modelId": "", ~/~/ID модели
462 "unitId": "", ~/~/ID подразделения
463 "sim1": "", ~/~/SIM1
464 "sim2": "", ~/~/SIM2
465 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
466 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
467 "counters": { ~/~/Счётчики
468 "mileageEnabled": true,
469 "motohoursEnabled": true,
470 "mileage": "",
471 "motohours": 345.0
472 },
473 "cmsv6Parameters": { ~/~/Параметры CmsV6
474 "id": null,
475 "enabled": true, ~/~/флаг включения
476 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
477 "login": "", ~/~/ имя учетной записи
478 "password": "" ~/~/ пароль учетной записи
479 },
480 "inspectionTasks": { ~/~/ задания на ТО
481 "id": "", ~/~/ ID задачи
482 "enabled": false, ~/~/ Признак включения
483 "name": "", ~/~/ Имя задания
484 "description": "", ~/~/ Описание задания
485 "mileageCondition": "", ~/~/ Условие по пробегу
486 "lastMileage": "", ~/~/ Пробег (в метрах)
487 "motohoursCondition": "", ~/~/ Условие по моточасам
488 "lastMotohours": "", ~/~/ Моточасы
489 "periodicCondition": "", ~/~/ Условие периодичности по времени
490 "kind": "", ~/~/ Вид периодичности по времени 
491 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
492 }
493
494 (% style="text-align:left" %)
495 (% style="color:#000000" %)}
496
497
498 (% class="box successmessage" %)
499 (((
500 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
501 )))
502
503 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
504
505 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
506
507 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
508
509 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
510
511 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
512
513 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
514
515 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
516
517 (% style="color:#000000" %)Метод запроса: **POST**
518
519 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
520
521 (% style="color:#000000" %)В заголовках запроса:
522
523 (% style="color:#000000" %)− Content-Type: __**application/json**__
524
525 (% style="color:#000000" %)− X-Auth: Токен авторизации
526
527 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
528
529 (% style="color:#000000" %)Параметры в теле запроса (JSON):
530
531 (% class="western" style="color:#000000" %)##{##
532
533 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 "name": null, ~/~/ Имя ТС (string, опционально) 
535 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
540 (% style="color:#000000" %)}
541
542 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
543
544 (% style="color:#000000" %)Ответ:
545
546 (% style="color:#000000" %){
547
548 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
549 "name": "" ~/~/ наименование объекта
550 "imei": "" ~/~/ IMEI объекта
551 "deviceTypeId": "" ~/~/ идентификатор типа устройства
552 "deviceTypeName": "" ~/~/ наименование типа устройства
553 "sim1": "" ~/~/ первый номер телефона
554 "sim2": "" ~/~/ второй номер телефона
555 "parentId": "" ~/~/ идентификатор клиента-родителя
556 "parentName": "" ~/~/ наименование клиента-родителя
557 "modelId": "" ~/~/ идентификатор модели объекта
558 "modelName": "" ~/~/ наименование модели объекта
559 "unitId": "" ~/~/ идентификатор подразделения
560 "unitName": "" ~/~/ наименование подразделения
561 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
562 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
563 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
565 (% style="color:#000000" %)}
566
567 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
568
569
570 (% class="box successmessage" %)
571 (((
572 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
573 )))
574
575 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
576
577 (% style="color:#000000" %)Метод запроса: **POST**
578
579 (% 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}
580
581 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
582
583 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
584
585 (% style="color:#000000" %)Параметры в теле запроса (JSON):
586
587 (% style="color:#000000" %){
588
589 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
590 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
591 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
592 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
593 "description": "", ~/~/ Описание
594 "data": "", ~/~/ Данные
595 "overwrite": false, ~/~/ Флаг перезаписи
596 "stage": "", ~/~/ Состояние, может быть null
597
598 (% style="color:#000000" %)}
599
600 (% style="color:#000000" %)Ответ:
601
602 (% style="color:#000000" %){
603
604 "status": "", ~/~/ значение статуса
605 "date": "", ~/~/ Дата смены статуса 
606 "description": "", ~/~/ Описание
607 "data": "", ~/~/ Данные
608 "overwrite": false, ~/~/ Флаг перезаписи
609 "stage": "", ~/~/ Состояние
610
611 (% style="text-align:left" %)
612 (% style="color:#000000" %) }
613
614
615 (% class="box warningmessage" %)
616 (((
617 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
618 )))
619
620 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
621
622 (% style="color:#000000" %)Метод запроса: **PUT**
623
624 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
625
626 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
627
628 (% style="color:#000000" %)Параметры в теле запроса (JSON):
629
630 (% style="color:#000000" %){    
631
632 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 "parentId": "", ~/~/ ID клиента
634 "name": "", ~/~/ имя ТС
635 "imei": "", ~/~/ IMEI
636 "deviceTypeId": "", ~/~/ ID типа устройства
637 "modelId": "", ~/~/ , ID модели    
638 "unitId": "", ~/~/ подразделения
639 "sim1": "", ~/~/ SIM 1
640 "sim2": "", ~/~/ SIM2
641 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 "counters": 
644 {
645 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
647 "mileage": «», пробег
648 "motohours": «» моточасы
649 }
650 "cmsv6Parameters": ~/~/ параметры CMSv6
651 {       
652 "id": "", ~/~/ идентификатор
653 "enabled": true, ~/~/ флаг включения
654 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
655 "login": "", ~/~/ имя учетной записи
656 "password": "", ~/~/ пароль учетной записи
657 }
658 "inspectionTasks": ~/~/ задания на ТО
659 {
660 "id": "", ~/~/ ID задания
661 "enabled": false, ~/~/ Признак включения
662 "name": "", ~/~/ Имя задания
663 "description": "", ~/~/ Описание задания
664 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
665 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
666 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
667 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
668 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
669 "kind": "", ~/~/ Вид периодичности по времени
670 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 } 
672
673 (% style="color:#000000" %)}
674
675 (% style="color:#000000" %)Ответ:
676
677 (% lang="en-US" style="text-align:left" %)
678 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
679
680 (% lang="en-US" style="text-align:left" %)
681 "vehicleId": "", ~/~/ ID ТС
682 "parentId": "", ~/~/ ID клиента
683 "name": "", ~/~/ имя ТС
684 "imei": "", ~/~/ IMEI
685 "deviceTypeId": "", ~/~/ типа устройства
686 "modelId": "", ~/~/ ID модели
687 "unitId": "", ~/~/ ID подразделения
688 "sim1": "", ~/~/ SIM 1
689 "sim2": "", ~/~/ SIM2
690 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
691 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
692 "counters": 
693 {
694 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
695 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
696 "mileage": "", ~/~/ пробег
697 "motohours": "", ~/~/ моточасы
698 }
699 "cmsv6Parameters": ~/~/ параметры CMSv6
700 {
701 "id": ~/~/ идентификатор
702 "enabled": true, ~/~/ флаг включения
703 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
704 "login": "", ~/~/ имя учетной записи
705 "password": "", ~/~/ пароль учетной записи
706 }
707 "inspectionTasks": ~/~/ задания на ТО
708 {
709 "id": "", ~/~/ ID задания
710 "enabled": false, ~/~/ Признак включения
711 "name": "", ~/~/ Имя задания
712 "description": "", ~/~/ Описание задания
713 "mileageCondition": "", ~/~/ Условие по пробегу
714 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
715 "motohoursCondition": "", ~/~/ Условие по моточасам
716 "lastMotohours": "", ~/~/ Моточасы
717 "periodicCondition": "", ~/~/ Условие периодичности по времени
718 "kind": "", ~/~/ Вид периодичности по времени
719 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
720 }
721
722 (% lang="en-US" style="text-align:left" %)
723 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
724
725
726 (% class="box errormessage" %)
727 (((
728 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
729 )))
730
731 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
732
733 (% style="color:#000000" %)Метод запроса: **DELETE**
734
735 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
736
737 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
738
739 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
740
741 (% style="text-align:left" %)
742 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
743
744
745 (% class="box" lang="en-US" style="text-align: center;" %)
746 (((
747 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
748 )))
749
750 (% class="box infomessage" %)
751 (((
752 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
753 )))
754
755 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
756
757 (% style="color:#000000" %)Метод запроса: **GET**
758
759 (% 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]]
760
761 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
762
763 (% style="color:#000000" %)Ответ:
764
765 (% style="color:#000000" %){
766
767 "deviceTypeId" : "", ~/~/ ID типа устройства
768 "deviceTypeName" : "" ~/~/ Название типа устройства
769
770 (% style="text-align:left" %)
771 (% style="color:#000000" %)}
772
773
774 (% class="box" style="text-align: center;" %)
775 (((
776 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
777 )))
778
779 (% class="box infomessage" %)
780 (((
781 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
782 )))
783
784 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
785
786 (% style="color:#000000" %)Метод запроса: **GET**
787
788 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
789
790 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
791
792 (% style="color:#000000" %)Ответ:
793
794 (% style="color:#000000" %){
795
796 "id": "", ~/~/ ID типа датчика 
797 "name": "", ~/~/ Название
798 "description": "", ~/~/ Описание
799
800 (% style="text-align:left" %)
801 (% style="color:#000000" %)}
802
803
804 (% class="box" lang="en-US" style="text-align: center;" %)
805 (((
806 (% 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]] **
807 )))

Меню

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