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