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

Summary

Details

Icon Page properties
Content
... ... @@ -3,17 +3,12 @@
3 3  **Содержание страницы:**
4 4  )))
5 5  
6 -(% class="western" %)
7 -(((
8 -
9 -)))
10 -
11 11  {{toc/}}
12 12  
13 13  
14 14  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
15 15  
16 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
17 17  
18 18  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
19 19  
... ... @@ -67,7 +67,7 @@
67 67  (% lang="en-US" %)**GET /api/v3/auth/check**
68 68  )))
69 69  
70 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
71 71  
72 72  (% style="color:#000000" %)Метод запроса: **GET**
73 73  
... ... @@ -80,15 +80,57 @@
80 80  
81 81  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
82 82  
83 -== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
84 84  
85 85  (% class="box infomessage" %)
86 86  (((
87 -(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +**GET api/v3/agents/{id}**
88 88  )))
89 89  
90 -(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91 91  
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 +
92 92  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
93 93  
94 94  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
... ... @@ -95,23 +95,26 @@
95 95  
96 96  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
97 97  
98 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
99 99  
100 -(% 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
101 101  
102 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
103 103  
104 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
105 105  
106 106  (% style="color:#000000" %)Ответ:
107 107  
108 -(% style="color:#000000" %){
109 - "agentId": "", ~/~/ идентификатор клиента
110 - "parentId": "", ~/~/ идентификатор клиента-родителя
111 - "name": "", ~/~/ наименование клиента
112 - "fullName": "", ~/~/ полное наименование клиента
113 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
114 - "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 - Отказ)
115 115  }
116 116  
117 117  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
... ... @@ -121,7 +121,7 @@
121 121  **POST /api/v3/agents **
122 122  )))
123 123  
124 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
125 125  
126 126  Метод запроса: **POST**
127 127  
... ... @@ -135,6 +135,7 @@
135 135   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
136 136   "name": "string", ~/~/ имя
137 137   "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
138 138   "isForeign": true, ~/~/ иностранный контрагент
139 139   "district": "string", ~/~/ округ
140 140   "region": "string", ~/~/ регион
... ... @@ -159,6 +159,7 @@
159 159   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
160 160   "name": "string", ~/~/ имя
161 161   "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
162 162   "isForeign": true, ~/~/ иностранный контрагент
163 163   "district": "string", ~/~/ округ
164 164   "region": "string", ~/~/ регион
... ... @@ -182,7 +182,7 @@
182 182  **PUT /api/v3/agents**
183 183  )))
184 184  
185 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
186 186  
187 187  Метод запроса: **PUT**
188 188  
... ... @@ -198,6 +198,7 @@
198 198   "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
199 199   "name": "string", ~/~/ имя
200 200   "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
201 201   "isForeign": true, ~/~/ иностранный контрагент
202 202   "district": "string", ~/~/ округ
203 203   "region": "string", ~/~/ регион
... ... @@ -245,7 +245,7 @@
245 245  **DELETE /api/v3/agents/{clientId}**
246 246  )))
247 247  
248 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
249 249  
250 250  Метод запроса: **DELETE**
251 251  
... ... @@ -266,7 +266,7 @@
266 266  (% lang="en-US" %)**POST /api/v3/users**
267 267  )))
268 268  
269 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
270 270  
271 271  (% style="color:#000000" %)Метод запроса: **POST**
272 272  
... ... @@ -276,7 +276,8 @@
276 276  
277 277  (% style="color:#000000" %)Параметры в теле запроса (JSON):
278 278  
279 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
280 280   "lastName": "", ~/~/ фамилия
281 281   "firstName": "", ~/~/ имя
282 282   "position": "", ~/~/ должность
... ... @@ -285,17 +285,41 @@
285 285   "login": "", ~/~/ логин (обязателен)
286 286   "password": "", ~/~/ пароль (обязателен)
287 287   "email": "", ~/~/ email (обязателен)
288 - "description": "", ~/~/ описание
289 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
290 290   "parentId": "", ~/~/ Guid родительского агента
291 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
292 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
293 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
294 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
295 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
296 - "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 - Азербайджанский
297 297  }
298 298  
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 +
299 299  (% style="text-align:left" %)
300 300  (% style="color:#000000; font-weight:normal" %)Ответ:
301 301  
... ... @@ -326,7 +326,7 @@
326 326  
327 327  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
328 328  
329 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
330 330  (((
331 331  (% lang="en-US" %)**POST /api/v3/users/find**
332 332  )))
... ... @@ -368,13 +368,13 @@
368 368   "email": "" , ~/~/ E-mail
369 369   "sessionDuration":"", ~/~/ длительность сессии в минутах
370 370   "status": "1",  ~/~/ статус пользователя
371 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
372 372  
373 373  (% style="color:#000000" %)}
374 374  
375 375  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
376 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 - блокирован
... ... @@ -428,7 +428,7 @@
428 428  (% lang="en-US" %)**PUT /api/v3/users**
429 429  )))
430 430  
431 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
432 432  
433 433  (% style="color:#000000" %)Метод запроса: **PUT**
434 434  
... ... @@ -450,7 +450,9 @@
450 450   "phone": "" , ~/~/ телефон
451 451   "organization": "" , ~/~/ организация
452 452   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
453 -(% 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 - отключено
454 454   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
455 455  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
456 456   "isEnabled": "" , ~/~/ признак включения
... ... @@ -457,9 +457,12 @@
457 457   "parentId": "" , ~/~/ Guid родительского агента
458 458   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
459 459   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
460 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
461 - "kind": "" , ~/~/ тип аутентификации
462 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
463 463   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
464 464  
465 465  (% lang="en-US" style="text-align:left" %)
... ... @@ -485,8 +485,12 @@
485 485   "isEnabled": "" , ~/~/ признак включения
486 486   "parentId": "" , ~/~/ Guid родительского агента
487 487   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
488 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
489 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
490 490   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
491 491   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
492 492  
... ... @@ -500,7 +500,7 @@
500 500  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
501 501  )))
502 502  
503 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
504 504  
505 505  (% style="color:#000000" %)Метод запроса: **PUT**
506 506  
... ... @@ -530,7 +530,7 @@
530 530  **POST /api/v3/users/disable**
531 531  )))
532 532  
533 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
534 534  
535 535  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
536 536  
... ... @@ -552,7 +552,7 @@
552 552  **POST /api/v3/users/enable**
553 553  )))
554 554  
555 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
556 556  
557 557  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
558 558  
... ... @@ -589,7 +589,7 @@
589 589  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
590 590  )))
591 591  
592 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
593 593  
594 594  (% style="color:#000000" %)Метод запроса: **DELETE**
595 595  
... ... @@ -613,7 +613,7 @@
613 613  
614 614  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
615 615  
616 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
617 617  
618 618  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
619 619  
... ... @@ -621,9 +621,9 @@
621 621  
622 622  (% style="color:#000000" %)Метод запроса: **GET**
623 623  
624 -(% 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}
625 625  
626 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
627 627  
628 628  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
629 629  
... ... @@ -637,18 +637,124 @@
637 637   "deviceTypeId": , ~/~/ ID типа устройства
638 638   "deviceTypeName": "", ~/~/ Название типа устройства
639 639   "sim1": "", ~/~/ Номер SIM1
640 - "parentId": "", Номер SIM2
641 - "parentName": "", Наименование клиента-родителя
642 - "modelId": "", ID модели объекта
643 - "modelName": "", Имя модели объекта
644 - "createdAt": "", Дата создания объекта
645 - "mileageCalcMethod": "", Выбранный метод расчета пробега
646 - "counters": { ~/~/ Нормы
647 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
648 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
649 - "mileage": "", ~/~/ Пробег по нормам в метрах
650 - "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": "", ~/~/ Дата создания объекта
651 651   },
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 +
652 652   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
653 653   {
654 654   "id": "", ~/~/ ID  задания
... ... @@ -664,7 +664,17 @@
664 664   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
665 665   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
666 666   }
667 - ]
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 +
668 668  }
669 669  )))
670 670  
... ... @@ -681,7 +681,7 @@
681 681  (% lang="en-US" %)**POST /api/v3/vehicles**
682 682  )))
683 683  
684 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
685 685  
686 686  (% style="color:#000000" %)Метод запроса: **POST**
687 687  
... ... @@ -713,6 +713,11 @@
713 713   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
714 714   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
715 715   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
716 716   "counters": ~/~/ счетчики
717 717   {
718 718   "mileage": "" , ~/~/ пробег
... ... @@ -742,7 +742,72 @@
742 742   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
743 743   }
744 744  
745 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
746 746  
747 747  (% style="color:#000000" %)Ответ:
748 748  
... ... @@ -796,7 +796,7 @@
796 796  
797 797  == (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
798 798  
799 -(% class="box successmessage" %)
1065 +(% class="box infomessage" %)
800 800  (((
801 801  (% lang="en-US" %)**POST /api/v3/vehicles/find**
802 802  )))
... ... @@ -803,7 +803,7 @@
803 803  
804 804  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
805 805  
806 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1072 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
807 807  
808 808  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
809 809  
... ... @@ -883,7 +883,7 @@
883 883  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
884 884  )))
885 885  
886 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1152 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
887 887  
888 888  (% style="color:#000000" %)Метод запроса: **POST**
889 889  
... ... @@ -929,7 +929,7 @@
929 929  (% lang="en-US" %)**PUT /api/v3/vehicles**
930 930  )))
931 931  
932 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
933 933  
934 934  (% style="color:#000000" %)Метод запроса: **PUT**
935 935  
... ... @@ -1046,7 +1046,7 @@
1046 1046  (% lang="en-US" style="text-align:left" %)
1047 1047  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1048 1048  
1049 -**валидация:**
1315 +**Валидация:**
1050 1050  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1051 1051  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1052 1052  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1058,7 +1058,7 @@
1058 1058  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1059 1059  )))
1060 1060  
1061 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1327 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1062 1062  
1063 1063  (% style="color:#000000" %)Метод запроса: **DELETE**
1064 1064  
... ... @@ -1080,7 +1080,7 @@
1080 1080  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1081 1081  )))
1082 1082  
1083 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1349 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1084 1084  
1085 1085  (% style="color:#000000" %)Метод запроса: **GET**
1086 1086  
... ... @@ -1107,13 +1107,13 @@
1107 1107  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1108 1108  )))
1109 1109  
1110 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1376 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1111 1111  
1112 1112  (% style="color:#000000" %)Метод запроса: **GET**
1113 1113  
1114 1114  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1115 1115  
1116 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1117 1117  
1118 1118  (% style="color:#000000" %)Ответ:
1119 1119  
... ... @@ -1126,7 +1126,296 @@
1126 1126  (% style="text-align:left" %)
1127 1127  (% style="color:#000000" %)}
1128 1128  
1395 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1129 1129  
1397 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1398 +
1399 +(% class="box infomessage" style="text-align: left;" %)
1400 +(((
1401 +**POST /api/v3/terminalMessages/count**
1402 +)))
1403 +
1404 +(% style="text-align: left;" %)
1405 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1406 +
1407 +(% style="text-align: left;" %)
1408 +Метод запроса **POST**
1409 +
1410 +(% style="text-align: left;" %)
1411 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1412 +
1413 +(% style="text-align: left;" %)
1414 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1415 +
1416 +(% style="text-align: left;" %)
1417 +{
1418 + "vehicleIds": [
1419 + id ~/~/ здесь передается список идентификаторов объектов
1420 + ],
1421 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1422 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1423 +}
1424 +
1425 +(% style="text-align: left;" %)
1426 +Ответ:
1427 +
1428 +(% style="text-align: left;" %)
1429 +[
1430 + {
1431 + "vehicleId": 0, ~/~/ идентификатор объекта
1432 + "count": 0 ~/~/ количество сообщений за период
1433 + }
1434 +]
1435 +
1436 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1437 +
1438 +(% class="box infomessage" %)
1439 +(((
1440 +**POST /api/v3/terminalMessages**
1441 +)))
1442 +
1443 +Метод возвращает список сообщений терминала объекта за выбранный период.
1444 +
1445 +(% style="text-align: left;" %)
1446 +Метод запроса **POST**
1447 +
1448 +(% style="text-align: left;" %)
1449 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1450 +
1451 +(% style="text-align: left;" %)
1452 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1453 +
1454 +{
1455 + "vehicleId": 0, ~/~/ id объекта
1456 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1457 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1458 +}
1459 +
1460 +Ответ:
1461 +
1462 +[
1463 + {
1464 + "messages": [
1465 + {
1466 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1467 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1468 + "speed": 0, ~/~/ Скорость, км/ч
1469 + "altitude": 0, ~/~/ Высота, м
1470 + "latitude": 0, ~/~/ Широта [-90°;90°]
1471 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1472 + "satellites": 0, ~/~/ Кол-во спутников
1473 + "voltage": 0, ~/~/ Напряжение
1474 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1475 + "additionalProp1": "string",
1476 + "additionalProp2": "string",
1477 + "additionalProp3": "string"
1478 + },
1479 + "photoCount": 0 ~/~/ Кол-во фото
1480 + }
1481 + ]
1482 + }
1483 +]
1484 +
1485 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1486 +
1487 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1488 +
1489 +(% class="box infomessage" %)
1490 +(((
1491 +**POST /api/v3/notifications/find**
1492 +)))
1493 +
1494 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1495 +
1496 +(% style="text-align: left;" %)
1497 +Метод запроса **POST**
1498 +
1499 +(% style="text-align: left;" %)
1500 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1501 +
1502 +(% style="text-align: left;" %)
1503 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1504 +
1505 +{
1506 + "parentId": "" ~/~/ id клиента
1507 +}
1508 +
1509 +Ответ:
1510 +
1511 +[
1512 + {
1513 + "id": 0, ~/~/ ID уведомления
1514 + "name": "string", ~/~/ Название уведомления
1515 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1516 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1517 + "userId": "", ~/~/ Пользователь, создавший уведомление
1518 + "parentId": "", ~/~/ Идентификатор клиента
1519 + "parentName": "string" ~/~/ Имя клиента
1520 + }
1521 +]
1522 +
1523 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1524 +
1525 +(% class="box infomessage" %)
1526 +(((
1527 +**GET /api/v3/notifications/{id}**
1528 +)))
1529 +
1530 +Метод возвращает данные правил формирования выбранного уведомления.
1531 +
1532 +(% style="text-align: left;" %)
1533 +Метод запроса **GET**
1534 +
1535 +(% style="text-align: left;" %)
1536 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1537 +
1538 +(% style="text-align: left;" %)
1539 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1540 +
1541 +(% style="text-align: left;" %)
1542 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1543 +
1544 +(% style="text-align: left;" %)
1545 +(% style="color:#000000" %)Ответ:
1546 +
1547 +(% style="text-align: left;" %)
1548 +(% style="color:#000000" %){
1549 + "id": 0, ~/~/ (%%)id уведомления
1550 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1551 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1552 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1553 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1554 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1555 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1556 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1557 +(% style="color:#000000" %) 0
1558 + ],
1559 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1560 +(% style="color:#000000" %) 0
1561 + ],
1562 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1563 +(% style="color:#000000" %) 0
1564 + ],
1565 + "settings": { ~/~/ Список параметров уведомления
1566 + "additionalProp1": "string",
1567 + "additionalProp2": "string",
1568 + "additionalProp3": "string"
1569 + },
1570 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1571 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1572 +(% style="color:#000000" %) ""
1573 + ],
1574 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1575 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1576 +(% style="color:#000000" %) "string"
1577 + ],
1578 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1579 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1580 +(% style="color:#000000" %) {
1581 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1582 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1583 +(% style="color:#000000" %) }
1584 + ],
1585 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1586 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1587 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1588 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1589 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1590 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1591 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1592 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1593 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1594 +(% style="color:#000000" %)}
1595 +
1596 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1597 +
1598 +(% class="box warningmessage" %)
1599 +(((
1600 +**PUT /api/v3/notifications/**
1601 +)))
1602 +
1603 +Метод позволяет отредактировать уведомление.
1604 +
1605 +Метод запроса **PUT**
1606 +
1607 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Тело запроса:
1612 +{
1613 + "id": 0, ~/~/ id уведомления
1614 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1615 + "userId": "", ~/~/ Пользователь, создавший уведомление
1616 + "parentId": "", ~/~/ Идентификатор клиента
1617 + "parentName": "string", ~/~/ Имя клиента
1618 + "name": "string", ~/~/ Название уведомления
1619 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1620 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1621 + 0
1622 + ],
1623 + "geoids": [ ~/~/ Список id геообъектов для анализа
1624 + 0
1625 + ],
1626 + "fieldids": [ ~/~/ Список id полей для анализа
1627 + 0
1628 + ],
1629 + "settings": { ~/~/ Список параметров уведомления
1630 + "additionalProp1": "string",
1631 + "additionalProp2": "string",
1632 + "additionalProp3": "string"
1633 + },
1634 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1635 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1636 + ""
1637 + ],
1638 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1639 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1640 + "string"
1641 + ],
1642 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1643 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1644 + {
1645 + "id": 0, ~/~/ Идентификатор участника чата
1646 + "info": "string" ~/~/ Дополнительные сведения
1647 + }
1648 + ],
1649 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1650 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1651 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1652 + "kind": 0, ~/~/ Определяет вид уведомления
1653 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1654 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1655 + "timezone": 0, ~/~/ Сдвиг часового пояса
1656 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1657 + "autoProlongation": true ~/~/ Автопродление срока действия
1658 +}
1659 +
1660 +Ответ:
1661 +
1662 +Success
1663 +
1664 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1665 +
1666 +(% class="box errormessage" %)
1667 +(((
1668 +**DELETE /api/v3/notifications/{id}**
1669 +)))
1670 +
1671 +Метод позволяет удалить выбранное уведомление.
1672 +
1673 +Метод запроса **DELETE**
1674 +
1675 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1676 +
1677 +Передаваемый параметр: {id} - id уведомления
1678 +
1679 +В заголовках запроса: X-Auth: Токен авторизации
1680 +
1681 +Ответ:
1682 +
1683 +Success
1684 +
1130 1130  (% class="box" lang="en-US" style="text-align: center;" %)
1131 1131  (((
1132 1132  (% 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 г.