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": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если 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": "" , ~/~/ группы пользователя, названия групп
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": "" , ~/~/ группы пользователя, «user» названия группы пользователя
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 (% style="color:#000000" %){
433
434 "vehicleId": "" , ~/~/ идентификатор объекта
435 "name": "" , ~/~/ имя объекта
436 "imei": "" , ~/~/ IMEI объекта
437 "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
438 "deviceTypeName": "" , ~/~/ наименование устройства объекта
439 "parentId": "" , ~/~/ идентификатор клиента-родителя
440 "parentName": "" , ~/~/ наименование клиента-родителя,
441 "modelId": "" , ~/~/ идентификатор модели объекта
442 "modelName": "" , ~/~/ наименование модели объекта,
443 "unitId": "" , ~/~/ идентификатор подразделения
444 "unitName": "" , ~/~/ наименование подразделения
445 "status": "" , ~/~/ статус объекта
446
447 }
448
449 (% style="text-align:left" %)
450 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
451
452 (% style="text-align:left" %)
453 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
454
455
456 (% class="box successmessage" %)
457 (((
458 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
459 )))
460
461 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
462
463 (% style="color:#000000" %)Метод запроса: **POST**
464
465 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
466
467 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
468
469 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
470
471 (% style="color:#000000" %){
472
473 "parentId": "" , ~/~/ ID клиента
474 "name": "" , ~/~/ имя ТС
475 "imei": "" , ~/~/ IMEI
476 "deviceTypeId": "" , ~/~/ ID типа устройства
477 "modelId": "" , ~/~/ ID модели
478 "unitId": "" , ~/~/ ID подразделения
479 "sim1": "" , ~/~/ Номер SIM 1
480 "sim2": "" , ~/~/ Номер SIM2
481 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
482 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
483 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
484 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
485 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
486 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
487 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
488 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
489 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
490 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
491 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
492 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
493 "counters": ~/~/ счетчики
494 {
495 "mileage": "" , ~/~/ пробег
496 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
497 "motohours": "" , ~/~/ моточасы
498 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
499 },
500 "cmsv6Parameters": { ~/~/ параметры CMSv6
501 "enabled": true, ~/~/ флаг включения
502 "id": "" , ~/~/ идентификатор
503 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
504 "login": "" , ~/~/ имя учетной записи
505 "password": "" ~/~/ пароль учетной записи
506 },
507 "inspectionTasks": ~/~/ задания на ТО
508 {
509 "enabled": "" , ~/~/ Признак включения
510 "name": "" , ~/~/ Имя задания
511 "description": "" , ~/~/ Описание задания
512 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
513 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
514 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
515 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
516 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
517 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
518 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
519 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
520 }
521
522 (% style="color:#000000" %) }
523
524 (% style="color:#000000" %)Ответ:
525
526 (% style="color:#000000" %){
527
528 "vehicleId": "", ~/~/ID ТС 
529 "parentId": "", ~/~/Guid владельца ТС
530 "name": "", ~/~/Имя объекта
531 "imei": "", ~/~/IMEI
532 "deviceTypeId": "", ~/~/ID типа устройства
533 "modelId": "", ~/~/ID модели
534 "unitId": "", ~/~/ID подразделения
535 "sim1": "", ~/~/SIM1
536 "sim2": "", ~/~/SIM2
537 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
538 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
539 "counters": { ~/~/Счётчики
540 "mileageEnabled": true,
541 "motohoursEnabled": true,
542 "mileage": "",
543 "motohours": 345.0
544 },
545 "cmsv6Parameters": { ~/~/Параметры CmsV6
546 "id": null,
547 "enabled": true, ~/~/флаг включения
548 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
549 "login": "", ~/~/ имя учетной записи
550 "password": "" ~/~/ пароль учетной записи
551 },
552 "inspectionTasks": { ~/~/ задания на ТО
553 "id": "", ~/~/ ID задачи
554 "enabled": false, ~/~/ Признак включения
555 "name": "", ~/~/ Имя задания
556 "description": "", ~/~/ Описание задания
557 "mileageCondition": "", ~/~/ Условие по пробегу
558 "lastMileage": "", ~/~/ Пробег (в метрах)
559 "motohoursCondition": "", ~/~/ Условие по моточасам
560 "lastMotohours": "", ~/~/ Моточасы
561 "periodicCondition": "", ~/~/ Условие периодичности по времени
562 "kind": "", ~/~/ Вид периодичности по времени 
563 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
564 }
565
566 (% style="text-align:left" %)
567 (% style="color:#000000" %)}
568
569 **Валидация:**
570 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
571 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
572 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
573
574
575 (% class="box successmessage" %)
576 (((
577 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
578 )))
579
580 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
581
582 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
583
584 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
585
586 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
587
588 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
589
590 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
591
592 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
593
594 (% style="color:#000000" %)Метод запроса: **POST**
595
596 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
597
598 (% style="color:#000000" %)В заголовках запроса:
599
600 (% style="color:#000000" %)− Content-Type: __**application/json**__
601
602 (% style="color:#000000" %)− X-Auth: Токен авторизации
603
604 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
605
606 (% style="color:#000000" %)Параметры в теле запроса (JSON):
607
608 (% class="western" style="color:#000000" %)##{##
609
610 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
611 "name": null, ~/~/ Имя ТС (string, опционально) 
612 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
613 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
614 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
615 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
616 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
617 (% style="color:#000000" %)}
618
619 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
620
621 (% style="color:#000000" %)Ответ:
622
623 (% style="color:#000000" %){
624
625 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
626 "name": "" ~/~/ наименование объекта
627 "imei": "" ~/~/ IMEI объекта
628 "deviceTypeId": "" ~/~/ идентификатор типа устройства
629 "deviceTypeName": "" ~/~/ наименование типа устройства
630 "sim1": "" ~/~/ первый номер телефона
631 "sim2": "" ~/~/ второй номер телефона
632 "parentId": "" ~/~/ идентификатор клиента-родителя
633 "parentName": "" ~/~/ наименование клиента-родителя
634 "modelId": "" ~/~/ идентификатор модели объекта
635 "modelName": "" ~/~/ наименование модели объекта
636 "unitId": "" ~/~/ идентификатор подразделения
637 "unitName": "" ~/~/ наименование подразделения
638 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
639 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
640 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
641 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
642 (% style="color:#000000" %)}
643
644 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
645
646
647 (% class="box successmessage" %)
648 (((
649 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
650 )))
651
652 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
653
654 (% style="color:#000000" %)Метод запроса: **POST**
655
656 (% 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}
657
658 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
659
660 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
661
662 (% style="color:#000000" %)Параметры в теле запроса (JSON):
663
664 (% style="color:#000000" %){
665
666 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
667 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
668 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
669 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
670 "description": "", ~/~/ Описание
671 "data": "", ~/~/ Данные
672 "overwrite": false, ~/~/ Флаг перезаписи
673 "stage": "", ~/~/ Состояние, может быть null
674
675 (% style="color:#000000" %)}
676
677 (% style="color:#000000" %)Ответ:
678
679 (% style="color:#000000" %){
680
681 "status": "", ~/~/ значение статуса
682 "date": "", ~/~/ Дата смены статуса 
683 "description": "", ~/~/ Описание
684 "data": "", ~/~/ Данные
685 "overwrite": false, ~/~/ Флаг перезаписи
686 "stage": "", ~/~/ Состояние
687
688 (% style="text-align:left" %)
689 (% style="color:#000000" %) }
690
691
692 (% class="box warningmessage" %)
693 (((
694 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
695 )))
696
697 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
698
699 (% style="color:#000000" %)Метод запроса: **PUT**
700
701 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
702
703 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
704
705 (% style="color:#000000" %)Параметры в теле запроса (JSON):
706
707 (% style="color:#000000" %){    
708
709 (((
710 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
711 "parentId": "", ~/~/ ID клиента
712 "name": "", ~/~/ имя ТС
713 "imei": "", ~/~/ IMEI
714 "deviceTypeId": "", ~/~/ ID типа устройства
715 "modelId": "", ~/~/ , ID модели    
716 "unitId": "", ~/~/ подразделения
717 "sim1": "", ~/~/ SIM 1
718 "sim2": "", ~/~/ SIM2     (%%)
719 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
720 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
721 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
722 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
723 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
724 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
725 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
726 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
727 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
728 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
729 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
730 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
731 (% style="color:#000000" %) "counters": 
732 {
733 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
734 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
735 "mileage": "", ~/~/ пробег, в метрах 
736 "motohours": "" ~/~/ моточасы, в секундах
737 }
738 "cmsv6Parameters": ~/~/ параметры CMSv6
739 {       
740 "id": "", ~/~/ идентификатор
741 "enabled": true, ~/~/ флаг включения
742 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
743 "login": "", ~/~/ имя учетной записи
744 "password": "", ~/~/ пароль учетной записи
745 }
746 "inspectionTasks": ~/~/ задания на ТО
747 {
748 "id": "", ~/~/ ID задания
749 "enabled": false, ~/~/ Признак включения
750 "name": "", ~/~/ Имя задания
751 "description": "", ~/~/ Описание задания
752 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
753 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
754 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
755 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
756 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
757 "kind": "", ~/~/ Вид периодичности по времени
758 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
759
760 )))
761
762 (% style="color:#000000" %)}
763
764 (% style="color:#000000" %)Ответ:
765
766 (% lang="en-US" style="text-align:left" %)
767 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
768
769 (% lang="en-US" style="text-align:left" %)
770 "vehicleId": "", ~/~/ ID ТС
771 "parentId": "", ~/~/ ID клиента
772 "name": "", ~/~/ имя ТС
773 "imei": "", ~/~/ IMEI
774 "deviceTypeId": "", ~/~/ типа устройства
775 "modelId": "", ~/~/ ID модели
776 "unitId": "", ~/~/ ID подразделения
777 "sim1": "", ~/~/ SIM 1
778 "sim2": "", ~/~/ SIM2
779 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
780 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
781 "counters": 
782 {
783 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
784 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
785 "mileage": "", ~/~/ пробег
786 "motohours": "", ~/~/ моточасы
787 }
788 "cmsv6Parameters": ~/~/ параметры CMSv6
789 {
790 "id": ~/~/ идентификатор
791 "enabled": true, ~/~/ флаг включения
792 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
793 "login": "", ~/~/ имя учетной записи
794 "password": "", ~/~/ пароль учетной записи
795 }
796 "inspectionTasks": ~/~/ задания на ТО
797 {
798 "id": "", ~/~/ ID задания
799 "enabled": false, ~/~/ Признак включения
800 "name": "", ~/~/ Имя задания
801 "description": "", ~/~/ Описание задания
802 "mileageCondition": "", ~/~/ Условие по пробегу
803 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
804 "motohoursCondition": "", ~/~/ Условие по моточасам
805 "lastMotohours": "", ~/~/ Моточасы
806 "periodicCondition": "", ~/~/ Условие периодичности по времени
807 "kind": "", ~/~/ Вид периодичности по времени
808 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
809 }
810
811 (% lang="en-US" style="text-align:left" %)
812 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
813
814 **валидация:**
815 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
816 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
817 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
818
819
820 (% class="box errormessage" %)
821 (((
822 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
823 )))
824
825 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
826
827 (% style="color:#000000" %)Метод запроса: **DELETE**
828
829 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
830
831 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
832
833 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
834
835 (% style="text-align:left" %)
836 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
837
838
839 (% class="box" lang="en-US" style="text-align: center;" %)
840 (((
841 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
842 )))
843
844 (% class="box infomessage" %)
845 (((
846 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
847 )))
848
849 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
850
851 (% style="color:#000000" %)Метод запроса: **GET**
852
853 (% 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]]
854
855 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
856
857 (% style="color:#000000" %)Ответ:
858
859 (% style="color:#000000" %){
860
861 "deviceTypeId" : "", ~/~/ ID типа устройства
862 "deviceTypeName" : "" ~/~/ Название типа устройства
863
864 (% style="text-align:left" %)
865 (% style="color:#000000" %)}
866
867
868 (% class="box" style="text-align: center;" %)
869 (((
870 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
871 )))
872
873 (% class="box infomessage" %)
874 (((
875 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
876 )))
877
878 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
879
880 (% style="color:#000000" %)Метод запроса: **GET**
881
882 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
883
884 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
885
886 (% style="color:#000000" %)Ответ:
887
888 (% style="color:#000000" %){
889
890 "id": "", ~/~/ ID типа датчика 
891 "name": "", ~/~/ Название
892 "description": "", ~/~/ Описание
893
894 (% style="text-align:left" %)
895 (% style="color:#000000" %)}
896
897
898 (% class="box" lang="en-US" style="text-align: center;" %)
899 (((
900 (% 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]] **
901 )))

Меню

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