Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 29.1 >
edited by Артем Шемяков
on 2022/09/22 10:34
To version < 89.3 >
edited by Илья Крайнов
on 2023/05/22 14:41
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Content
... ... @@ -1,31 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% 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  
... ... @@ -72,18 +72,58 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
86 +
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 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -91,37 +91,184 @@
91 91  
92 92  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
147 +{
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 + "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 111  }
112 112  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
159 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
161 +**POST /api/v3/agents **
117 117  )))
118 118  
164 +Метод позволяет добавить клиента, указанного в запросе.
165 +
166 +Метод запроса: **POST**
167 +
168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
169 +
170 +В заголовках запроса: X-Auth: Токен авторизации
171 +
172 +Параметры в теле запроса (JSON):
173 +
174 +{
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 + "name": "string", ~/~/ имя
177 + "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 + "isForeign": true, ~/~/ иностранный контрагент
180 + "district": "string", ~/~/ округ
181 + "region": "string", ~/~/ регион
182 + "city": "string", ~/~/ город
183 + "inn": "string", ~/~/ ИНН
184 + "kpp": "string", ~/~/ КПП
185 + "address": "string", ~/~/ юридический адрес
186 + "addressFact": "string", ~/~/ фактический адрес
187 + "email": "string", ~/~/ email
188 + "director": "string", ~/~/ ФИО руководителя
189 + "bankName": "string", ~/~/ банк
190 + "bankBIK": "string", ~/~/ БИК
191 + "bankRS": "string", ~/~/ номер счёта
192 + "bankKS": "string" ~/~/ корр. счёт
193 +}
194 +
195 +
196 +Ответ:
197 +
198 +{
199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 + "name": "string", ~/~/ имя
202 + "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 + "isForeign": true, ~/~/ иностранный контрагент
205 + "district": "string", ~/~/ округ
206 + "region": "string", ~/~/ регион
207 + "city": "string", ~/~/ город
208 + "inn": "string", ~/~/ ИНН
209 + "kpp": "string", ~/~/ КПП
210 + "address": "string", ~/~/ юридический адрес
211 + "addressFact": "string", ~/~/ фактический адрес
212 + "email": "string", ~/~/ email
213 + "director": "string", ~/~/ ФИО руководителя
214 + "bankName": "string", ~/~/ банк
215 + "bankBIK": "string", ~/~/ БИК
216 + "bankRS": "string", ~/~/ номер счёта
217 + "bankKS": "string" ~/~/ корр. счёт
218 +}
219 +
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 +
222 +(% class="box warningmessage" %)
223 +(((
224 +**PUT /api/v3/agents**
225 +)))
226 +
227 +Метод позволяет отредактировать клиента, указанного в запросе.
228 +
229 +Метод запроса: **PUT**
230 +
231 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
232 +
233 +В заголовках запроса: X-Auth: Токен авторизации
234 +
235 +
236 +Параметры в теле запроса (JSON):
237 +
238 +{
239 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
240 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
241 + "name": "string", ~/~/ имя
242 + "fullName": "string", ~/~/ полное наименование
243 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
244 + "isForeign": true, ~/~/ иностранный контрагент
245 + "district": "string", ~/~/ округ
246 + "region": "string", ~/~/ регион
247 + "city": "string", ~/~/ город
248 + "inn": "string", ~/~/ ИНН
249 + "kpp": "string", ~/~/ КПП
250 + "address": "string", ~/~/ юридический адрес
251 + "addressFact": "string", ~/~/ фактический адрес
252 + "email": "string", ~/~/ email
253 + "director": "string", ~/~/ ФИО руководителя
254 + "bankName": "string", ~/~/ банк
255 + "bankBIK": "string", ~/~/ БИК
256 + "bankRS": "string", ~/~/ номер счёта
257 + "bankKS": "string" ~/~/ корр. счёт
258 +}
259 +
260 +
261 +Ответ:
262 +
263 +{
264 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
265 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
266 + "name": "string", ~/~/ имя
267 + "fullName": "string", ~/~/ полное наименование
268 + "isForeign": true, ~/~/ иностранный контрагент
269 + "district": "string", ~/~/ округ
270 + "region": "string", ~/~/ регион
271 + "city": "string", ~/~/ город
272 + "inn": "string", ~/~/ ИНН
273 + "kpp": "string", ~/~/ КПП
274 + "address": "string", ~/~/ юридический адрес
275 + "addressFact": "string", ~/~/ фактический адрес
276 + "email": "string", ~/~/ email
277 + "director": "string", ~/~/ ФИО руководителя
278 + "bankName": "string", ~/~/ банк
279 + "bankBIK": "string", ~/~/ БИК
280 + "bankRS": "string", ~/~/ номер счёта
281 + "bankKS": "string" ~/~/ корр. счёт
282 +}
283 +
284 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
285 +
286 +(% class="box errormessage" %)
287 +(((
288 +**DELETE /api/v3/agents/{clientId}**
289 +)))
290 +
291 +Метод позволяет удалить клиента, указанного в строке запроса.
292 +
293 +Метод запроса: **DELETE**
294 +
295 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
296 +
297 +Параметр запроса: **{clientId}** - Guid пользователя
298 +
299 +В заголовках запроса: X-Auth: Токен авторизации
300 +
301 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 +
303 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 +
305 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
306 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -131,26 +131,51 @@
131 131  
132 132  (% style="color:#000000" %)Параметры в теле запроса (JSON):
133 133  
134 -(% style="color:#000000" %){ 
322 +(% style="color:#000000" %)
323 +{ 
135 135   "lastName": "", ~/~/ фамилия
136 136   "firstName": "", ~/~/ имя
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
329 + "login": "", ~/~/ логин (обязателен)
330 + "password": "", ~/~/ пароль (обязателен)
331 + "email": "", ~/~/ email (обязателен)
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
145 145   "parentId": "", ~/~/ Guid родительского агента
146 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
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 - Азербайджанский
152 152  }
153 153  
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 +
154 154  (% style="text-align:left" %)
155 155  (% style="color:#000000; font-weight:normal" %)Ответ:
156 156  
... ... @@ -174,18 +174,19 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -222,17 +222,70 @@
222 222   "email": "" , ~/~/ E-mail
223 223   "sessionDuration":"", ~/~/ длительность сессии в минутах
224 224   "status": "1",  ~/~/ статус пользователя
225 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
226 226  
227 227  (% style="color:#000000" %)}
228 228  
443 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
445 +(% class="box infomessage" %)
446 +(((
447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
448 +)))
449 +
450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
451 +
452 +(% style="color:#000000" %)Метод запроса: **GET**
453 +
454 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
455 +
456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
457 +
458 +(% style="color:#000000" %)Ответ:
459 +
460 +(((
461 +(((
462 +{
463 + "id": "", ~/~/ GUID пользователя
464 + "lastName": "", ~/~/ Фамилия 
465 + "firstName": "", ~/~/ Имя
466 + "position": "", ~/~/ Должность
467 + "phone": "", ~/~/ Номер телефона
468 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
469 + "parentName": "", Наименование клиента, которому принадлежит пользователь
470 + "organization": "", ~/~/ Организация
471 + "login": "", ~/~/ Логин пользователя
472 + "email": "", ~/~/ Адрес электронной почты
473 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
474 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
475 + "description": "", ~/~/ Описание
476 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
482 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
483 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
484 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
485 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
486 + "groups": [], ~/~/ Список ролей пользователя
487 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
488 + "authDevices": [ ], ~/~/ Список авторизованных устройств
489 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
490 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
491 +}
492 +)))
493 +)))
494 +
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
496 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -253,17 +253,22 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
523 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
527 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
528 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 263   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 - "kind": "" , ~/~/ тип аутентификации
266 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
267 267   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
268 268  
269 269  (% lang="en-US" style="text-align:left" %)
... ... @@ -289,8 +289,12 @@
289 289   "isEnabled": "" , ~/~/ признак включения
290 290   "parentId": "" , ~/~/ Guid родительского агента
291 291   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
294 294   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 295   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
296 296  
... ... @@ -297,13 +297,14 @@
297 297  (% lang="en-US" style="text-align:left" %)
298 298  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 299  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
300 300  
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -326,13 +326,73 @@
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
329 329  
608 +(% class="box warningmessage" %)
609 +(((
610 +**POST /api/v3/users/disable**
611 +)))
612 +
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
614 +
615 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
616 +
617 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
618 +
619 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 +
621 + [ 
622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 + ]
625 +
626 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
627 +
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
629 +
630 +(% class="box warningmessage" %)
631 +(((
632 +**POST /api/v3/users/enable**
633 +)))
634 +
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
636 +
637 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
638 +
639 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
640 +
641 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
642 +
643 + [ 
644 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
645 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
646 + ]
647 +
648 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
649 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
650 +
651 +(((
652 +В теле ответа:
653 +{
654 + "errorMessages": [
655 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
656 + ],
657 + "users": [
658 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
659 + ]
660 +}
661 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
662 +"users" - массив id пользователей, которых не удалось включить или отключить.
663 +)))
664 +
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
330 330  (% class="box errormessage" %)
331 331  (((
332 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 333  )))
334 334  
335 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
336 336  
337 337  (% style="color:#000000" %)Метод запроса: **DELETE**
338 338  
... ... @@ -345,20 +345,18 @@
345 345  (% style="text-align:left" %)
346 346  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
347 347  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
348 348  
349 -(% class="box" style="text-align: center;" %)
350 -(((
351 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
352 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
353 353  
354 354  (% class="box infomessage" %)
355 355  (((
356 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
357 357  )))
358 358  
359 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
360 360  
361 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
362 362  
363 363  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
364 364  
... ... @@ -366,30 +366,168 @@
366 366  
367 367  (% style="color:#000000" %)Метод запроса: **GET**
368 368  
369 -(% 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}
370 370  
371 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
372 372  
373 373  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
374 374  
375 375  (% style="color:#000000" %)Ответ:
376 376  
377 -(% style="color:#000000" %){
712 +(((
713 +{
714 + "vehicleId": "", ~/~/ ID объекта
715 + "name": "", ~/~/ Имя объекта
716 + "imei": "", ~/~/ IMEI объекта
717 + "deviceTypeId": , ~/~/ ID типа устройства
718 + "deviceTypeName": "", ~/~/ Название типа устройства
719 + "sim1": "", ~/~/ Номер SIM1
720 + "sim2": "", ~/~/ Номер SIM2
378 378  
379 - "vehicleId": "" , ~/~/ идентификатор объекта
380 - "name": "" , ~/~/ имя объекта
381 - "imei": "" , ~/~/ IMEI объекта
382 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 - "parentId": "" , ~/~/ идентификатор клиента-родителя
385 - "parentName": "" , ~/~/ наименование клиента-родителя,
386 - "modelId": "" , ~/~/ идентификатор модели объекта
387 - "modelName": "" , ~/~/ наименование модели объекта,
388 - "unitId": "" , ~/~/ идентификатор подразделения
389 - "unitName": "" , ~/~/ наименование подразделения
390 - "status": "" , ~/~/ статус объекта
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
391 391  
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
732 + },
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 +
838 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
839 + {
840 + "id": "", ~/~/ ID  задания
841 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
842 + "name": "", ~/~/ Наименование задания
843 + "description": "", ~/~/ Описание задания
844 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
845 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
846 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
847 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
848 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
849 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
850 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
851 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
852 + }
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 +
392 392  }
865 +)))
393 393  
394 394  (% style="text-align:left" %)
395 395  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -397,13 +397,14 @@
397 397  (% style="text-align:left" %)
398 398  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
399 399  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
400 400  
401 401  (% class="box successmessage" %)
402 402  (((
403 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
877 +(% lang="en-US" %)**POST /api/v3/vehicles**
404 404  )))
405 405  
406 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
407 407  
408 408  (% style="color:#000000" %)Метод запроса: **POST**
409 409  
... ... @@ -516,15 +516,16 @@
516 516  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
517 517  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
518 518  
993 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
519 519  
520 -(% class="box successmessage" %)
995 +(% class="box infomessage" %)
521 521  (((
522 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
997 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
523 523  )))
524 524  
525 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1000 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
526 526  
527 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1002 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
528 528  
529 529  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
530 530  
... ... @@ -550,19 +550,19 @@
550 550  
551 551  (% style="color:#000000" %)Параметры в теле запроса (JSON):
552 552  
553 -(% class="western" style="color:#000000" %)##{##
1028 +{
1029 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1030 + "name": null, ~/~/ Имя ТС (string, опционально)
1031 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1032 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1033 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1034 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1035 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1036 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1037 +}
554 554  
555 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
556 - "name": null, ~/~/ Имя ТС (string, опционально) 
557 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
558 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
559 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
560 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
561 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
562 -(% style="color:#000000" %)}
1039 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
563 563  
564 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
565 -
566 566  (% style="color:#000000" %)Ответ:
567 567  
568 568  (% style="color:#000000" %){
... ... @@ -583,18 +583,28 @@
583 583   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
584 584   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
585 585   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
586 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
1061 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1062 + "customFields": [ 
1063 + {
1064 + "id": "", ~/~/ идентификатор произвольного поля
1065 + "name": "", ~/~/ имя произвольного поля
1066 + "value": "", ~/~/ значение произвольного поля
1067 + "forClient": true, ~/~/ право на отображение у клиента
1068 + "forTooltip": false, ~/~/ право на отображение в подсказке
1069 + "forReport": false ~/~/ право на отображение в отчетах
1070 + }(%%)
587 587  (% style="color:#000000" %)}
588 588  
589 589  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
590 590  
1075 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
591 591  
592 592  (% class="box successmessage" %)
593 593  (((
594 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1079 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
595 595  )))
596 596  
597 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1082 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
598 598  
599 599  (% style="color:#000000" %)Метод запроса: **POST**
600 600  
... ... @@ -633,13 +633,14 @@
633 633  (% style="text-align:left" %)
634 634  (% style="color:#000000" %) }
635 635  
1121 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
636 636  
637 637  (% class="box warningmessage" %)
638 638  (((
639 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1125 +(% lang="en-US" %)**PUT /api/v3/vehicles**
640 640  )))
641 641  
642 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1128 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
643 643  
644 644  (% style="color:#000000" %)Метод запроса: **PUT**
645 645  
... ... @@ -660,7 +660,7 @@
660 660   "modelId": "", ~/~/ , ID модели    
661 661   "unitId": "", ~/~/ подразделения
662 662   "sim1": "", ~/~/ SIM 1
663 - "sim2": "", ~/~/ SIM2 (%%)
1149 + "sim2": "", ~/~/ SIM2     (%%)
664 664   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
665 665   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
666 666   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -677,8 +677,8 @@
677 677   {
678 678   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
679 679   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
680 - "mileage": «», пробег
681 - "motohours": «» моточасы
1166 + "mileage": "", ~/~/ пробег, в метрах 
1167 + "motohours": "" ~/~/ моточасы, в секундах
682 682   }
683 683   "cmsv6Parameters": ~/~/ параметры CMSv6
684 684   {       
... ... @@ -756,18 +756,19 @@
756 756  (% lang="en-US" style="text-align:left" %)
757 757  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
758 758  
759 -**валидация:**
1245 +**Валидация:**
760 760  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
761 761  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
762 762  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
763 763  
1250 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
764 764  
765 765  (% class="box errormessage" %)
766 766  (((
767 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1254 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
768 768  )))
769 769  
770 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1257 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
771 771  
772 772  (% style="color:#000000" %)Метод запроса: **DELETE**
773 773  
... ... @@ -780,18 +780,16 @@
780 780  (% style="text-align:left" %)
781 781  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
782 782  
1270 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
783 783  
784 -(% class="box" lang="en-US" style="text-align: center;" %)
785 -(((
786 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
787 -)))
1272 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
788 788  
789 789  (% class="box infomessage" %)
790 790  (((
791 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1276 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
792 792  )))
793 793  
794 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1279 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
795 795  
796 796  (% style="color:#000000" %)Метод запроса: **GET**
797 797  
... ... @@ -809,24 +809,22 @@
809 809  (% style="text-align:left" %)
810 810  (% style="color:#000000" %)}
811 811  
1297 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
812 812  
813 -(% class="box" style="text-align: center;" %)
814 -(((
815 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
816 -)))
1299 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
817 817  
818 818  (% class="box infomessage" %)
819 819  (((
820 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1303 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
821 821  )))
822 822  
823 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1306 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
824 824  
825 825  (% style="color:#000000" %)Метод запроса: **GET**
826 826  
827 827  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
828 828  
829 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1312 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
830 830  
831 831  (% style="color:#000000" %)Ответ:
832 832  
... ... @@ -839,7 +839,296 @@
839 839  (% style="text-align:left" %)
840 840  (% style="color:#000000" %)}
841 841  
1325 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
842 842  
1327 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1328 +
1329 +(% class="box infomessage" style="text-align: left;" %)
1330 +(((
1331 +**POST /api/v3/terminalMessages/count**
1332 +)))
1333 +
1334 +(% style="text-align: left;" %)
1335 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1336 +
1337 +(% style="text-align: left;" %)
1338 +Метод запроса **POST**
1339 +
1340 +(% style="text-align: left;" %)
1341 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1342 +
1343 +(% style="text-align: left;" %)
1344 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1345 +
1346 +(% style="text-align: left;" %)
1347 +{
1348 + "vehicleIds": [
1349 + id ~/~/ здесь передается список идентификаторов объектов
1350 + ],
1351 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1352 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1353 +}
1354 +
1355 +(% style="text-align: left;" %)
1356 +Ответ:
1357 +
1358 +(% style="text-align: left;" %)
1359 +[
1360 + {
1361 + "vehicleId": 0, ~/~/ идентификатор объекта
1362 + "count": 0 ~/~/ количество сообщений за период
1363 + }
1364 +]
1365 +
1366 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1367 +
1368 +(% class="box infomessage" %)
1369 +(((
1370 +**POST /api/v3/terminalMessages**
1371 +)))
1372 +
1373 +Метод возвращает список сообщений терминала объекта за выбранный период.
1374 +
1375 +(% style="text-align: left;" %)
1376 +Метод запроса **POST**
1377 +
1378 +(% style="text-align: left;" %)
1379 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1380 +
1381 +(% style="text-align: left;" %)
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1383 +
1384 +{
1385 + "vehicleId": 0, ~/~/ id объекта
1386 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1387 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1388 +}
1389 +
1390 +Ответ:
1391 +
1392 +[
1393 + {
1394 + "messages": [
1395 + {
1396 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1397 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1398 + "speed": 0, ~/~/ Скорость, км/ч
1399 + "altitude": 0, ~/~/ Высота, м
1400 + "latitude": 0, ~/~/ Широта [-90°;90°]
1401 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1402 + "satellites": 0, ~/~/ Кол-во спутников
1403 + "voltage": 0, ~/~/ Напряжение
1404 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1405 + "additionalProp1": "string",
1406 + "additionalProp2": "string",
1407 + "additionalProp3": "string"
1408 + },
1409 + "photoCount": 0 ~/~/ Кол-во фото
1410 + }
1411 + ]
1412 + }
1413 +]
1414 +
1415 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1416 +
1417 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1418 +
1419 +(% class="box infomessage" %)
1420 +(((
1421 +**POST /api/v3/notifications/find**
1422 +)))
1423 +
1424 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1425 +
1426 +(% style="text-align: left;" %)
1427 +Метод запроса **POST**
1428 +
1429 +(% style="text-align: left;" %)
1430 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1431 +
1432 +(% style="text-align: left;" %)
1433 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1434 +
1435 +{
1436 + "parentId": "" ~/~/ id клиента
1437 +}
1438 +
1439 +Ответ:
1440 +
1441 +[
1442 + {
1443 + "id": 0, ~/~/ ID уведомления
1444 + "name": "string", ~/~/ Название уведомления
1445 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1446 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1447 + "userId": "", ~/~/ Пользователь, создавший уведомление
1448 + "parentId": "", ~/~/ Идентификатор клиента
1449 + "parentName": "string" ~/~/ Имя клиента
1450 + }
1451 +]
1452 +
1453 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1454 +
1455 +(% class="box infomessage" %)
1456 +(((
1457 +**GET /api/v3/notifications/{id}**
1458 +)))
1459 +
1460 +Метод возвращает данные правил формирования выбранного уведомления.
1461 +
1462 +(% style="text-align: left;" %)
1463 +Метод запроса **GET**
1464 +
1465 +(% style="text-align: left;" %)
1466 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1467 +
1468 +(% style="text-align: left;" %)
1469 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1470 +
1471 +(% style="text-align: left;" %)
1472 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1473 +
1474 +(% style="text-align: left;" %)
1475 +(% style="color:#000000" %)Ответ:
1476 +
1477 +(% style="text-align: left;" %)
1478 +(% style="color:#000000" %){
1479 + "id": 0, ~/~/ (%%)id уведомления
1480 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1481 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1482 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1483 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1484 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1485 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1486 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1487 +(% style="color:#000000" %) 0
1488 + ],
1489 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1490 +(% style="color:#000000" %) 0
1491 + ],
1492 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1493 +(% style="color:#000000" %) 0
1494 + ],
1495 + "settings": { ~/~/ Список параметров уведомления
1496 + "additionalProp1": "string",
1497 + "additionalProp2": "string",
1498 + "additionalProp3": "string"
1499 + },
1500 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1501 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1502 +(% style="color:#000000" %) ""
1503 + ],
1504 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1505 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1506 +(% style="color:#000000" %) "string"
1507 + ],
1508 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1509 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1510 +(% style="color:#000000" %) {
1511 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1512 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1513 +(% style="color:#000000" %) }
1514 + ],
1515 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1516 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1517 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1518 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1519 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1520 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1521 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1522 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1523 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1524 +(% style="color:#000000" %)}
1525 +
1526 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1527 +
1528 +(% class="box warningmessage" %)
1529 +(((
1530 +**PUT /api/v3/notifications/**
1531 +)))
1532 +
1533 +Метод позволяет отредактировать уведомление.
1534 +
1535 +Метод запроса **PUT**
1536 +
1537 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1538 +
1539 +В заголовках запроса: X-Auth: Токен авторизации
1540 +
1541 +Тело запроса:
1542 +{
1543 + "id": 0, ~/~/ id уведомления
1544 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1545 + "userId": "", ~/~/ Пользователь, создавший уведомление
1546 + "parentId": "", ~/~/ Идентификатор клиента
1547 + "parentName": "string", ~/~/ Имя клиента
1548 + "name": "string", ~/~/ Название уведомления
1549 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1550 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1551 + 0
1552 + ],
1553 + "geoids": [ ~/~/ Список id геообъектов для анализа
1554 + 0
1555 + ],
1556 + "fieldids": [ ~/~/ Список id полей для анализа
1557 + 0
1558 + ],
1559 + "settings": { ~/~/ Список параметров уведомления
1560 + "additionalProp1": "string",
1561 + "additionalProp2": "string",
1562 + "additionalProp3": "string"
1563 + },
1564 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1565 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1566 + ""
1567 + ],
1568 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1569 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1570 + "string"
1571 + ],
1572 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1573 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1574 + {
1575 + "id": 0, ~/~/ Идентификатор участника чата
1576 + "info": "string" ~/~/ Дополнительные сведения
1577 + }
1578 + ],
1579 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1580 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1581 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1582 + "kind": 0, ~/~/ Определяет вид уведомления
1583 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1584 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1585 + "timezone": 0, ~/~/ Сдвиг часового пояса
1586 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1587 + "autoProlongation": true ~/~/ Автопродление срока действия
1588 +}
1589 +
1590 +Ответ:
1591 +
1592 +Success
1593 +
1594 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1595 +
1596 +(% class="box errormessage" %)
1597 +(((
1598 +**DELETE /api/v3/notifications/{id}**
1599 +)))
1600 +
1601 +Метод позволяет удалить выбранное уведомление.
1602 +
1603 +Метод запроса **DELETE**
1604 +
1605 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1606 +
1607 +Передаваемый параметр: {id} - id уведомления
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Ответ:
1612 +
1613 +Success
1614 +
843 843  (% class="box" lang="en-US" style="text-align: center;" %)
844 844  (((
845 845  (% 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 г.