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

Меню

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