Version 47.1 by Илья Крайнов on 2022/11/21 10:32
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 successmessage" %)
24 (((
25 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **POST**
31
32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35
36 (% style="color:#000000" %)Параметры в теле запроса (JSON):
37
38 (% style="color:#000000" %){
39 "login": "testuser",
40 "password": "testuser"
41 }(%%)
42
43
44 (% style="color:#000000" %)**Ответ:**
45
46 (% lang="en-US" %)
47 (% style="color:#000000" %){
48
49 (% lang="en-US" %)
50 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 "User": "testuser" , ~/~/ имя пользователя
52
53 (% lang="en-US" %)
54 }
55
56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57
58
59 (% class="box infomessage" %)
60 (((
61 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 )))
63
64 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65
66 (% style="color:#000000" %)Метод запроса: **GET**
67
68 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
69
70 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
71
72 (% lang="en-US" %)
73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74
75
76 (% class="box" style="text-align: center;" %)
77 (((
78 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 )))
80
81 (% class="box infomessage" %)
82 (((
83 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 )))
85
86 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87
88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89
90 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91
92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93
94 (% style="color:#000000" %)Метод запроса: **GET**
95
96 (% 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>
97
98 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
99
100 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101
102 (% style="color:#000000" %)Ответ:
103
104 (% style="color:#000000" %){
105 "agentId": "", ~/~/ идентификатор клиента
106 "parentId": "", ~/~/ идентификатор клиента-родителя
107 "name": "", ~/~/ наименование клиента
108 "fullName": "", ~/~/ полное наименование клиента
109 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 }
112
113
114 (% class="box" style="text-align: center;" %)
115 (((
116 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 )))
118
119 (% class="box successmessage" %)
120 (((
121 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 )))
123
124 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125
126 (% style="color:#000000" %)Метод запроса: **POST**
127
128 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
129
130 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
131
132 (% style="color:#000000" %)Параметры в теле запроса (JSON):
133
134 (% style="color:#000000" %){ 
135 "lastName": "", ~/~/ фамилия
136 "firstName": "", ~/~/ имя
137 "position": "", ~/~/ должность
138 "phone": "", ~/~/ телефон
139 "organization": "", ~/~/ организация
140 "login": "", ~/~/ логин (обязателен)
141 "password": "", ~/~/ пароль (обязателен)
142 "email": "", ~/~/ email (обязателен)
143 "description": "", ~/~/ описание
144 "isEnabled": "", ~/~/ признак включения
145 "parentId": "", ~/~/ Guid родительского агента
146 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 }
153
154 (% style="text-align:left" %)
155 (% style="color:#000000; font-weight:normal" %)Ответ:
156
157 (% style="text-align:left" %)
158 (% style="color:#000000; font-weight:normal" %){    
159
160 (% style="text-align:left" %)
161 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 "lastName": "" , ~/~/ Фамилия ,
163 "firstName": "" , ~/~/ Имя
164 "position": "" , ~/~/ Должность
165 "phone": "" , ~/~/ Телефон
166 "organization": "" , ~/~/ Организация
167 "login": "" , ~/~/ Логин
168 "password": "" , ~/~/ Пароль
169 "email": "" , ~/~/ Email
170 "description": "" , ~/~/ Описание
171 "isEnabled": "" , ~/~/ Признак включения
172 "parentId": "" , ~/~/ Guid родительского агента
173 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 "kind": "" , ~/~/ тип аутентификации
176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178
179 (% style="text-align:left" %)
180 (% style="color:#000000; font-weight:normal" %)}
181
182
183 (% class="box successmessage" %)
184 (((
185 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 )))
187
188 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189
190 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191
192 (% style="color:#000000" %)Метод запроса: **POST**
193
194 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
195
196 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
197
198 (% style="color:#000000" %)Параметры в теле запроса (JSON):
199
200 (% style="color:#000000" %){
201
202 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206
207 (% style="color:#000000" %)}
208
209 (% style="color:#000000" %)Ответ:
210
211 (% style="color:#000000" %){         (%%)
212
213 "id": "" , ~/~/ идентификатор пользователя
214 "lastName": "" , ~/~/ фамилия
215 "firstName": "" , ~/~/ имя
216 "position": "" , ~/~/ должность
217 "phone": "" , ~/~/ телефон
218 "parentId": "" , ~/~/ идентификатор клиента-родителя
219 "parentName": "" , ~/~/ наименование клиента-родителя
220 "organization": "" , ~/~/ организация
221 "login": "" , ~/~/ логин
222 "email": "" , ~/~/ E-mail
223 "sessionDuration":"", ~/~/ длительность сессии в минутах
224 "status": "1",  ~/~/ статус пользователя
225 "astLogged": "", ~/~/ дата/время последней авторизации
226
227 (% style="color:#000000" %)}
228
229
230 (% class="box successmessage" %)
231 (((
232 (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 )))
234
235 (% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236
237 (% style="color:#000000" %)Метод запроса: **GET**
238
239 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240
241 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242
243 (% style="color:#000000" %)Ответ:
244
245 (((
246 (((
247 {
248 "id": "", ~/~/ GUID пользователя
249 "lastName": "", ~/~/ Фамилия 
250 "firstName": "", ~/~/ Имя
251 "position": "", ~/~/ Должность
252 "phone": "", ~/~/ Номер телефона
253 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
254 "parentName": "", Наименование клиента, которому принадлежит пользователь
255 "organization": "", ~/~/ Организация
256 "login": "", ~/~/ Логин пользователя
257 "email": "", ~/~/ Адрес электронной почты
258 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
259 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
260 "description": "", ~/~/ Описание
261 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
262 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
263 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
264 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
265 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
266 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
267 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
268 "groups": [], ~/~/ Список ролей пользователя
269 "customGroups": [], ~/~/ Список клиентских ролей пользователя
270 "authDevices": [ ], ~/~/ Список авторизованных устройств
271 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
272 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
273 }
274 )))
275 )))
276
277
278 (% class="box warningmessage" %)
279 (((
280 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
281 )))
282
283 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
284
285 (% style="color:#000000" %)Метод запроса: **PUT**
286
287 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
288
289 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290
291 **При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292
293 (% lang="en-US" style="text-align:left" %)
294 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
295
296 (% lang="en-US" style="text-align:left" %)
297 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
298
299 (% lang="en-US" style="text-align:left" %)
300 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
301 "lastName": "" , ~/~/ фамилия
302 "firstName": "" , ~/~/ имя
303 "position": "" , ~/~/ должность
304 "phone": "" , ~/~/ телефон
305 "organization": "" , ~/~/ организация
306 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
307 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
308 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
309 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
310 "isEnabled": "" , ~/~/ признак включения
311 "parentId": "" , ~/~/ Guid родительского агента
312 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
313 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
314 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
315 "kind": "" , ~/~/ тип аутентификации
316 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
317 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
318
319 (% lang="en-US" style="text-align:left" %)
320 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
321
322 (% lang="en-US" style="text-align:left" %)
323 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
324
325 (% lang="en-US" style="text-align:left" %)
326 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
327
328 (% lang="en-US" style="text-align:left" %)
329 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
330 "lastName": "" , ~/~/ фамилия
331 "firstName": "" , ~/~/ имя
332 "position": "" , ~/~/ должность
333 "phone": "" , ~/~/ телефон
334 "organization": "" , ~/~/ организация
335 "login": "" , ~/~/ логин
336 "password": "" , ~/~/ пароль 
337 "email": "" , ~/~/ email
338 "description": "" , ~/~/ описание
339 "isEnabled": "" , ~/~/ признак включения
340 "parentId": "" , ~/~/ Guid родительского агента
341 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
342 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
343 "kind": "" , ~/~/ тип аутентификации
344 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
345 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
346
347 (% lang="en-US" style="text-align:left" %)
348 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
349
350
351 (% class="box warningmessage" %)
352 (((
353 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
354 )))
355
356 (% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
357
358 (% style="color:#000000" %)Метод запроса: **PUT**
359
360 (% 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}
361
362 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
363
364 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
365
366 (% style="color:#000000" %)Параметры в теле запроса (JSON):
367
368 (% style="color:#000000" %){
369
370 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
371 "description": "" , ~/~/ описание
372 "data": "" , ~/~/ данные, связанные со сменой статуса
373
374 (% style="color:#000000" %)}
375
376 (% style="text-align:left" %)
377 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
378
379
380 (% class="box warningmessage" %)
381 (((
382 **Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
383 )))
384
385 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
386
387 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
388
389 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
390
391 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
392
393 [ 
394 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
395 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
396 ]
397
398 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
399
400
401 (% class="box warningmessage" %)
402 (((
403 **Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
404 )))
405
406 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
407
408 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
409
410 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
411
412 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
413
414 [ 
415 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
416 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
417 ]
418
419 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
420 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
421
422 (((
423 В теле ответа:
424 {
425 "errorMessages": [
426 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
427 ],
428 "users": [
429 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
430 ]
431 }
432 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 "users" - массив id пользователей, которых не удалось включить или отключить.
434
435 )))
436
437 (% class="box errormessage" %)
438 (((
439 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
440 )))
441
442 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
443
444 (% style="color:#000000" %)Метод запроса: **DELETE**
445
446 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
447
448 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
449
450 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
451
452 (% style="text-align:left" %)
453 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
454
455
456 (% class="box" style="text-align: center;" %)
457 (((
458 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
459 )))
460
461 (% class="box infomessage" %)
462 (((
463 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
464 )))
465
466 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
467
468 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
469
470 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
471
472 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
473
474 (% style="color:#000000" %)Метод запроса: **GET**
475
476 (% 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>
477
478 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
479
480 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
481
482 (% style="color:#000000" %)Ответ:
483
484 (((
485 {
486 "vehicleId": "", ~/~/ ID объекта
487 "name": "", ~/~/ Имя объекта
488 "imei": "", ~/~/ IMEI объекта
489 "deviceTypeId": , ~/~/ ID типа устройства
490 "deviceTypeName": "", ~/~/ Название типа устройства
491 "sim1": "", ~/~/ Номер SIM1
492 "parentId": "", Номер SIM2
493 "parentName": "", Наименование клиента-родителя
494 "modelId": "", ID модели объекта
495 "modelName": "", Имя модели объекта
496 "createdAt": "", Дата создания объекта
497 "mileageCalcMethod": "", Выбранный метод расчета пробега
498 "counters": { ~/~/ Нормы
499 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
500 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
501 "mileage": "", ~/~/ Пробег по нормам в метрах
502 "motohours": "" ~/~/ Моточасы по нормам, в секундах
503 },
504 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
505 {
506 "id": "", ~/~/ ID  задания
507 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
508 "name": "", ~/~/ Наименование задания
509 "description": "", ~/~/ Описание задания
510 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
511 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
512 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
513 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
514 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
515 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
516 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
517 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
518 }
519 ]
520 }
521 )))
522
523 (% style="text-align:left" %)
524 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
525
526 (% style="text-align:left" %)
527 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
528
529
530 (% class="box successmessage" %)
531 (((
532 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
533 )))
534
535 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
536
537 (% style="color:#000000" %)Метод запроса: **POST**
538
539 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
540
541 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
542
543 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
544
545 (% style="color:#000000" %){
546
547 "parentId": "" , ~/~/ ID клиента
548 "name": "" , ~/~/ имя ТС
549 "imei": "" , ~/~/ IMEI
550 "deviceTypeId": "" , ~/~/ ID типа устройства
551 "modelId": "" , ~/~/ ID модели
552 "unitId": "" , ~/~/ ID подразделения
553 "sim1": "" , ~/~/ Номер SIM 1
554 "sim2": "" , ~/~/ Номер SIM2
555 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
556 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
557 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
558 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
559 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
560 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
561 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
562 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
563 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
564 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
565 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
566 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
567 "counters": ~/~/ счетчики
568 {
569 "mileage": "" , ~/~/ пробег
570 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
571 "motohours": "" , ~/~/ моточасы
572 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
573 },
574 "cmsv6Parameters": { ~/~/ параметры CMSv6
575 "enabled": true, ~/~/ флаг включения
576 "id": "" , ~/~/ идентификатор
577 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
578 "login": "" , ~/~/ имя учетной записи
579 "password": "" ~/~/ пароль учетной записи
580 },
581 "inspectionTasks": ~/~/ задания на ТО
582 {
583 "enabled": "" , ~/~/ Признак включения
584 "name": "" , ~/~/ Имя задания
585 "description": "" , ~/~/ Описание задания
586 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
587 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
588 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
589 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
590 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
591 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
592 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
593 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
594 }
595
596 (% style="color:#000000" %) }
597
598 (% style="color:#000000" %)Ответ:
599
600 (% style="color:#000000" %){
601
602 "vehicleId": "", ~/~/ID ТС 
603 "parentId": "", ~/~/Guid владельца ТС
604 "name": "", ~/~/Имя объекта
605 "imei": "", ~/~/IMEI
606 "deviceTypeId": "", ~/~/ID типа устройства
607 "modelId": "", ~/~/ID модели
608 "unitId": "", ~/~/ID подразделения
609 "sim1": "", ~/~/SIM1
610 "sim2": "", ~/~/SIM2
611 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
612 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
613 "counters": { ~/~/Счётчики
614 "mileageEnabled": true,
615 "motohoursEnabled": true,
616 "mileage": "",
617 "motohours": 345.0
618 },
619 "cmsv6Parameters": { ~/~/Параметры CmsV6
620 "id": null,
621 "enabled": true, ~/~/флаг включения
622 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
623 "login": "", ~/~/ имя учетной записи
624 "password": "" ~/~/ пароль учетной записи
625 },
626 "inspectionTasks": { ~/~/ задания на ТО
627 "id": "", ~/~/ ID задачи
628 "enabled": false, ~/~/ Признак включения
629 "name": "", ~/~/ Имя задания
630 "description": "", ~/~/ Описание задания
631 "mileageCondition": "", ~/~/ Условие по пробегу
632 "lastMileage": "", ~/~/ Пробег (в метрах)
633 "motohoursCondition": "", ~/~/ Условие по моточасам
634 "lastMotohours": "", ~/~/ Моточасы
635 "periodicCondition": "", ~/~/ Условие периодичности по времени
636 "kind": "", ~/~/ Вид периодичности по времени 
637 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
638 }
639
640 (% style="text-align:left" %)
641 (% style="color:#000000" %)}
642
643 **Валидация:**
644 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
645 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
646 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
647
648
649 (% class="box successmessage" %)
650 (((
651 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
652 )))
653
654 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
655
656 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
657
658 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
659
660 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
661
662 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
663
664 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
665
666 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
667
668 (% style="color:#000000" %)Метод запроса: **POST**
669
670 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
671
672 (% style="color:#000000" %)В заголовках запроса:
673
674 (% style="color:#000000" %)− Content-Type: __**application/json**__
675
676 (% style="color:#000000" %)− X-Auth: Токен авторизации
677
678 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
679
680 (% style="color:#000000" %)Параметры в теле запроса (JSON):
681
682 {
683 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
684 "name": null, ~/~/ Имя ТС (string, опционально)
685 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
686 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
687 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
688 "parentId": null, ~/~/ ID клиента (Guid, опционально)
689 "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
690 "customFields": null ~/~/ значение любого из произвольных полей ТС
691 }
692
693 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
694
695 (% style="color:#000000" %)Ответ:
696
697 (% style="color:#000000" %){
698
699 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
700 "name": "" ~/~/ наименование объекта
701 "imei": "" ~/~/ IMEI объекта
702 "deviceTypeId": "" ~/~/ идентификатор типа устройства
703 "deviceTypeName": "" ~/~/ наименование типа устройства
704 "sim1": "" ~/~/ первый номер телефона
705 "sim2": "" ~/~/ второй номер телефона
706 "parentId": "" ~/~/ идентификатор клиента-родителя
707 "parentName": "" ~/~/ наименование клиента-родителя
708 "modelId": "" ~/~/ идентификатор модели объекта
709 "modelName": "" ~/~/ наименование модели объекта
710 "unitId": "" ~/~/ идентификатор подразделения
711 "unitName": "" ~/~/ наименование подразделения
712 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
713 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
714 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
715 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
716 (% style="color:#000000" %)}
717
718 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
719
720
721 (% class="box successmessage" %)
722 (((
723 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
724 )))
725
726 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
727
728 (% style="color:#000000" %)Метод запроса: **POST**
729
730 (% 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}
731
732 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
733
734 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
735
736 (% style="color:#000000" %)Параметры в теле запроса (JSON):
737
738 (% style="color:#000000" %){
739
740 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
741 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
742 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
743 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
744 "description": "", ~/~/ Описание
745 "data": "", ~/~/ Данные
746 "overwrite": false, ~/~/ Флаг перезаписи
747 "stage": "", ~/~/ Состояние, может быть null
748
749 (% style="color:#000000" %)}
750
751 (% style="color:#000000" %)Ответ:
752
753 (% style="color:#000000" %){
754
755 "status": "", ~/~/ значение статуса
756 "date": "", ~/~/ Дата смены статуса 
757 "description": "", ~/~/ Описание
758 "data": "", ~/~/ Данные
759 "overwrite": false, ~/~/ Флаг перезаписи
760 "stage": "", ~/~/ Состояние
761
762 (% style="text-align:left" %)
763 (% style="color:#000000" %) }
764
765
766 (% class="box warningmessage" %)
767 (((
768 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
769 )))
770
771 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
772
773 (% style="color:#000000" %)Метод запроса: **PUT**
774
775 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
776
777 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
778
779 (% style="color:#000000" %)Параметры в теле запроса (JSON):
780
781 (% style="color:#000000" %){    
782
783 (((
784 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
785 "parentId": "", ~/~/ ID клиента
786 "name": "", ~/~/ имя ТС
787 "imei": "", ~/~/ IMEI
788 "deviceTypeId": "", ~/~/ ID типа устройства
789 "modelId": "", ~/~/ , ID модели    
790 "unitId": "", ~/~/ подразделения
791 "sim1": "", ~/~/ SIM 1
792 "sim2": "", ~/~/ SIM2     (%%)
793 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
794 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
795 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
796 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
797 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
798 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
799 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
800 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
801 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
802 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
803 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
804 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
805 (% style="color:#000000" %) "counters": 
806 {
807 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
808 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
809 "mileage": "", ~/~/ пробег, в метрах 
810 "motohours": "" ~/~/ моточасы, в секундах
811 }
812 "cmsv6Parameters": ~/~/ параметры CMSv6
813 {       
814 "id": "", ~/~/ идентификатор
815 "enabled": true, ~/~/ флаг включения
816 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
817 "login": "", ~/~/ имя учетной записи
818 "password": "", ~/~/ пароль учетной записи
819 }
820 "inspectionTasks": ~/~/ задания на ТО
821 {
822 "id": "", ~/~/ ID задания
823 "enabled": false, ~/~/ Признак включения
824 "name": "", ~/~/ Имя задания
825 "description": "", ~/~/ Описание задания
826 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
827 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
828 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
829 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
830 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
831 "kind": "", ~/~/ Вид периодичности по времени
832 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
833 } 
834 )))
835
836 (% style="color:#000000" %)}
837
838 (% style="color:#000000" %)Ответ:
839
840 (% lang="en-US" style="text-align:left" %)
841 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
842
843 (% lang="en-US" style="text-align:left" %)
844 "vehicleId": "", ~/~/ ID ТС
845 "parentId": "", ~/~/ ID клиента
846 "name": "", ~/~/ имя ТС
847 "imei": "", ~/~/ IMEI
848 "deviceTypeId": "", ~/~/ типа устройства
849 "modelId": "", ~/~/ ID модели
850 "unitId": "", ~/~/ ID подразделения
851 "sim1": "", ~/~/ SIM 1
852 "sim2": "", ~/~/ SIM2
853 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
854 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
855 "counters": 
856 {
857 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
858 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
859 "mileage": "", ~/~/ пробег
860 "motohours": "", ~/~/ моточасы
861 }
862 "cmsv6Parameters": ~/~/ параметры CMSv6
863 {
864 "id": ~/~/ идентификатор
865 "enabled": true, ~/~/ флаг включения
866 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
867 "login": "", ~/~/ имя учетной записи
868 "password": "", ~/~/ пароль учетной записи
869 }
870 "inspectionTasks": ~/~/ задания на ТО
871 {
872 "id": "", ~/~/ ID задания
873 "enabled": false, ~/~/ Признак включения
874 "name": "", ~/~/ Имя задания
875 "description": "", ~/~/ Описание задания
876 "mileageCondition": "", ~/~/ Условие по пробегу
877 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
878 "motohoursCondition": "", ~/~/ Условие по моточасам
879 "lastMotohours": "", ~/~/ Моточасы
880 "periodicCondition": "", ~/~/ Условие периодичности по времени
881 "kind": "", ~/~/ Вид периодичности по времени
882 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
883 }
884
885 (% lang="en-US" style="text-align:left" %)
886 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
887
888 **валидация:**
889 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
890 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
891 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
892
893
894 (% class="box errormessage" %)
895 (((
896 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
897 )))
898
899 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
900
901 (% style="color:#000000" %)Метод запроса: **DELETE**
902
903 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
904
905 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
906
907 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
908
909 (% style="text-align:left" %)
910 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
911
912
913 (% class="box" lang="en-US" style="text-align: center;" %)
914 (((
915 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
916 )))
917
918 (% class="box infomessage" %)
919 (((
920 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
921 )))
922
923 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
924
925 (% style="color:#000000" %)Метод запроса: **GET**
926
927 (% 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]]
928
929 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
930
931 (% style="color:#000000" %)Ответ:
932
933 (% style="color:#000000" %){
934
935 "deviceTypeId" : "", ~/~/ ID типа устройства
936 "deviceTypeName" : "" ~/~/ Название типа устройства
937
938 (% style="text-align:left" %)
939 (% style="color:#000000" %)}
940
941
942 (% class="box" style="text-align: center;" %)
943 (((
944 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
945 )))
946
947 (% class="box infomessage" %)
948 (((
949 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
950 )))
951
952 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
953
954 (% style="color:#000000" %)Метод запроса: **GET**
955
956 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
957
958 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
959
960 (% style="color:#000000" %)Ответ:
961
962 (% style="color:#000000" %){
963
964 "id": "", ~/~/ ID типа датчика 
965 "name": "", ~/~/ Название
966 "description": "", ~/~/ Описание
967
968 (% style="text-align:left" %)
969 (% style="color:#000000" %)}
970
971
972 (% class="box" lang="en-US" style="text-align: center;" %)
973 (((
974 (% 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]] **
975 )))

Меню

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