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

Меню

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