Версия 39.1 от Илья Крайнов на 2022/11/17 14:50
Последние авторы
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": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
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 warningmessage" %)
231 (((
232 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
233 )))
234
235 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
236
237 (% style="color:#000000" %)Метод запроса: **PUT**
238
239 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
240
241 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242
243 (% lang="en-US" style="text-align:left" %)
244 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245
246 (% lang="en-US" style="text-align:left" %)
247 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
248
249 (% lang="en-US" style="text-align:left" %)
250 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 "lastName": "" , ~/~/ фамилия
252 "firstName": "" , ~/~/ имя
253 "position": "" , ~/~/ должность
254 "phone": "" , ~/~/ телефон
255 "organization": "" , ~/~/ организация
256 "login": "" , ~/~/ логин
257 "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 "email": "" , ~/~/ email
259 "description": "" , ~/~/ описание
260 "isEnabled": "" , ~/~/ признак включения
261 "parentId": "" , ~/~/ Guid родительского агента
262 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 "kind": "" , ~/~/ тип аутентификации
266 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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" %)//Ответ~://
274
275 (% lang="en-US" style="text-align:left" %)
276 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
277
278 (% lang="en-US" style="text-align:left" %)
279 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
280 "lastName": "" , ~/~/ фамилия
281 "firstName": "" , ~/~/ имя
282 "position": "" , ~/~/ должность
283 "phone": "" , ~/~/ телефон
284 "organization": "" , ~/~/ организация
285 "login": "" , ~/~/ логин
286 "password": "" , ~/~/ пароль 
287 "email": "" , ~/~/ email
288 "description": "" , ~/~/ описание
289 "isEnabled": "" , ~/~/ признак включения
290 "parentId": "" , ~/~/ Guid родительского агента
291 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 "kind": "" , ~/~/ тип аутентификации
294 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
296
297 (% lang="en-US" style="text-align:left" %)
298 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299
300
301 (% class="box warningmessage" %)
302 (((
303 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 )))
305
306 (% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307
308 (% style="color:#000000" %)Метод запроса: **PUT**
309
310 (% 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}
311
312 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
313
314 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
315
316 (% style="color:#000000" %)Параметры в теле запроса (JSON):
317
318 (% style="color:#000000" %){
319
320 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 "description": "" , ~/~/ описание
322 "data": "" , ~/~/ данные, связанные со сменой статуса
323
324 (% style="color:#000000" %)}
325
326 (% style="text-align:left" %)
327 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328
329
330 (% class="box warningmessage" %)
331 (((
332 **Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
333 )))
334
335 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
336
337 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
338
339 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
340
341 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
342
343 [ 
344 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
345 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
346 ]
347
348 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
349
350
351 (% class="box warningmessage" %)
352 (((
353 **Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
354 )))
355
356 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
357
358 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
359
360 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
361
362 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
363
364 [ 
365 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
366 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 ]
368
369 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
370 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
371
372 В теле ответа:
373 {
374 "errorMessages": [
375 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
376 ],
377 "users": [
378 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
379 ]
380 }
381 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
382 "users" - массив id пользователей, которых не удалось включить или отключить.
383
384
385 (% class="box errormessage" %)
386 (((
387 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
388 )))
389
390 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
391
392 (% style="color:#000000" %)Метод запроса: **DELETE**
393
394 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
395
396 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
397
398 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
399
400 (% style="text-align:left" %)
401 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
402
403
404 (% class="box" style="text-align: center;" %)
405 (((
406 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
407 )))
408
409 (% class="box infomessage" %)
410 (((
411 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
412 )))
413
414 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
415
416 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
417
418 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
419
420 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
421
422 (% style="color:#000000" %)Метод запроса: **GET**
423
424 (% 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>
425
426 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
427
428 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
429
430 (% style="color:#000000" %)Ответ:
431
432 {
433
434 "vehicleId": "", ~/~/ ID объекта
435
436 "name": "", ~/~/ Имя объекта
437
438 "imei": "", ~/~/ IMEI объекта
439
440 "deviceTypeId": , ~/~/ ID типа устройства
441
442 "deviceTypeName": "", ~/~/ Название типа устройства
443
444 "sim1": "", ~/~/ Номер SIM1
445
446 "parentId": "", Номер SIM2
447
448 "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449
450 "modelId": "", ID модели объекта
451
452 "modelName": "", Имя модели объекта
453
454 "createdAt": "", Дата создания объекта
455
456 "mileageCalcMethod": "", Выбранный метод расчета пробега
457
458 "counters": { ~/~/ Нормы
459
460 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461
462 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463
464 "mileage": "", ~/~/ Пробег по нормам в метрах
465
466 "motohours": "" ~/~/ Моточасы по нормам, в секундах
467
468 },
469
470 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471
472 {
473
474 "id": "", ~/~/ ID  задания
475
476 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477
478 "name": "", ~/~/ Наименование задания
479
480 "description": "", ~/~/ Описание задания
481
482 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483
484 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485
486 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487
488 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489
490 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491
492 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493
494 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495
496 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497
498 }
499
500 ]
501
502 }
503
504 (% style="text-align:left" %)
505 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
506
507 (% style="text-align:left" %)
508 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
509
510
511 (% class="box successmessage" %)
512 (((
513 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
514 )))
515
516 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
517
518 (% style="color:#000000" %)Метод запроса: **POST**
519
520 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
521
522 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
523
524 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
525
526 (% style="color:#000000" %){
527
528 "parentId": "" , ~/~/ ID клиента
529 "name": "" , ~/~/ имя ТС
530 "imei": "" , ~/~/ IMEI
531 "deviceTypeId": "" , ~/~/ ID типа устройства
532 "modelId": "" , ~/~/ ID модели
533 "unitId": "" , ~/~/ ID подразделения
534 "sim1": "" , ~/~/ Номер SIM 1
535 "sim2": "" , ~/~/ Номер SIM2
536 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
537 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
538 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
539 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
540 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
541 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
542 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
543 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
544 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
545 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
546 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
547 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
548 "counters": ~/~/ счетчики
549 {
550 "mileage": "" , ~/~/ пробег
551 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
552 "motohours": "" , ~/~/ моточасы
553 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
554 },
555 "cmsv6Parameters": { ~/~/ параметры CMSv6
556 "enabled": true, ~/~/ флаг включения
557 "id": "" , ~/~/ идентификатор
558 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
559 "login": "" , ~/~/ имя учетной записи
560 "password": "" ~/~/ пароль учетной записи
561 },
562 "inspectionTasks": ~/~/ задания на ТО
563 {
564 "enabled": "" , ~/~/ Признак включения
565 "name": "" , ~/~/ Имя задания
566 "description": "" , ~/~/ Описание задания
567 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
568 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
569 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
570 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
571 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
572 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
573 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
574 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
575 }
576
577 (% style="color:#000000" %) }
578
579 (% style="color:#000000" %)Ответ:
580
581 (% style="color:#000000" %){
582
583 "vehicleId": "", ~/~/ID ТС 
584 "parentId": "", ~/~/Guid владельца ТС
585 "name": "", ~/~/Имя объекта
586 "imei": "", ~/~/IMEI
587 "deviceTypeId": "", ~/~/ID типа устройства
588 "modelId": "", ~/~/ID модели
589 "unitId": "", ~/~/ID подразделения
590 "sim1": "", ~/~/SIM1
591 "sim2": "", ~/~/SIM2
592 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
593 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
594 "counters": { ~/~/Счётчики
595 "mileageEnabled": true,
596 "motohoursEnabled": true,
597 "mileage": "",
598 "motohours": 345.0
599 },
600 "cmsv6Parameters": { ~/~/Параметры CmsV6
601 "id": null,
602 "enabled": true, ~/~/флаг включения
603 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
604 "login": "", ~/~/ имя учетной записи
605 "password": "" ~/~/ пароль учетной записи
606 },
607 "inspectionTasks": { ~/~/ задания на ТО
608 "id": "", ~/~/ ID задачи
609 "enabled": false, ~/~/ Признак включения
610 "name": "", ~/~/ Имя задания
611 "description": "", ~/~/ Описание задания
612 "mileageCondition": "", ~/~/ Условие по пробегу
613 "lastMileage": "", ~/~/ Пробег (в метрах)
614 "motohoursCondition": "", ~/~/ Условие по моточасам
615 "lastMotohours": "", ~/~/ Моточасы
616 "periodicCondition": "", ~/~/ Условие периодичности по времени
617 "kind": "", ~/~/ Вид периодичности по времени 
618 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
619 }
620
621 (% style="text-align:left" %)
622 (% style="color:#000000" %)}
623
624 **Валидация:**
625 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
626 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
627 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
628
629
630 (% class="box successmessage" %)
631 (((
632 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
633 )))
634
635 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
636
637 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
638
639 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
640
641 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
642
643 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
644
645 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
646
647 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
648
649 (% style="color:#000000" %)Метод запроса: **POST**
650
651 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
652
653 (% style="color:#000000" %)В заголовках запроса:
654
655 (% style="color:#000000" %)− Content-Type: __**application/json**__
656
657 (% style="color:#000000" %)− X-Auth: Токен авторизации
658
659 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
660
661 (% style="color:#000000" %)Параметры в теле запроса (JSON):
662
663 (% class="western" style="color:#000000" %)##{##
664
665 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 "name": null, ~/~/ Имя ТС (string, опционально) 
667 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 (% style="color:#000000" %)}
673
674 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
675
676 (% style="color:#000000" %)Ответ:
677
678 (% style="color:#000000" %){
679
680 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
681 "name": "" ~/~/ наименование объекта
682 "imei": "" ~/~/ IMEI объекта
683 "deviceTypeId": "" ~/~/ идентификатор типа устройства
684 "deviceTypeName": "" ~/~/ наименование типа устройства
685 "sim1": "" ~/~/ первый номер телефона
686 "sim2": "" ~/~/ второй номер телефона
687 "parentId": "" ~/~/ идентификатор клиента-родителя
688 "parentName": "" ~/~/ наименование клиента-родителя
689 "modelId": "" ~/~/ идентификатор модели объекта
690 "modelName": "" ~/~/ наименование модели объекта
691 "unitId": "" ~/~/ идентификатор подразделения
692 "unitName": "" ~/~/ наименование подразделения
693 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
694 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
695 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
696 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
697 (% style="color:#000000" %)}
698
699 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
700
701
702 (% class="box successmessage" %)
703 (((
704 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
705 )))
706
707 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
708
709 (% style="color:#000000" %)Метод запроса: **POST**
710
711 (% 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}
712
713 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
714
715 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
716
717 (% style="color:#000000" %)Параметры в теле запроса (JSON):
718
719 (% style="color:#000000" %){
720
721 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
722 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
723 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
724 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
725 "description": "", ~/~/ Описание
726 "data": "", ~/~/ Данные
727 "overwrite": false, ~/~/ Флаг перезаписи
728 "stage": "", ~/~/ Состояние, может быть null
729
730 (% style="color:#000000" %)}
731
732 (% style="color:#000000" %)Ответ:
733
734 (% style="color:#000000" %){
735
736 "status": "", ~/~/ значение статуса
737 "date": "", ~/~/ Дата смены статуса 
738 "description": "", ~/~/ Описание
739 "data": "", ~/~/ Данные
740 "overwrite": false, ~/~/ Флаг перезаписи
741 "stage": "", ~/~/ Состояние
742
743 (% style="text-align:left" %)
744 (% style="color:#000000" %) }
745
746
747 (% class="box warningmessage" %)
748 (((
749 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
750 )))
751
752 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
753
754 (% style="color:#000000" %)Метод запроса: **PUT**
755
756 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
757
758 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
759
760 (% style="color:#000000" %)Параметры в теле запроса (JSON):
761
762 (% style="color:#000000" %){    
763
764 (((
765 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
766 "parentId": "", ~/~/ ID клиента
767 "name": "", ~/~/ имя ТС
768 "imei": "", ~/~/ IMEI
769 "deviceTypeId": "", ~/~/ ID типа устройства
770 "modelId": "", ~/~/ , ID модели    
771 "unitId": "", ~/~/ подразделения
772 "sim1": "", ~/~/ SIM 1
773 "sim2": "", ~/~/ SIM2     (%%)
774 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
775 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
776 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
777 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
778 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
779 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
780 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
781 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
782 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
783 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
784 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
785 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
786 (% style="color:#000000" %) "counters": 
787 {
788 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
789 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
790 "mileage": "", ~/~/ пробег, в метрах 
791 "motohours": "" ~/~/ моточасы, в секундах
792 }
793 "cmsv6Parameters": ~/~/ параметры CMSv6
794 {       
795 "id": "", ~/~/ идентификатор
796 "enabled": true, ~/~/ флаг включения
797 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
798 "login": "", ~/~/ имя учетной записи
799 "password": "", ~/~/ пароль учетной записи
800 }
801 "inspectionTasks": ~/~/ задания на ТО
802 {
803 "id": "", ~/~/ ID задания
804 "enabled": false, ~/~/ Признак включения
805 "name": "", ~/~/ Имя задания
806 "description": "", ~/~/ Описание задания
807 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
808 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
809 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
810 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
811 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
812 "kind": "", ~/~/ Вид периодичности по времени
813 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
814 } 
815 )))
816
817 (% style="color:#000000" %)}
818
819 (% style="color:#000000" %)Ответ:
820
821 (% lang="en-US" style="text-align:left" %)
822 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
823
824 (% lang="en-US" style="text-align:left" %)
825 "vehicleId": "", ~/~/ ID ТС
826 "parentId": "", ~/~/ ID клиента
827 "name": "", ~/~/ имя ТС
828 "imei": "", ~/~/ IMEI
829 "deviceTypeId": "", ~/~/ типа устройства
830 "modelId": "", ~/~/ ID модели
831 "unitId": "", ~/~/ ID подразделения
832 "sim1": "", ~/~/ SIM 1
833 "sim2": "", ~/~/ SIM2
834 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
835 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
836 "counters": 
837 {
838 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
839 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
840 "mileage": "", ~/~/ пробег
841 "motohours": "", ~/~/ моточасы
842 }
843 "cmsv6Parameters": ~/~/ параметры CMSv6
844 {
845 "id": ~/~/ идентификатор
846 "enabled": true, ~/~/ флаг включения
847 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
848 "login": "", ~/~/ имя учетной записи
849 "password": "", ~/~/ пароль учетной записи
850 }
851 "inspectionTasks": ~/~/ задания на ТО
852 {
853 "id": "", ~/~/ ID задания
854 "enabled": false, ~/~/ Признак включения
855 "name": "", ~/~/ Имя задания
856 "description": "", ~/~/ Описание задания
857 "mileageCondition": "", ~/~/ Условие по пробегу
858 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
859 "motohoursCondition": "", ~/~/ Условие по моточасам
860 "lastMotohours": "", ~/~/ Моточасы
861 "periodicCondition": "", ~/~/ Условие периодичности по времени
862 "kind": "", ~/~/ Вид периодичности по времени
863 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
864 }
865
866 (% lang="en-US" style="text-align:left" %)
867 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
868
869 **валидация:**
870 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
871 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
872 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
873
874
875 (% class="box errormessage" %)
876 (((
877 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
878 )))
879
880 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881
882 (% style="color:#000000" %)Метод запроса: **DELETE**
883
884 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
885
886 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
887
888 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
889
890 (% style="text-align:left" %)
891 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
892
893
894 (% class="box" lang="en-US" style="text-align: center;" %)
895 (((
896 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
897 )))
898
899 (% class="box infomessage" %)
900 (((
901 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
902 )))
903
904 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
905
906 (% style="color:#000000" %)Метод запроса: **GET**
907
908 (% 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]]
909
910 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911
912 (% style="color:#000000" %)Ответ:
913
914 (% style="color:#000000" %){
915
916 "deviceTypeId" : "", ~/~/ ID типа устройства
917 "deviceTypeName" : "" ~/~/ Название типа устройства
918
919 (% style="text-align:left" %)
920 (% style="color:#000000" %)}
921
922
923 (% class="box" style="text-align: center;" %)
924 (((
925 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
926 )))
927
928 (% class="box infomessage" %)
929 (((
930 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
931 )))
932
933 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
934
935 (% style="color:#000000" %)Метод запроса: **GET**
936
937 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
938
939 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
940
941 (% style="color:#000000" %)Ответ:
942
943 (% style="color:#000000" %){
944
945 "id": "", ~/~/ ID типа датчика 
946 "name": "", ~/~/ Название
947 "description": "", ~/~/ Описание
948
949 (% style="text-align:left" %)
950 (% style="color:#000000" %)}
951
952
953 (% class="box" lang="en-US" style="text-align: center;" %)
954 (((
955 (% 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]] **
956 )))

Меню

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