<
From version < 77.1 >
edited by Илья Крайнов
on 2023/03/14 14:45
To version < 84.1 >
edited by Илья Крайнов
on 2023/03/29 18:02
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -62,7 +62,7 @@
62 62  (% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -82,7 +82,7 @@
82 82  **GET api/v3/agents/{id}**
83 83  )))
84 84  
85 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
86 86  
87 87  (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
88 88  
... ... @@ -95,7 +95,7 @@
95 95  (% style="color:#000000" %)Ответ:
96 96  А
97 97  {
98 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
98 + "agentId": "", ~/~/ идентификатор клиента    (%%)
99 99   "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 100   "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 101   "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
... ... @@ -124,7 +124,7 @@
124 124  (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
... ... @@ -161,7 +161,7 @@
161 161  **POST /api/v3/agents **
162 162  )))
163 163  
164 -Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
164 +Метод позволяет добавить клиента, указанного в запросе.
165 165  
166 166  Метод запроса: **POST**
167 167  
... ... @@ -224,7 +224,7 @@
224 224  **PUT /api/v3/agents**
225 225  )))
226 226  
227 -Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
227 +Метод позволяет отредактировать клиента, указанного в запросе.
228 228  
229 229  Метод запроса: **PUT**
230 230  
... ... @@ -288,7 +288,7 @@
288 288  **DELETE /api/v3/agents/{clientId}**
289 289  )))
290 290  
291 -Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
291 +Метод позволяет удалить клиента, указанного в строке запроса.
292 292  
293 293  Метод запроса: **DELETE**
294 294  
... ... @@ -309,7 +309,7 @@
309 309  (% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -319,7 +319,8 @@
319 319  
320 320  (% style="color:#000000" %)Параметры в теле запроса (JSON):
321 321  
322 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
323 323   "lastName": "", ~/~/ фамилия
324 324   "firstName": "", ~/~/ имя
325 325   "position": "", ~/~/ должность
... ... @@ -328,17 +328,41 @@
328 328   "login": "", ~/~/ логин (обязателен)
329 329   "password": "", ~/~/ пароль (обязателен)
330 330   "email": "", ~/~/ email (обязателен)
331 - "description": "", ~/~/ описание
332 - "isEnabled": "", ~/~/ признак включения
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
333 333   "parentId": "", ~/~/ Guid родительского агента
334 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
335 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
336 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
337 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
338 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
339 - "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 - Азербайджанский
340 340  }
341 341  
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 +
342 342  (% style="text-align:left" %)
343 343  (% style="color:#000000; font-weight:normal" %)Ответ:
344 344  
... ... @@ -449,7 +449,7 @@
449 449   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
450 450   "description": "", ~/~/ Описание
451 451   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
452 - "doubleAuth":
477 + "doubleAuth":
453 453   {
454 454   "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
455 455   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
... ... @@ -474,7 +474,7 @@
474 474  (% lang="en-US" %)**PUT /api/v3/users**
475 475  )))
476 476  
477 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
478 478  
479 479  (% style="color:#000000" %)Метод запроса: **PUT**
480 480  
... ... @@ -505,7 +505,7 @@
505 505   "parentId": "" , ~/~/ Guid родительского агента
506 506   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
507 507   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
508 - "doubleAuth":
533 + "doubleAuth":
509 509   {
510 510   "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
511 511   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
... ... @@ -536,7 +536,7 @@
536 536   "isEnabled": "" , ~/~/ признак включения
537 537   "parentId": "" , ~/~/ Guid родительского агента
538 538   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
539 - "doubleAuth":
564 + "doubleAuth":
540 540   {
541 541   "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
542 542   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
... ... @@ -555,7 +555,7 @@
555 555  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
556 556  )))
557 557  
558 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
559 559  
560 560  (% style="color:#000000" %)Метод запроса: **PUT**
561 561  
... ... @@ -585,7 +585,7 @@
585 585  **POST /api/v3/users/disable**
586 586  )))
587 587  
588 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
589 589  
590 590  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
591 591  
... ... @@ -607,7 +607,7 @@
607 607  **POST /api/v3/users/enable**
608 608  )))
609 609  
610 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
611 611  
612 612  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
613 613  
... ... @@ -644,7 +644,7 @@
644 644  (% lang="en-US" %)**DELETE /api/v3/users/{id}**
645 645  )))
646 646  
647 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
648 648  
649 649  (% style="color:#000000" %)Метод запроса: **DELETE**
650 650  
... ... @@ -668,7 +668,7 @@
668 668  
669 669  (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
670 670  
671 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
672 672  
673 673  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
674 674  
... ... @@ -738,7 +738,7 @@
738 738  (% lang="en-US" %)**POST /api/v3/vehicles**
739 739  )))
740 740  
741 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
766 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
742 742  
743 743  (% style="color:#000000" %)Метод запроса: **POST**
744 744  
... ... @@ -860,7 +860,7 @@
860 860  
861 861  (% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
862 862  
863 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
864 864  
865 865  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
866 866  
... ... @@ -940,7 +940,7 @@
940 940  (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
941 941  )))
942 942  
943 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
944 944  
945 945  (% style="color:#000000" %)Метод запроса: **POST**
946 946  
... ... @@ -986,7 +986,7 @@
986 986  (% lang="en-US" %)**PUT /api/v3/vehicles**
987 987  )))
988 988  
989 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
990 990  
991 991  (% style="color:#000000" %)Метод запроса: **PUT**
992 992  
... ... @@ -1103,7 +1103,7 @@
1103 1103  (% lang="en-US" style="text-align:left" %)
1104 1104  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1105 1105  
1106 -**валидация:**
1131 +**Валидация:**
1107 1107  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1108 1108  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1109 1109  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
... ... @@ -1115,7 +1115,7 @@
1115 1115  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1116 1116  )))
1117 1117  
1118 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1143 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
1119 1119  
1120 1120  (% style="color:#000000" %)Метод запроса: **DELETE**
1121 1121  
... ... @@ -1137,7 +1137,7 @@
1137 1137  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1138 1138  )))
1139 1139  
1140 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1141 1141  
1142 1142  (% style="color:#000000" %)Метод запроса: **GET**
1143 1143  
... ... @@ -1164,7 +1164,7 @@
1164 1164  (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1165 1165  )))
1166 1166  
1167 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1168 1168  
1169 1169  (% style="color:#000000" %)Метод запроса: **GET**
1170 1170  
... ... @@ -1183,7 +1183,7 @@
1183 1183  (% style="text-align:left" %)
1184 1184  (% style="color:#000000" %)}
1185 1185  
1186 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1187 1187  
1188 1188  == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1189 1189  
... ... @@ -1193,7 +1193,7 @@
1193 1193  )))
1194 1194  
1195 1195  (% style="text-align: left;" %)
1196 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1197 1197  
1198 1198  (% style="text-align: left;" %)
1199 1199  Метод запроса **POST**
... ... @@ -1224,7 +1224,188 @@
1224 1224   }
1225 1225  ]
1226 1226  
1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1227 1227  
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/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{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 successmessage" %)
1415 +(((
1416 +**POST /api/v3/notifications/**
1417 +)))
1418 +
1419 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1420 +
1421 +(% class="box warningmessage" %)
1422 +(((
1423 +**PUT /api/v3/notifications/**
1424 +)))
1425 +
1426 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1427 +
1428 +(% class="box errormessage" %)
1429 +(((
1430 +**DELETE /api/v3/notifications/{id}**
1431 +)))
1432 +
1433 +
1228 1228  (% class="box" lang="en-US" style="text-align: center;" %)
1229 1229  (((
1230 1230  (% 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 г.