Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.8 >
edited by Илья Крайнов
on 2022/11/24 13:33
To version < 91.1 >
edited by Илья Крайнов
on 2023/05/22 15:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,13 +1,14 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -= Описание ГЛОНАССSoft Public API 3.0 =
2 +(((
3 +**Содержание страницы:**
4 +)))
3 3  
4 -
5 5  {{toc/}}
6 6  
7 7  
8 8  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
9 9  
10 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 11  
12 12  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 13  
... ... @@ -15,10 +15,8 @@
15 15  
16 16  (% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
17 17  
18 -
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -
22 22  == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
23 23  
24 24  (% class="box infomessage" %)
... ... @@ -39,9 +39,9 @@
39 39  (% style="color:#000000" %){
40 40   "login": "testuser",
41 41   "password": "testuser"
42 -}(%%)
43 -
41 +}
44 44  
43 +
45 45  (% style="color:#000000" %)**Ответ:**
46 46  
47 47  (% lang="en-US" %)
... ... @@ -63,7 +63,7 @@
63 63  (% lang="en-US" %)**GET /api/v3/auth/check**
64 64  )))
65 65  
66 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
67 67  
68 68  (% style="color:#000000" %)Метод запроса: **GET**
69 69  
... ... @@ -76,15 +76,57 @@
76 76  
77 77  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
78 78  
79 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
84 84  )))
85 85  
86 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
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": "", ~/~/ идентификатор клиента    (%%)
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" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
128 +
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
90 90  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -91,34 +91,36 @@
91 91  
92 92  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
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 - Отказ)
111 111  }
112 112  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -== (% style="color:#000000, font-size:14px" %)**Добавление клиента**(%%) ==
115 -
116 116  (% class="box successmessage" %)
117 117  (((
118 118  **POST /api/v3/agents **
119 119  )))
120 120  
121 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
122 122  
123 123  Метод запроса: **POST**
124 124  
... ... @@ -132,6 +132,7 @@
132 132   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
133 133   "name": "string", ~/~/ имя
134 134   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
135 135   "isForeign": true, ~/~/ иностранный контрагент
136 136   "district": "string", ~/~/ округ
137 137   "region": "string", ~/~/ регион
... ... @@ -156,6 +156,7 @@
156 156   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
157 157   "name": "string", ~/~/ имя
158 158   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
159 159   "isForeign": true, ~/~/ иностранный контрагент
160 160   "district": "string", ~/~/ округ
161 161   "region": "string", ~/~/ регион
... ... @@ -172,15 +172,14 @@
172 172   "bankKS": "string" ~/~/ корр. счёт
173 173  }
174 174  
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
175 175  
176 -== (% style="color:#000000, font-size:14px" %)**Редактирование клиента**(%%) ==
177 -
178 178  (% class="box warningmessage" %)
179 179  (((
180 180  **PUT /api/v3/agents**
181 181  )))
182 182  
183 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
184 184  
185 185  Метод запроса: **PUT**
186 186  
... ... @@ -196,6 +196,7 @@
196 196   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
197 197   "name": "string", ~/~/ имя
198 198   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
199 199   "isForeign": true, ~/~/ иностранный контрагент
200 200   "district": "string", ~/~/ округ
201 201   "region": "string", ~/~/ регион
... ... @@ -236,15 +236,14 @@
236 236   "bankKS": "string" ~/~/ корр. счёт
237 237  }
238 238  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
239 239  
240 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
241 -
242 242  (% class="box errormessage" %)
243 243  (((
244 244  **DELETE /api/v3/agents/{clientId}**
245 245  )))
246 246  
247 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
248 248  
249 249  Метод запроса: **DELETE**
250 250  
... ... @@ -256,18 +256,16 @@
256 256  
257 257  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
258 258  
259 -
260 260  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
261 261  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
262 262  
263 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
264 -
265 265  (% class="box successmessage" %)
266 266  (((
267 267  (% lang="en-US" %)**POST /api/v3/users**
268 268  )))
269 269  
270 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
271 271  
272 272  (% style="color:#000000" %)Метод запроса: **POST**
273 273  
... ... @@ -277,7 +277,8 @@
277 277  
278 278  (% style="color:#000000" %)Параметры в теле запроса (JSON):
279 279  
280 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
281 281   "lastName": "", ~/~/ фамилия
282 282   "firstName": "", ~/~/ имя
283 283   "position": "", ~/~/ должность
... ... @@ -286,17 +286,41 @@
286 286   "login": "", ~/~/ логин (обязателен)
287 287   "password": "", ~/~/ пароль (обязателен)
288 288   "email": "", ~/~/ email (обязателен)
289 - "description": "", ~/~/ описание
290 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
291 291   "parentId": "", ~/~/ Guid родительского агента
292 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
293 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
294 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
295 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
296 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
297 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
337 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
338 + "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
339 + "doubleAuth":
340 + {
341 + "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
342 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
343 + },
344 + "groups":
345 + [
346 + "string" ~/~/ группы пользователя, перечисление названия системных ролей
347 + ],
348 + "customGroups":
349 + [
350 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 + ],
352 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
298 298  }
299 299  
355 +{
356 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 + "lastName": "string",
358 + "firstName": "string",
359 + "position": "string",
360 + "phone": "string",
361 + "organization": "string",
362 + "login": "string",
363 + "password": "string",
364 + "email": "string",
365 +
366 +
300 300  (% style="text-align:left" %)
301 301  (% style="color:#000000; font-weight:normal" %)Ответ:
302 302  
... ... @@ -325,10 +325,9 @@
325 325  (% style="text-align:left" %)
326 326  (% style="color:#000000; font-weight:normal" %)}
327 327  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
328 328  
329 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
330 -
331 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
332 332  (((
333 333  (% lang="en-US" %)**POST /api/v3/users/find**
334 334  )))
... ... @@ -370,14 +370,13 @@
370 370   "email": "" , ~/~/ E-mail
371 371   "sessionDuration":"", ~/~/ длительность сессии в минутах
372 372   "status": "1",  ~/~/ статус пользователя
373 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
374 374  
375 375  (% style="color:#000000" %)}
376 376  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
377 377  
378 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
379 -
380 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
381 381  (((
382 382  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
383 383  )))
... ... @@ -409,8 +409,11 @@
409 409   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
410 410   "description": "", ~/~/ Описание
411 411   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
412 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
413 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
414 414   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
415 415   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
416 416   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -424,15 +424,14 @@
424 424  )))
425 425  )))
426 426  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
427 427  
428 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
429 -
430 430  (% class="box warningmessage" %)
431 431  (((
432 432  (% lang="en-US" %)**PUT /api/v3/users**
433 433  )))
434 434  
435 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
436 436  
437 437  (% style="color:#000000" %)Метод запроса: **PUT**
438 438  
... ... @@ -454,7 +454,9 @@
454 454   "phone": "" , ~/~/ телефон
455 455   "organization": "" , ~/~/ организация
456 456   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
457 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
458 458   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
459 459  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
460 460   "isEnabled": "" , ~/~/ признак включения
... ... @@ -461,9 +461,12 @@
461 461   "parentId": "" , ~/~/ Guid родительского агента
462 462   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
463 463   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
464 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
465 - "kind": "" , ~/~/ тип аутентификации
466 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
467 467   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
468 468  
469 469  (% lang="en-US" style="text-align:left" %)
... ... @@ -489,8 +489,12 @@
489 489   "isEnabled": "" , ~/~/ признак включения
490 490   "parentId": "" , ~/~/ Guid родительского агента
491 491   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
492 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
493 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
494 494   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
495 495   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
496 496  
... ... @@ -497,15 +497,14 @@
497 497  (% lang="en-US" style="text-align:left" %)
498 498  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
499 499  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
500 500  
501 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
502 -
503 503  (% class="box warningmessage" %)
504 504  (((
505 505  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
506 506  )))
507 507  
508 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
509 509  
510 510  (% style="color:#000000" %)Метод запроса: **PUT**
511 511  
... ... @@ -528,15 +528,14 @@
528 528  (% style="text-align:left" %)
529 529  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
530 530  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
531 531  
532 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
533 -
534 534  (% class="box warningmessage" %)
535 535  (((
536 536  **POST /api/v3/users/disable**
537 537  )))
538 538  
539 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
540 540  
541 541  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
542 542  
... ... @@ -551,15 +551,14 @@
551 551  
552 552  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
553 553  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
554 554  
555 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
556 -
557 557  (% class="box warningmessage" %)
558 558  (((
559 559  **POST /api/v3/users/enable**
560 560  )))
561 561  
562 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
563 563  
564 564  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
565 565  
... ... @@ -587,17 +587,16 @@
587 587  }
588 588  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
589 589  "users" - массив id пользователей, которых не удалось включить или отключить.
590 -
591 -
592 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
593 593  )))
594 594  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
595 595  (% class="box errormessage" %)
596 596  (((
597 597  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
598 598  )))
599 599  
600 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
601 601  
602 602  (% style="color:#000000" %)Метод запроса: **DELETE**
603 603  
... ... @@ -610,12 +610,10 @@
610 610  (% style="text-align:left" %)
611 611  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
612 612  
613 -
614 614  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
615 615  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
616 616  
617 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
618 -
619 619  (% class="box infomessage" %)
620 620  (((
621 621  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -623,7 +623,7 @@
623 623  
624 624  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
625 625  
626 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
627 627  
628 628  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
629 629  
... ... @@ -631,9 +631,9 @@
631 631  
632 632  (% style="color:#000000" %)Метод запроса: **GET**
633 633  
634 -(% 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>
704 +(% 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}
635 635  
636 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
637 637  
638 638  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
639 639  
... ... @@ -647,18 +647,124 @@
647 647   "deviceTypeId": , ~/~/ ID типа устройства
648 648   "deviceTypeName": "", ~/~/ Название типа устройства
649 649   "sim1": "", ~/~/ Номер SIM1
650 - "parentId": "", Номер SIM2
651 - "parentName": "", Наименование клиента-родителя
652 - "modelId": "", ID модели объекта
653 - "modelName": "", Имя модели объекта
654 - "createdAt": "", Дата создания объекта
655 - "mileageCalcMethod": "", Выбранный метод расчета пробега
656 - "counters": { ~/~/ Нормы
657 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
658 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
659 - "mileage": "", ~/~/ Пробег по нормам в метрах
660 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
720 + "sim2": "", ~/~/ Номер SIM2
721 +
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
661 661   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0, ~/~/ Тип тарировки
801 + "gradesTables": [ ~/~/ Тип тарировки Таблица
802 + {
803 + "grades": [ ~/~/ Тарировка
804 + {
805 + "input": 0, ~/~/ Входящее значение
806 + "output": 0 ~/~/ Выходящее значение
807 + }
808 + ],
809 + "relevanceTime": "2023-05-22T09:57:39.562Z"
810 + }
811 + ],
812 + "showInTooltip": true, ~/~/ Отображать в подсказке
813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 + "agrFunction": 0,
817 + "expr": "string",
818 + "children": [
819 + "string"
820 + ],
821 + "customParams": {
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 + "summaryMaxValue": 0
827 + }
828 +
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
837 +
662 662   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
663 663   {
664 664   "id": "", ~/~/ ID  задания
... ... @@ -674,7 +674,17 @@
674 674   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
675 675   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
676 676   }
677 - ]
853 + ],
854 +
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
863 +
678 678  }
679 679  )))
680 680  
... ... @@ -684,15 +684,14 @@
684 684  (% style="text-align:left" %)
685 685  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
686 686  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
687 687  
688 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
689 -
690 690  (% class="box successmessage" %)
691 691  (((
692 692  (% lang="en-US" %)**POST /api/v3/vehicles**
693 693  )))
694 694  
695 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
696 696  
697 697  (% style="color:#000000" %)Метод запроса: **POST**
698 698  
... ... @@ -724,6 +724,11 @@
724 724   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
725 725   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
726 726   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
727 727   "counters": ~/~/ счетчики
728 728   {
729 729   "mileage": "" , ~/~/ пробег
... ... @@ -753,7 +753,72 @@
753 753   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
754 754   }
755 755  
756 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
757 757  
758 758  (% style="color:#000000" %)Ответ:
759 759  
... ... @@ -805,10 +805,9 @@
805 805  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
806 806  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
807 807  
1063 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
808 808  
809 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
810 -
811 -(% class="box successmessage" %)
1065 +(% class="box infomessage" %)
812 812  (((
813 813  (% lang="en-US" %)**POST /api/v3/vehicles/find**
814 814  )))
... ... @@ -815,7 +815,7 @@
815 815  
816 816  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
817 817  
818 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1072 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
819 819  
820 820  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
821 821  
... ... @@ -888,15 +888,14 @@
888 888  
889 889  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
890 890  
1145 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
891 891  
892 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
893 -
894 894  (% class="box successmessage" %)
895 895  (((
896 896  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
897 897  )))
898 898  
899 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1152 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
900 900  
901 901  (% style="color:#000000" %)Метод запроса: **POST**
902 902  
... ... @@ -935,15 +935,14 @@
935 935  (% style="text-align:left" %)
936 936  (% style="color:#000000" %) }
937 937  
1191 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
938 938  
939 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
940 -
941 941  (% class="box warningmessage" %)
942 942  (((
943 943  (% lang="en-US" %)**PUT /api/v3/vehicles**
944 944  )))
945 945  
946 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
947 947  
948 948  (% style="color:#000000" %)Метод запроса: **PUT**
949 949  
... ... @@ -1060,20 +1060,19 @@
1060 1060  (% lang="en-US" style="text-align:left" %)
1061 1061  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1062 1062  
1063 -**валидация:**
1315 +**Валидация:**
1064 1064  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1065 1065  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1066 1066  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1067 1067  
1320 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1068 1068  
1069 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1070 -
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 1073  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1074 1074  )))
1075 1075  
1076 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1327 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1077 1077  
1078 1078  (% style="color:#000000" %)Метод запроса: **DELETE**
1079 1079  
... ... @@ -1086,18 +1086,16 @@
1086 1086  (% style="text-align:left" %)
1087 1087  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1088 1088  
1340 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1089 1089  
1090 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1342 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1091 1091  
1092 -
1093 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1094 -
1095 1095  (% class="box infomessage" %)
1096 1096  (((
1097 1097  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1098 1098  )))
1099 1099  
1100 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1349 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1101 1101  
1102 1102  (% style="color:#000000" %)Метод запроса: **GET**
1103 1103  
... ... @@ -1115,24 +1115,22 @@
1115 1115  (% style="text-align:left" %)
1116 1116  (% style="color:#000000" %)}
1117 1117  
1367 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1118 1118  
1119 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1369 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1120 1120  
1121 -
1122 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1123 -
1124 1124  (% class="box infomessage" %)
1125 1125  (((
1126 1126  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1127 1127  )))
1128 1128  
1129 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1376 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1130 1130  
1131 1131  (% style="color:#000000" %)Метод запроса: **GET**
1132 1132  
1133 1133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1134 1134  
1135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1136 1136  
1137 1137  (% style="color:#000000" %)Ответ:
1138 1138  
... ... @@ -1145,7 +1145,296 @@
1145 1145  (% style="text-align:left" %)
1146 1146  (% style="color:#000000" %)}
1147 1147  
1395 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1148 1148  
1397 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1398 +
1399 +(% class="box infomessage" style="text-align: left;" %)
1400 +(((
1401 +**POST /api/v3/terminalMessages/count**
1402 +)))
1403 +
1404 +(% style="text-align: left;" %)
1405 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1406 +
1407 +(% style="text-align: left;" %)
1408 +Метод запроса **POST**
1409 +
1410 +(% style="text-align: left;" %)
1411 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1412 +
1413 +(% style="text-align: left;" %)
1414 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1415 +
1416 +(% style="text-align: left;" %)
1417 +{
1418 + "vehicleIds": [
1419 + id ~/~/ здесь передается список идентификаторов объектов
1420 + ],
1421 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1422 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1423 +}
1424 +
1425 +(% style="text-align: left;" %)
1426 +Ответ:
1427 +
1428 +(% style="text-align: left;" %)
1429 +[
1430 + {
1431 + "vehicleId": 0, ~/~/ идентификатор объекта
1432 + "count": 0 ~/~/ количество сообщений за период
1433 + }
1434 +]
1435 +
1436 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1437 +
1438 +(% class="box infomessage" %)
1439 +(((
1440 +**POST /api/v3/terminalMessages**
1441 +)))
1442 +
1443 +Метод возвращает список сообщений терминала объекта за выбранный период.
1444 +
1445 +(% style="text-align: left;" %)
1446 +Метод запроса **POST**
1447 +
1448 +(% style="text-align: left;" %)
1449 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1450 +
1451 +(% style="text-align: left;" %)
1452 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1453 +
1454 +{
1455 + "vehicleId": 0, ~/~/ id объекта
1456 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1457 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1458 +}
1459 +
1460 +Ответ:
1461 +
1462 +[
1463 + {
1464 + "messages": [
1465 + {
1466 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1467 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1468 + "speed": 0, ~/~/ Скорость, км/ч
1469 + "altitude": 0, ~/~/ Высота, м
1470 + "latitude": 0, ~/~/ Широта [-90°;90°]
1471 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1472 + "satellites": 0, ~/~/ Кол-во спутников
1473 + "voltage": 0, ~/~/ Напряжение
1474 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1475 + "additionalProp1": "string",
1476 + "additionalProp2": "string",
1477 + "additionalProp3": "string"
1478 + },
1479 + "photoCount": 0 ~/~/ Кол-во фото
1480 + }
1481 + ]
1482 + }
1483 +]
1484 +
1485 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1486 +
1487 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1488 +
1489 +(% class="box infomessage" %)
1490 +(((
1491 +**POST /api/v3/notifications/find**
1492 +)))
1493 +
1494 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1495 +
1496 +(% style="text-align: left;" %)
1497 +Метод запроса **POST**
1498 +
1499 +(% style="text-align: left;" %)
1500 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1501 +
1502 +(% style="text-align: left;" %)
1503 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1504 +
1505 +{
1506 + "parentId": "" ~/~/ id клиента
1507 +}
1508 +
1509 +Ответ:
1510 +
1511 +[
1512 + {
1513 + "id": 0, ~/~/ ID уведомления
1514 + "name": "string", ~/~/ Название уведомления
1515 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1516 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1517 + "userId": "", ~/~/ Пользователь, создавший уведомление
1518 + "parentId": "", ~/~/ Идентификатор клиента
1519 + "parentName": "string" ~/~/ Имя клиента
1520 + }
1521 +]
1522 +
1523 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1524 +
1525 +(% class="box infomessage" %)
1526 +(((
1527 +**GET /api/v3/notifications/{id}**
1528 +)))
1529 +
1530 +Метод возвращает данные правил формирования выбранного уведомления.
1531 +
1532 +(% style="text-align: left;" %)
1533 +Метод запроса **GET**
1534 +
1535 +(% style="text-align: left;" %)
1536 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1537 +
1538 +(% style="text-align: left;" %)
1539 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1540 +
1541 +(% style="text-align: left;" %)
1542 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1543 +
1544 +(% style="text-align: left;" %)
1545 +(% style="color:#000000" %)Ответ:
1546 +
1547 +(% style="text-align: left;" %)
1548 +(% style="color:#000000" %){
1549 + "id": 0, ~/~/ (%%)id уведомления
1550 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1551 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1552 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1553 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1554 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1555 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1556 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1557 +(% style="color:#000000" %) 0
1558 + ],
1559 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1560 +(% style="color:#000000" %) 0
1561 + ],
1562 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1563 +(% style="color:#000000" %) 0
1564 + ],
1565 + "settings": { ~/~/ Список параметров уведомления
1566 + "additionalProp1": "string",
1567 + "additionalProp2": "string",
1568 + "additionalProp3": "string"
1569 + },
1570 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1571 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1572 +(% style="color:#000000" %) ""
1573 + ],
1574 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1575 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1576 +(% style="color:#000000" %) "string"
1577 + ],
1578 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1579 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1580 +(% style="color:#000000" %) {
1581 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1582 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1583 +(% style="color:#000000" %) }
1584 + ],
1585 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1586 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1587 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1588 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1589 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1590 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1591 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1592 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1593 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1594 +(% style="color:#000000" %)}
1595 +
1596 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1597 +
1598 +(% class="box warningmessage" %)
1599 +(((
1600 +**PUT /api/v3/notifications/**
1601 +)))
1602 +
1603 +Метод позволяет отредактировать уведомление.
1604 +
1605 +Метод запроса **PUT**
1606 +
1607 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Тело запроса:
1612 +{
1613 + "id": 0, ~/~/ id уведомления
1614 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1615 + "userId": "", ~/~/ Пользователь, создавший уведомление
1616 + "parentId": "", ~/~/ Идентификатор клиента
1617 + "parentName": "string", ~/~/ Имя клиента
1618 + "name": "string", ~/~/ Название уведомления
1619 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1620 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1621 + 0
1622 + ],
1623 + "geoids": [ ~/~/ Список id геообъектов для анализа
1624 + 0
1625 + ],
1626 + "fieldids": [ ~/~/ Список id полей для анализа
1627 + 0
1628 + ],
1629 + "settings": { ~/~/ Список параметров уведомления
1630 + "additionalProp1": "string",
1631 + "additionalProp2": "string",
1632 + "additionalProp3": "string"
1633 + },
1634 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1635 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1636 + ""
1637 + ],
1638 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1639 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1640 + "string"
1641 + ],
1642 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1643 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1644 + {
1645 + "id": 0, ~/~/ Идентификатор участника чата
1646 + "info": "string" ~/~/ Дополнительные сведения
1647 + }
1648 + ],
1649 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1650 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1651 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1652 + "kind": 0, ~/~/ Определяет вид уведомления
1653 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1654 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1655 + "timezone": 0, ~/~/ Сдвиг часового пояса
1656 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1657 + "autoProlongation": true ~/~/ Автопродление срока действия
1658 +}
1659 +
1660 +Ответ:
1661 +
1662 +Success
1663 +
1664 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1665 +
1666 +(% class="box errormessage" %)
1667 +(((
1668 +**DELETE /api/v3/notifications/{id}**
1669 +)))
1670 +
1671 +Метод позволяет удалить выбранное уведомление.
1672 +
1673 +Метод запроса **DELETE**
1674 +
1675 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1676 +
1677 +Передаваемый параметр: {id} - id уведомления
1678 +
1679 +В заголовках запроса: X-Auth: Токен авторизации
1680 +
1681 +Ответ:
1682 +
1683 +Success
1684 +
1149 1149  (% class="box" lang="en-US" style="text-align: center;" %)
1150 1150  (((
1151 1151  (% 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]] **

Меню

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