Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 66.13 >
edited by Илья Крайнов
on 2022/11/24 13:40
To version < 88.1 >
edited by Михаил Жучков
on 2023/05/17 14:40
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
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", ~/~/ регион
... ... @@ -176,7 +176,7 @@
176 176  **PUT /api/v3/agents**
177 177  )))
178 178  
179 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
180 180  
181 181  Метод запроса: **PUT**
182 182  
... ... @@ -192,6 +192,7 @@
192 192   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
193 193   "name": "string", ~/~/ имя
194 194   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
195 195   "isForeign": true, ~/~/ иностранный контрагент
196 196   "district": "string", ~/~/ округ
197 197   "region": "string", ~/~/ регион
... ... @@ -239,7 +239,7 @@
239 239  **DELETE /api/v3/agents/{clientId}**
240 240  )))
241 241  
242 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
243 243  
244 244  Метод запроса: **DELETE**
245 245  
... ... @@ -260,7 +260,7 @@
260 260  (% lang="en-US" %)**POST /api/v3/users**
261 261  )))
262 262  
263 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
264 264  
265 265  (% style="color:#000000" %)Метод запроса: **POST**
266 266  
... ... @@ -270,7 +270,8 @@
270 270  
271 271  (% style="color:#000000" %)Параметры в теле запроса (JSON):
272 272  
273 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
274 274   "lastName": "", ~/~/ фамилия
275 275   "firstName": "", ~/~/ имя
276 276   "position": "", ~/~/ должность
... ... @@ -279,17 +279,41 @@
279 279   "login": "", ~/~/ логин (обязателен)
280 280   "password": "", ~/~/ пароль (обязателен)
281 281   "email": "", ~/~/ email (обязателен)
282 - "description": "", ~/~/ описание
283 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
284 284   "parentId": "", ~/~/ Guid родительского агента
285 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
286 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
287 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
288 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
289 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
290 - "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 - Азербайджанский
291 291  }
292 292  
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 +
293 293  (% style="text-align:left" %)
294 294  (% style="color:#000000; font-weight:normal" %)Ответ:
295 295  
... ... @@ -320,7 +320,7 @@
320 320  
321 321  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
322 322  
323 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
324 324  (((
325 325  (% lang="en-US" %)**POST /api/v3/users/find**
326 326  )))
... ... @@ -362,13 +362,13 @@
362 362   "email": "" , ~/~/ E-mail
363 363   "sessionDuration":"", ~/~/ длительность сессии в минутах
364 364   "status": "1",  ~/~/ статус пользователя
365 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
366 366  
367 367  (% style="color:#000000" %)}
368 368  
369 369  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
370 370  
371 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
372 372  (((
373 373  (% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 374  )))
... ... @@ -400,8 +400,11 @@
400 400   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
401 401   "description": "", ~/~/ Описание
402 402   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
403 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
404 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
405 405   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
406 406   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
407 407   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
... ... @@ -422,7 +422,7 @@
422 422  (% lang="en-US" %)**PUT /api/v3/users**
423 423  )))
424 424  
425 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
426 426  
427 427  (% style="color:#000000" %)Метод запроса: **PUT**
428 428  
... ... @@ -444,7 +444,9 @@
444 444   "phone": "" , ~/~/ телефон
445 445   "organization": "" , ~/~/ организация
446 446   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
447 -(% 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 - отключено
448 448   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
449 449  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
450 450   "isEnabled": "" , ~/~/ признак включения
... ... @@ -451,9 +451,12 @@
451 451   "parentId": "" , ~/~/ Guid родительского агента
452 452   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
453 453   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
454 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
455 - "kind": "" , ~/~/ тип аутентификации
456 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
457 457   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
458 458  
459 459  (% lang="en-US" style="text-align:left" %)
... ... @@ -479,8 +479,12 @@
479 479   "isEnabled": "" , ~/~/ признак включения
480 480   "parentId": "" , ~/~/ Guid родительского агента
481 481   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
482 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
483 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
484 484   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
485 485   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
486 486  
... ... @@ -494,7 +494,7 @@
494 494  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 495  )))
496 496  
497 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
498 498  
499 499  (% style="color:#000000" %)Метод запроса: **PUT**
500 500  
... ... @@ -524,7 +524,7 @@
524 524  **POST /api/v3/users/disable**
525 525  )))
526 526  
527 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
528 528  
529 529  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
530 530  
... ... @@ -546,7 +546,7 @@
546 546  **POST /api/v3/users/enable**
547 547  )))
548 548  
549 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
550 550  
551 551  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
552 552  
... ... @@ -583,7 +583,7 @@
583 583  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
584 584  )))
585 585  
586 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
587 587  
588 588  (% style="color:#000000" %)Метод запроса: **DELETE**
589 589  
... ... @@ -596,12 +596,10 @@
596 596  (% style="text-align:left" %)
597 597  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
598 598  
599 -
600 600  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
601 601  
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
602 602  
603 -== (% style="color:#000000; font-size:14px" %)**Получение информации об объекте**(%%) ==
604 -
605 605  (% class="box infomessage" %)
606 606  (((
607 607  (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -609,7 +609,7 @@
609 609  
610 610  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
611 611  
612 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
613 613  
614 614  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
615 615  
... ... @@ -617,9 +617,9 @@
617 617  
618 618  (% style="color:#000000" %)Метод запроса: **GET**
619 619  
620 -(% 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}
621 621  
622 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
623 623  
624 624  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
625 625  
... ... @@ -644,6 +644,8 @@
644 644   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
645 645   "mileage": "", ~/~/ Пробег по нормам в метрах
646 646   "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
647 647   },
648 648   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
649 649   {
... ... @@ -670,15 +670,14 @@
670 670  (% style="text-align:left" %)
671 671  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
672 672  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
673 673  
674 -== (% style="color:#000000; font-size:14px" %)**Добавление объекта**(%%) ==
675 -
676 676  (% class="box successmessage" %)
677 677  (((
678 678  (% lang="en-US" %)**POST /api/v3/vehicles**
679 679  )))
680 680  
681 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
766 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
682 682  
683 683  (% style="color:#000000" %)Метод запроса: **POST**
684 684  
... ... @@ -791,10 +791,9 @@
791 791  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
792 792  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
793 793  
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
794 794  
795 -== (% style="color:#000000; font-size:14px" %)**Получение параметров объектов**(%%) ==
796 -
797 -(% class="box successmessage" %)
881 +(% class="box infomessage" %)
798 798  (((
799 799  (% lang="en-US" %)**POST /api/v3/vehicles/find**
800 800  )))
... ... @@ -801,7 +801,7 @@
801 801  
802 802  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
803 803  
804 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
805 805  
806 806  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
807 807  
... ... @@ -874,15 +874,14 @@
874 874  
875 875  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
876 876  
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
877 877  
878 -== (% style="color:#000000; font-size:14px" %)**Изменение статуса объекта**(%%) ==
879 -
880 880  (% class="box successmessage" %)
881 881  (((
882 882  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
883 883  )))
884 884  
885 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
886 886  
887 887  (% style="color:#000000" %)Метод запроса: **POST**
888 888  
... ... @@ -921,15 +921,14 @@
921 921  (% style="text-align:left" %)
922 922  (% style="color:#000000" %) }
923 923  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
924 924  
925 -== (% style="color:#000000; font-size:14px" %)**Редактирование объекта**(%%) ==
926 -
927 927  (% class="box warningmessage" %)
928 928  (((
929 929  (% lang="en-US" %)**PUT /api/v3/vehicles**
930 930  )))
931 931  
932 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
933 933  
934 934  (% style="color:#000000" %)Метод запроса: **PUT**
935 935  
... ... @@ -1046,20 +1046,19 @@
1046 1046  (% lang="en-US" style="text-align:left" %)
1047 1047  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1048 1048  
1049 -**валидация:**
1131 +**Валидация:**
1050 1050  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1051 1051  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1052 1052  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1053 1053  
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1054 1054  
1055 -== (% style="color:#000000; font-size:14px" %)**Удаление объекта**(%%) ==
1056 -
1057 1057  (% class="box errormessage" %)
1058 1058  (((
1059 1059  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1060 1060  )))
1061 1061  
1062 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1143 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1063 1063  
1064 1064  (% style="color:#000000" %)Метод запроса: **DELETE**
1065 1065  
... ... @@ -1072,18 +1072,16 @@
1072 1072  (% style="text-align:left" %)
1073 1073  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1074 1074  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1075 1075  
1076 -(% style="color:#000000; font-size:14pt" %)Раздел: **Устройства**
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1077 1077  
1078 -
1079 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов устройств**(%%) ==
1080 -
1081 1081  (% class="box infomessage" %)
1082 1082  (((
1083 1083  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1084 1084  )))
1085 1085  
1086 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1087 1087  
1088 1088  (% style="color:#000000" %)Метод запроса: **GET**
1089 1089  
... ... @@ -1101,24 +1101,22 @@
1101 1101  (% style="text-align:left" %)
1102 1102  (% style="color:#000000" %)}
1103 1103  
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1104 1104  
1105 -= (% style="color:#000000; font-size:18.6667pt" %)Раздел: **Датчики**(%%) =
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1106 1106  
1107 -
1108 -== (% style="color:#000000; font-size:14px" %)**Получение списка типов датчиков**(%%) ==
1109 -
1110 1110  (% class="box infomessage" %)
1111 1111  (((
1112 1112  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1113 1113  )))
1114 1114  
1115 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1116 1116  
1117 1117  (% style="color:#000000" %)Метод запроса: **GET**
1118 1118  
1119 1119  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1120 1120  
1121 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1198 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1122 1122  
1123 1123  (% style="color:#000000" %)Ответ:
1124 1124  
... ... @@ -1131,7 +1131,296 @@
1131 1131  (% style="text-align:left" %)
1132 1132  (% style="color:#000000" %)}
1133 1133  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1134 1134  
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1214 +
1215 +(% class="box infomessage" style="text-align: left;" %)
1216 +(((
1217 +**POST /api/v3/terminalMessages/count**
1218 +)))
1219 +
1220 +(% style="text-align: left;" %)
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1222 +
1223 +(% style="text-align: left;" %)
1224 +Метод запроса **POST**
1225 +
1226 +(% style="text-align: left;" %)
1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1228 +
1229 +(% style="text-align: left;" %)
1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1231 +
1232 +(% style="text-align: left;" %)
1233 +{
1234 + "vehicleIds": [
1235 + id ~/~/ здесь передается список идентификаторов объектов
1236 + ],
1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1239 +}
1240 +
1241 +(% style="text-align: left;" %)
1242 +Ответ:
1243 +
1244 +(% style="text-align: left;" %)
1245 +[
1246 + {
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1248 + "count": 0 ~/~/ количество сообщений за период
1249 + }
1250 +]
1251 +
1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1253 +
1254 +(% class="box infomessage" %)
1255 +(((
1256 +**POST /api/v3/terminalMessages**
1257 +)))
1258 +
1259 +Метод возвращает список сообщений терминала объекта за выбранный период.
1260 +
1261 +(% style="text-align: left;" %)
1262 +Метод запроса **POST**
1263 +
1264 +(% style="text-align: left;" %)
1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1266 +
1267 +(% style="text-align: left;" %)
1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1269 +
1270 +{
1271 + "vehicleId": 0, ~/~/ id объекта
1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1274 +}
1275 +
1276 +Ответ:
1277 +
1278 +[
1279 + {
1280 + "messages": [
1281 + {
1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1284 + "speed": 0, ~/~/ Скорость, км/ч
1285 + "altitude": 0, ~/~/ Высота, м
1286 + "latitude": 0, ~/~/ Широта [-90°;90°]
1287 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1288 + "satellites": 0, ~/~/ Кол-во спутников
1289 + "voltage": 0, ~/~/ Напряжение
1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1291 + "additionalProp1": "string",
1292 + "additionalProp2": "string",
1293 + "additionalProp3": "string"
1294 + },
1295 + "photoCount": 0 ~/~/ Кол-во фото
1296 + }
1297 + ]
1298 + }
1299 +]
1300 +
1301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1302 +
1303 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1304 +
1305 +(% class="box infomessage" %)
1306 +(((
1307 +**POST /api/v3/notifications/find**
1308 +)))
1309 +
1310 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1311 +
1312 +(% style="text-align: left;" %)
1313 +Метод запроса **POST**
1314 +
1315 +(% style="text-align: left;" %)
1316 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1317 +
1318 +(% style="text-align: left;" %)
1319 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1320 +
1321 +{
1322 + "parentId": "" ~/~/ id клиента
1323 +}
1324 +
1325 +Ответ:
1326 +
1327 +[
1328 + {
1329 + "id": 0, ~/~/ ID уведомления
1330 + "name": "string", ~/~/ Название уведомления
1331 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1332 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1333 + "userId": "", ~/~/ Пользователь, создавший уведомление
1334 + "parentId": "", ~/~/ Идентификатор клиента
1335 + "parentName": "string" ~/~/ Имя клиента
1336 + }
1337 +]
1338 +
1339 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1340 +
1341 +(% class="box infomessage" %)
1342 +(((
1343 +**GET /api/v3/notifications/{id}**
1344 +)))
1345 +
1346 +Метод возвращает данные правил формирования выбранного уведомления.
1347 +
1348 +(% style="text-align: left;" %)
1349 +Метод запроса **GET**
1350 +
1351 +(% style="text-align: left;" %)
1352 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1353 +
1354 +(% style="text-align: left;" %)
1355 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1356 +
1357 +(% style="text-align: left;" %)
1358 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1359 +
1360 +(% style="text-align: left;" %)
1361 +(% style="color:#000000" %)Ответ:
1362 +
1363 +(% style="text-align: left;" %)
1364 +(% style="color:#000000" %){
1365 + "id": 0, ~/~/ (%%)id уведомления
1366 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1367 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1368 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1369 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1370 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1371 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1372 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1373 +(% style="color:#000000" %) 0
1374 + ],
1375 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1376 +(% style="color:#000000" %) 0
1377 + ],
1378 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1379 +(% style="color:#000000" %) 0
1380 + ],
1381 + "settings": { ~/~/ Список параметров уведомления
1382 + "additionalProp1": "string",
1383 + "additionalProp2": "string",
1384 + "additionalProp3": "string"
1385 + },
1386 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1387 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1388 +(% style="color:#000000" %) ""
1389 + ],
1390 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1391 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1392 +(% style="color:#000000" %) "string"
1393 + ],
1394 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1395 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1396 +(% style="color:#000000" %) {
1397 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1398 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1399 +(% style="color:#000000" %) }
1400 + ],
1401 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1402 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1403 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1404 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1405 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1406 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1407 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1408 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1409 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 +(% style="color:#000000" %)}
1411 +
1412 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1413 +
1414 +(% class="box warningmessage" %)
1415 +(((
1416 +**PUT /api/v3/notifications/**
1417 +)))
1418 +
1419 +Метод позволяет отредактировать уведомление.
1420 +
1421 +Метод запроса **PUT**
1422 +
1423 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1424 +
1425 +В заголовках запроса: X-Auth: Токен авторизации
1426 +
1427 +Тело запроса:
1428 +{
1429 + "id": 0, ~/~/ id уведомления
1430 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1431 + "userId": "", ~/~/ Пользователь, создавший уведомление
1432 + "parentId": "", ~/~/ Идентификатор клиента
1433 + "parentName": "string", ~/~/ Имя клиента
1434 + "name": "string", ~/~/ Название уведомления
1435 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1436 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1437 + 0
1438 + ],
1439 + "geoids": [ ~/~/ Список id геообъектов для анализа
1440 + 0
1441 + ],
1442 + "fieldids": [ ~/~/ Список id полей для анализа
1443 + 0
1444 + ],
1445 + "settings": { ~/~/ Список параметров уведомления
1446 + "additionalProp1": "string",
1447 + "additionalProp2": "string",
1448 + "additionalProp3": "string"
1449 + },
1450 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1451 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1452 + ""
1453 + ],
1454 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1455 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1456 + "string"
1457 + ],
1458 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1459 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1460 + {
1461 + "id": 0, ~/~/ Идентификатор участника чата
1462 + "info": "string" ~/~/ Дополнительные сведения
1463 + }
1464 + ],
1465 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1466 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1467 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1468 + "kind": 0, ~/~/ Определяет вид уведомления
1469 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1470 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1471 + "timezone": 0, ~/~/ Сдвиг часового пояса
1472 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1473 + "autoProlongation": true ~/~/ Автопродление срока действия
1474 +}
1475 +
1476 +Ответ:
1477 +
1478 +Success
1479 +
1480 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1481 +
1482 +(% class="box errormessage" %)
1483 +(((
1484 +**DELETE /api/v3/notifications/{id}**
1485 +)))
1486 +
1487 +Метод позволяет удалить выбранное уведомление.
1488 +
1489 +Метод запроса **DELETE**
1490 +
1491 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1492 +
1493 +Передаваемый параметр: {id} - id уведомления
1494 +
1495 +В заголовках запроса: X-Auth: Токен авторизации
1496 +
1497 +Ответ:
1498 +
1499 +Success
1500 +
1135 1135  (% class="box" lang="en-US" style="text-align: center;" %)
1136 1136  (((
1137 1137  (% 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 г.