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

Меню

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