Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.10 >
edited by Илья Крайнов
on 2022/11/24 13:35
To version < 89.3 >
edited by Илья Крайнов
on 2023/05/22 14:41
>
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  
... ... @@ -37,7 +37,7 @@
37 37  (% style="color:#000000" %){
38 38   "login": "testuser",
39 39   "password": "testuser"
40 -}(%%)
41 +}
41 41  
42 42  
43 43  (% style="color:#000000" %)**Ответ:**
... ... @@ -61,7 +61,7 @@
61 61  (% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -74,15 +74,57 @@
74 74  
75 75  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
76 76  
77 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
78 78  
79 79  (% class="box infomessage" %)
80 80  (((
81 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
82 82  )))
83 83  
84 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
85 85  
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 +
86 86  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
87 87  
88 88  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -89,23 +89,26 @@
89 89  
90 90  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
91 91  
92 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
93 93  
94 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
95 95  
96 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
97 97  
98 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
99 99  
100 100  (% style="color:#000000" %)Ответ:
101 101  
102 -(% style="color:#000000" %){
103 - "agentId": "", ~/~/ идентификатор клиента
104 - "parentId": "", ~/~/ идентификатор клиента-родителя
105 - "name": "", ~/~/ наименование клиента
106 - "fullName": "", ~/~/ полное наименование клиента
107 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
108 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
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 - Отказ)
109 109  }
110 110  
111 111  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -115,7 +115,7 @@
115 115  **POST /api/v3/agents **
116 116  )))
117 117  
118 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
119 119  
120 120  Метод запроса: **POST**
121 121  
... ... @@ -129,6 +129,7 @@
129 129   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
130 130   "name": "string", ~/~/ имя
131 131   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
132 132   "isForeign": true, ~/~/ иностранный контрагент
133 133   "district": "string", ~/~/ округ
134 134   "region": "string", ~/~/ регион
... ... @@ -153,6 +153,7 @@
153 153   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
154 154   "name": "string", ~/~/ имя
155 155   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
156 156   "isForeign": true, ~/~/ иностранный контрагент
157 157   "district": "string", ~/~/ округ
158 158   "region": "string", ~/~/ регион
... ... @@ -169,7 +169,6 @@
169 169   "bankKS": "string" ~/~/ корр. счёт
170 170  }
171 171  
172 -
173 173  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
174 174  
175 175  (% class="box warningmessage" %)
... ... @@ -177,7 +177,7 @@
177 177  **PUT /api/v3/agents**
178 178  )))
179 179  
180 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
181 181  
182 182  Метод запроса: **PUT**
183 183  
... ... @@ -193,6 +193,7 @@
193 193   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 194   "name": "string", ~/~/ имя
195 195   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
196 196   "isForeign": true, ~/~/ иностранный контрагент
197 197   "district": "string", ~/~/ округ
198 198   "region": "string", ~/~/ регион
... ... @@ -233,15 +233,14 @@
233 233   "bankKS": "string" ~/~/ корр. счёт
234 234  }
235 235  
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
236 236  
237 -== (% style="color:#000000, font-size:14px" %)**Удаление клиента**(%%) ==
238 -
239 239  (% class="box errormessage" %)
240 240  (((
241 241  **DELETE /api/v3/agents/{clientId}**
242 242  )))
243 243  
244 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
245 245  
246 246  Метод запроса: **DELETE**
247 247  
... ... @@ -253,18 +253,16 @@
253 253  
254 254  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
255 255  
256 -
257 257  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
258 258  
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
259 259  
260 -== (% style="color:#000000; line-height:14px" %)**Добавление пользователя**(%%) ==
261 -
262 262  (% class="box successmessage" %)
263 263  (((
264 264  (% lang="en-US" %)**POST /api/v3/users**
265 265  )))
266 266  
267 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
268 268  
269 269  (% style="color:#000000" %)Метод запроса: **POST**
270 270  
... ... @@ -274,7 +274,8 @@
274 274  
275 275  (% style="color:#000000" %)Параметры в теле запроса (JSON):
276 276  
277 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
278 278   "lastName": "", ~/~/ фамилия
279 279   "firstName": "", ~/~/ имя
280 280   "position": "", ~/~/ должность
... ... @@ -283,17 +283,41 @@
283 283   "login": "", ~/~/ логин (обязателен)
284 284   "password": "", ~/~/ пароль (обязателен)
285 285   "email": "", ~/~/ email (обязателен)
286 - "description": "", ~/~/ описание
287 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
288 288   "parentId": "", ~/~/ Guid родительского агента
289 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
290 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
291 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
292 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
293 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
294 - "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
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 - Азербайджанский
295 295  }
296 296  
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 +
297 297  (% style="text-align:left" %)
298 298  (% style="color:#000000; font-weight:normal" %)Ответ:
299 299  
... ... @@ -322,10 +322,9 @@
322 322  (% style="text-align:left" %)
323 323  (% style="color:#000000; font-weight:normal" %)}
324 324  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
325 325  
326 -== (% style="color:#000000; font-size:14px" %)**Получение списка пользователей**(%%) ==
327 -
328 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
329 329  (((
330 330  (% lang="en-US" %)**POST /api/v3/users/find**
331 331  )))
... ... @@ -367,14 +367,13 @@
367 367   "email": "" , ~/~/ E-mail
368 368   "sessionDuration":"", ~/~/ длительность сессии в минутах
369 369   "status": "1",  ~/~/ статус пользователя
370 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
371 371  
372 372  (% style="color:#000000" %)}
373 373  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
374 374  
375 -== (% style="color:#000000; font-size:14px" %)**Получение информации о пользователе**(%%) ==
376 -
377 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
378 378  (((
379 379  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
380 380  )))
... ... @@ -406,8 +406,11 @@
406 406   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
407 407   "description": "", ~/~/ Описание
408 408   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
409 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
410 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
411 411   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
412 412   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
413 413   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -421,15 +421,14 @@
421 421  )))
422 422  )))
423 423  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
424 424  
425 -== (% style="color:#000000; font-size:14px" %)**Редактирование пользователя**(%%) ==
426 -
427 427  (% class="box warningmessage" %)
428 428  (((
429 429  (% lang="en-US" %)**PUT /api/v3/users**
430 430  )))
431 431  
432 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
433 433  
434 434  (% style="color:#000000" %)Метод запроса: **PUT**
435 435  
... ... @@ -451,7 +451,9 @@
451 451   "phone": "" , ~/~/ телефон
452 452   "organization": "" , ~/~/ организация
453 453   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
454 -(% 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 - отключено
455 455   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
456 456  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
457 457   "isEnabled": "" , ~/~/ признак включения
... ... @@ -458,9 +458,12 @@
458 458   "parentId": "" , ~/~/ Guid родительского агента
459 459   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
460 460   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
461 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
462 - "kind": "" , ~/~/ тип аутентификации
463 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
464 464   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
465 465  
466 466  (% lang="en-US" style="text-align:left" %)
... ... @@ -486,8 +486,12 @@
486 486   "isEnabled": "" , ~/~/ признак включения
487 487   "parentId": "" , ~/~/ Guid родительского агента
488 488   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
489 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
490 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
491 491   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
492 492   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
493 493  
... ... @@ -494,15 +494,14 @@
494 494  (% lang="en-US" style="text-align:left" %)
495 495  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
496 496  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
497 497  
498 -== (% style="color:#000000, font-size:14px" %)**Изменение статуса пользователя**(%%) ==
499 -
500 500  (% class="box warningmessage" %)
501 501  (((
502 502  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
503 503  )))
504 504  
505 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
506 506  
507 507  (% style="color:#000000" %)Метод запроса: **PUT**
508 508  
... ... @@ -525,15 +525,14 @@
525 525  (% style="text-align:left" %)
526 526  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
527 527  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
528 528  
529 -== (% style="color:#000000, font-size:14px" %)**Блокировка пользователей**(%%) ==
530 -
531 531  (% class="box warningmessage" %)
532 532  (((
533 533  **POST /api/v3/users/disable**
534 534  )))
535 535  
536 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
537 537  
538 538  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 539  
... ... @@ -548,15 +548,14 @@
548 548  
549 549  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
550 550  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
551 551  
552 -== (% style="color:#000000, font-size:14px" %)**Разблокировка пользователей**(%%) ==
553 -
554 554  (% class="box warningmessage" %)
555 555  (((
556 556  **POST /api/v3/users/enable**
557 557  )))
558 558  
559 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
560 560  
561 561  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
562 562  
... ... @@ -584,17 +584,16 @@
584 584  }
585 585  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
586 586  "users" - массив id пользователей, которых не удалось включить или отключить.
587 -
588 -
589 -== (% style="color:#000000; line-height:14px" %)**Удаление пользователя**(%%) ==
590 590  )))
591 591  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
592 592  (% class="box errormessage" %)
593 593  (((
594 594  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
595 595  )))
596 596  
597 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
598 598  
599 599  (% style="color:#000000" %)Метод запроса: **DELETE**
600 600  
... ... @@ -607,12 +607,10 @@
607 607  (% style="text-align:left" %)
608 608  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
609 609  
610 -
611 611  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
612 612  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
613 613  
614 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
615 -
616 616  (% class="box infomessage" %)
617 617  (((
618 618  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -620,7 +620,7 @@
620 620  
621 621  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
622 622  
623 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
624 624  
625 625  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
626 626  
... ... @@ -628,9 +628,9 @@
628 628  
629 629  (% style="color:#000000" %)Метод запроса: **GET**
630 630  
631 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
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}
632 632  
633 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
634 634  
635 635  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
636 636  
... ... @@ -644,18 +644,124 @@
644 644   "deviceTypeId": , ~/~/ ID типа устройства
645 645   "deviceTypeName": "", ~/~/ Название типа устройства
646 646   "sim1": "", ~/~/ Номер SIM1
647 - "parentId": "", Номер SIM2
648 - "parentName": "", Наименование клиента-родителя
649 - "modelId": "", ID модели объекта
650 - "modelName": "", Имя модели объекта
651 - "createdAt": "", Дата создания объекта
652 - "mileageCalcMethod": "", Выбранный метод расчета пробега
653 - "counters": { ~/~/ Нормы
654 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
655 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
656 - "mileage": "", ~/~/ Пробег по нормам в метрах
657 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
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": "", ~/~/ Дата создания объекта
658 658   },
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 +
659 659   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
660 660   {
661 661   "id": "", ~/~/ ID  задания
... ... @@ -671,7 +671,17 @@
671 671   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
672 672   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
673 673   }
674 - ]
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 +
675 675  }
676 676  )))
677 677  
... ... @@ -681,15 +681,14 @@
681 681  (% style="text-align:left" %)
682 682  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
683 683  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
684 684  
685 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
686 -
687 687  (% class="box successmessage" %)
688 688  (((
689 689  (% lang="en-US" %)**POST /api/v3/vehicles**
690 690  )))
691 691  
692 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
693 693  
694 694  (% style="color:#000000" %)Метод запроса: **POST**
695 695  
... ... @@ -802,10 +802,9 @@
802 802  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
803 803  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
804 804  
993 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
805 805  
806 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
807 -
808 -(% class="box successmessage" %)
995 +(% class="box infomessage" %)
809 809  (((
810 810  (% lang="en-US" %)**POST /api/v3/vehicles/find**
811 811  )))
... ... @@ -812,7 +812,7 @@
812 812  
813 813  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
814 814  
815 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1002 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
816 816  
817 817  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
818 818  
... ... @@ -885,15 +885,14 @@
885 885  
886 886  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
887 887  
1075 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
888 888  
889 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
890 -
891 891  (% class="box successmessage" %)
892 892  (((
893 893  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
894 894  )))
895 895  
896 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1082 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
897 897  
898 898  (% style="color:#000000" %)Метод запроса: **POST**
899 899  
... ... @@ -932,15 +932,14 @@
932 932  (% style="text-align:left" %)
933 933  (% style="color:#000000" %) }
934 934  
1121 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
935 935  
936 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
937 -
938 938  (% class="box warningmessage" %)
939 939  (((
940 940  (% lang="en-US" %)**PUT /api/v3/vehicles**
941 941  )))
942 942  
943 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1128 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
944 944  
945 945  (% style="color:#000000" %)Метод запроса: **PUT**
946 946  
... ... @@ -1057,20 +1057,19 @@
1057 1057  (% lang="en-US" style="text-align:left" %)
1058 1058  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1059 1059  
1060 -**валидация:**
1245 +**Валидация:**
1061 1061  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1062 1062  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1063 1063  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1064 1064  
1250 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1065 1065  
1066 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1067 -
1068 1068  (% class="box errormessage" %)
1069 1069  (((
1070 1070  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1071 1071  )))
1072 1072  
1073 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1257 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1074 1074  
1075 1075  (% style="color:#000000" %)Метод запроса: **DELETE**
1076 1076  
... ... @@ -1083,18 +1083,16 @@
1083 1083  (% style="text-align:left" %)
1084 1084  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1085 1085  
1270 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1086 1086  
1087 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1272 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1088 1088  
1089 -
1090 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1091 -
1092 1092  (% class="box infomessage" %)
1093 1093  (((
1094 1094  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1095 1095  )))
1096 1096  
1097 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1279 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1098 1098  
1099 1099  (% style="color:#000000" %)Метод запроса: **GET**
1100 1100  
... ... @@ -1112,24 +1112,22 @@
1112 1112  (% style="text-align:left" %)
1113 1113  (% style="color:#000000" %)}
1114 1114  
1297 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1115 1115  
1116 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1299 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1117 1117  
1118 -
1119 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1120 -
1121 1121  (% class="box infomessage" %)
1122 1122  (((
1123 1123  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1124 1124  )))
1125 1125  
1126 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1306 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1127 1127  
1128 1128  (% style="color:#000000" %)Метод запроса: **GET**
1129 1129  
1130 1130  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1131 1131  
1132 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1312 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1133 1133  
1134 1134  (% style="color:#000000" %)Ответ:
1135 1135  
... ... @@ -1142,7 +1142,296 @@
1142 1142  (% style="text-align:left" %)
1143 1143  (% style="color:#000000" %)}
1144 1144  
1325 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1145 1145  
1327 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1328 +
1329 +(% class="box infomessage" style="text-align: left;" %)
1330 +(((
1331 +**POST /api/v3/terminalMessages/count**
1332 +)))
1333 +
1334 +(% style="text-align: left;" %)
1335 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1336 +
1337 +(% style="text-align: left;" %)
1338 +Метод запроса **POST**
1339 +
1340 +(% style="text-align: left;" %)
1341 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1342 +
1343 +(% style="text-align: left;" %)
1344 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1345 +
1346 +(% style="text-align: left;" %)
1347 +{
1348 + "vehicleIds": [
1349 + id ~/~/ здесь передается список идентификаторов объектов
1350 + ],
1351 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1352 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1353 +}
1354 +
1355 +(% style="text-align: left;" %)
1356 +Ответ:
1357 +
1358 +(% style="text-align: left;" %)
1359 +[
1360 + {
1361 + "vehicleId": 0, ~/~/ идентификатор объекта
1362 + "count": 0 ~/~/ количество сообщений за период
1363 + }
1364 +]
1365 +
1366 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1367 +
1368 +(% class="box infomessage" %)
1369 +(((
1370 +**POST /api/v3/terminalMessages**
1371 +)))
1372 +
1373 +Метод возвращает список сообщений терминала объекта за выбранный период.
1374 +
1375 +(% style="text-align: left;" %)
1376 +Метод запроса **POST**
1377 +
1378 +(% style="text-align: left;" %)
1379 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1380 +
1381 +(% style="text-align: left;" %)
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1383 +
1384 +{
1385 + "vehicleId": 0, ~/~/ id объекта
1386 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1387 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1388 +}
1389 +
1390 +Ответ:
1391 +
1392 +[
1393 + {
1394 + "messages": [
1395 + {
1396 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1397 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1398 + "speed": 0, ~/~/ Скорость, км/ч
1399 + "altitude": 0, ~/~/ Высота, м
1400 + "latitude": 0, ~/~/ Широта [-90°;90°]
1401 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1402 + "satellites": 0, ~/~/ Кол-во спутников
1403 + "voltage": 0, ~/~/ Напряжение
1404 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1405 + "additionalProp1": "string",
1406 + "additionalProp2": "string",
1407 + "additionalProp3": "string"
1408 + },
1409 + "photoCount": 0 ~/~/ Кол-во фото
1410 + }
1411 + ]
1412 + }
1413 +]
1414 +
1415 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1416 +
1417 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1418 +
1419 +(% class="box infomessage" %)
1420 +(((
1421 +**POST /api/v3/notifications/find**
1422 +)))
1423 +
1424 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1425 +
1426 +(% style="text-align: left;" %)
1427 +Метод запроса **POST**
1428 +
1429 +(% style="text-align: left;" %)
1430 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1431 +
1432 +(% style="text-align: left;" %)
1433 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1434 +
1435 +{
1436 + "parentId": "" ~/~/ id клиента
1437 +}
1438 +
1439 +Ответ:
1440 +
1441 +[
1442 + {
1443 + "id": 0, ~/~/ ID уведомления
1444 + "name": "string", ~/~/ Название уведомления
1445 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1446 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1447 + "userId": "", ~/~/ Пользователь, создавший уведомление
1448 + "parentId": "", ~/~/ Идентификатор клиента
1449 + "parentName": "string" ~/~/ Имя клиента
1450 + }
1451 +]
1452 +
1453 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1454 +
1455 +(% class="box infomessage" %)
1456 +(((
1457 +**GET /api/v3/notifications/{id}**
1458 +)))
1459 +
1460 +Метод возвращает данные правил формирования выбранного уведомления.
1461 +
1462 +(% style="text-align: left;" %)
1463 +Метод запроса **GET**
1464 +
1465 +(% style="text-align: left;" %)
1466 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1467 +
1468 +(% style="text-align: left;" %)
1469 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1470 +
1471 +(% style="text-align: left;" %)
1472 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1473 +
1474 +(% style="text-align: left;" %)
1475 +(% style="color:#000000" %)Ответ:
1476 +
1477 +(% style="text-align: left;" %)
1478 +(% style="color:#000000" %){
1479 + "id": 0, ~/~/ (%%)id уведомления
1480 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1481 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1482 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1483 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1484 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1485 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1486 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1487 +(% style="color:#000000" %) 0
1488 + ],
1489 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1490 +(% style="color:#000000" %) 0
1491 + ],
1492 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1493 +(% style="color:#000000" %) 0
1494 + ],
1495 + "settings": { ~/~/ Список параметров уведомления
1496 + "additionalProp1": "string",
1497 + "additionalProp2": "string",
1498 + "additionalProp3": "string"
1499 + },
1500 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1501 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1502 +(% style="color:#000000" %) ""
1503 + ],
1504 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1505 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1506 +(% style="color:#000000" %) "string"
1507 + ],
1508 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1509 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1510 +(% style="color:#000000" %) {
1511 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1512 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1513 +(% style="color:#000000" %) }
1514 + ],
1515 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1516 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1517 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1518 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1519 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1520 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1521 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1522 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1523 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1524 +(% style="color:#000000" %)}
1525 +
1526 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1527 +
1528 +(% class="box warningmessage" %)
1529 +(((
1530 +**PUT /api/v3/notifications/**
1531 +)))
1532 +
1533 +Метод позволяет отредактировать уведомление.
1534 +
1535 +Метод запроса **PUT**
1536 +
1537 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1538 +
1539 +В заголовках запроса: X-Auth: Токен авторизации
1540 +
1541 +Тело запроса:
1542 +{
1543 + "id": 0, ~/~/ id уведомления
1544 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1545 + "userId": "", ~/~/ Пользователь, создавший уведомление
1546 + "parentId": "", ~/~/ Идентификатор клиента
1547 + "parentName": "string", ~/~/ Имя клиента
1548 + "name": "string", ~/~/ Название уведомления
1549 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1550 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1551 + 0
1552 + ],
1553 + "geoids": [ ~/~/ Список id геообъектов для анализа
1554 + 0
1555 + ],
1556 + "fieldids": [ ~/~/ Список id полей для анализа
1557 + 0
1558 + ],
1559 + "settings": { ~/~/ Список параметров уведомления
1560 + "additionalProp1": "string",
1561 + "additionalProp2": "string",
1562 + "additionalProp3": "string"
1563 + },
1564 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1565 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1566 + ""
1567 + ],
1568 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1569 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1570 + "string"
1571 + ],
1572 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1573 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1574 + {
1575 + "id": 0, ~/~/ Идентификатор участника чата
1576 + "info": "string" ~/~/ Дополнительные сведения
1577 + }
1578 + ],
1579 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1580 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1581 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1582 + "kind": 0, ~/~/ Определяет вид уведомления
1583 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1584 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1585 + "timezone": 0, ~/~/ Сдвиг часового пояса
1586 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1587 + "autoProlongation": true ~/~/ Автопродление срока действия
1588 +}
1589 +
1590 +Ответ:
1591 +
1592 +Success
1593 +
1594 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1595 +
1596 +(% class="box errormessage" %)
1597 +(((
1598 +**DELETE /api/v3/notifications/{id}**
1599 +)))
1600 +
1601 +Метод позволяет удалить выбранное уведомление.
1602 +
1603 +Метод запроса **DELETE**
1604 +
1605 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1606 +
1607 +Передаваемый параметр: {id} - id уведомления
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Ответ:
1612 +
1613 +Success
1614 +
1146 1146  (% class="box" lang="en-US" style="text-align: center;" %)
1147 1147  (((
1148 1148  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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