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

Summary

Details

Icon Page properties
Content
... ... @@ -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,7 +131,8 @@
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": "", ~/~/ должность
... ... @@ -140,17 +140,41 @@
140 140   "login": "", ~/~/ логин (обязателен)
141 141   "password": "", ~/~/ пароль (обязателен)
142 142   "email": "", ~/~/ email (обязателен)
143 - "description": "", ~/~/ описание
144 - "isEnabled": "", ~/~/ признак включения
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": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (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 - Азербайджанский
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  
... ... @@ -179,13 +179,14 @@
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,139 +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  
230 -(% class="box successmessage" %)
445 +(% class="box infomessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
447 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
450 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
239 239  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 240  
456 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
457 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 -{
245 -)))
246 -
247 247  (((
462 +{
248 248   "id": "", ~/~/ GUID пользователя
249 -)))
250 -
251 -(((
252 - "lastName": "", ~/~/ Фамилия
253 -)))
254 -
255 -(((
464 + "lastName": "", ~/~/ Фамилия 
256 256   "firstName": "", ~/~/ Имя
257 -)))
258 -
259 -(((
260 260   "position": "", ~/~/ Должность
261 -)))
262 -
263 -(((
264 264   "phone": "", ~/~/ Номер телефона
265 -)))
266 -
267 -(((
268 268   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 -)))
270 -
271 -(((
272 272   "parentName": "", Наименование клиента, которому принадлежит пользователь
273 -)))
274 -
275 -(((
276 276   "organization": "", ~/~/ Организация
277 -)))
278 -
279 -(((
280 280   "login": "", ~/~/ Логин пользователя
281 -)))
282 -
283 -(((
284 284   "email": "", ~/~/ Адрес электронной почты
285 -)))
286 -
287 -(((
288 288   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 -)))
290 -
291 -(((
292 292   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 -)))
294 -
295 -(((
296 296   "description": "", ~/~/ Описание
297 -)))
298 -
299 -(((
300 300   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 -)))
302 -
303 -(((
304 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 -)))
306 -
307 -(((
308 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 -)))
310 -
311 -(((
477 + "doubleAuth":
478 + {
479 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
480 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
481 + },
312 312   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 -)))
314 -
315 -(((
316 316   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 -)))
318 -
319 -(((
320 320   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 -)))
322 -
323 -(((
324 324   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 -)))
326 -
327 -(((
328 328   "groups": [], ~/~/ Список ролей пользователя
329 -)))
330 -
331 -(((
332 332   "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 -)))
334 -
335 -(((
336 336   "authDevices": [ ], ~/~/ Список авторизованных устройств
337 -)))
338 -
339 -(((
340 340   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 -)))
342 -
343 -(((
344 344   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 -)))
346 -
347 -(((
348 348  }
349 349  )))
493 +)))
350 350  
495 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
351 351  
352 352  (% class="box warningmessage" %)
353 353  (((
354 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
355 355  )))
356 356  
357 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
358 358  
359 359  (% style="color:#000000" %)Метод запроса: **PUT**
360 360  
... ... @@ -376,7 +376,9 @@
376 376   "phone": "" , ~/~/ телефон
377 377   "organization": "" , ~/~/ организация
378 378   "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
379 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
524 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
525 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
526 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
380 380   "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
381 381  (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
382 382   "isEnabled": "" , ~/~/ признак включения
... ... @@ -383,9 +383,12 @@
383 383   "parentId": "" , ~/~/ Guid родительского агента
384 384   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
385 385   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
386 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
387 - "kind": "" , ~/~/ тип аутентификации
388 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
533 + "doubleAuth":
534 + {
535 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 + },
538 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
389 389   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 390  
391 391  (% lang="en-US" style="text-align:left" %)
... ... @@ -411,8 +411,12 @@
411 411   "isEnabled": "" , ~/~/ признак включения
412 412   "parentId": "" , ~/~/ Guid родительского агента
413 413   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
414 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
415 - "kind": "" , ~/~/ тип аутентификации
564 + "doubleAuth":
565 + {
566 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 + },
569 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
416 416   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
417 417   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
418 418  
... ... @@ -419,13 +419,14 @@
419 419  (% lang="en-US" style="text-align:left" %)
420 420  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
421 421  
576 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
422 422  
423 423  (% class="box warningmessage" %)
424 424  (((
425 -(% 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}**
426 426  )))
427 427  
428 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -448,13 +448,14 @@
448 448  (% style="text-align:left" %)
449 449  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
450 450  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
451 451  
452 452  (% class="box warningmessage" %)
453 453  (((
454 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
610 +**POST /api/v3/users/disable**
455 455  )))
456 456  
457 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
613 +Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
458 458  
459 459  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
460 460  
... ... @@ -469,13 +469,14 @@
469 469  
470 470  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
471 471  
628 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
472 472  
473 473  (% class="box warningmessage" %)
474 474  (((
475 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
632 +**POST /api/v3/users/enable**
476 476  )))
477 477  
478 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
635 +Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
479 479  
480 480  (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
481 481  
... ... @@ -503,15 +503,16 @@
503 503  }
504 504  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
505 505  "users" - массив id пользователей, которых не удалось включить или отключить.
506 -
507 507  )))
508 508  
665 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
666 +
509 509  (% class="box errormessage" %)
510 510  (((
511 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **DELETE**
517 517  
... ... @@ -524,20 +524,18 @@
524 524  (% style="text-align:left" %)
525 525  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
526 526  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
527 527  
528 -(% class="box" style="text-align: center;" %)
529 -(((
530 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
531 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
532 532  
533 533  (% class="box infomessage" %)
534 534  (((
535 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
536 536  )))
537 537  
538 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
539 539  
540 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
541 541  
542 542  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
543 543  
... ... @@ -545,9 +545,9 @@
545 545  
546 546  (% style="color:#000000" %)Метод запроса: **GET**
547 547  
548 -(% 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}
549 549  
550 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
551 551  
552 552  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
553 553  
... ... @@ -555,145 +555,156 @@
555 555  
556 556  (((
557 557  {
558 -)))
559 -
560 -(((
561 561   "vehicleId": "", ~/~/ ID объекта
562 -)))
563 -
564 -(((
565 565   "name": "", ~/~/ Имя объекта
566 -)))
567 -
568 -(((
569 569   "imei": "", ~/~/ IMEI объекта
570 -)))
571 -
572 -(((
573 573   "deviceTypeId": , ~/~/ ID типа устройства
574 -)))
575 -
576 -(((
577 577   "deviceTypeName": "", ~/~/ Название типа устройства
578 -)))
579 -
580 -(((
581 581   "sim1": "", ~/~/ Номер SIM1
582 -)))
720 + "sim2": "", ~/~/ Номер SIM2
583 583  
584 -(((
585 - "parentId": "", Номер SIM2
586 -)))
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
587 587  
588 -(((
589 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 -)))
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
591 591  
592 -(((
593 - "modelId": "", ID модели объекта
594 -)))
731 + "createdAt": "", ~/~/ Дата создания объекта
732 + },
595 595  
596 -(((
597 - "modelName": "", Имя модели объекта
598 -)))
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 + }
599 599  
600 -(((
601 - "createdAt": "", Дата создания объекта
602 -)))
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": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
603 603  
604 -(((
605 - "mileageCalcMethod": "", Выбранный метод расчета пробега
606 -)))
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 + },
607 607  
608 -(((
609 - "counters": { ~/~/ Нормы
610 -)))
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 + },
611 611  
612 -(((
613 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
614 -)))
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
615 615  
616 -(((
617 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
618 -)))
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 + }
619 619  
620 -(((
621 - "mileage": "", ~/~/ Пробег по нормам в метрах
622 -)))
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
623 623  
624 -(((
625 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
626 -)))
627 -
628 -(((
629 - },
630 -)))
631 -
632 -(((
633 633   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 -)))
635 -
636 -(((
637 637   {
638 -)))
639 -
640 -(((
641 - "id": "", ~/~/ ID  задания
642 -)))
643 -
644 -(((
840 + "id": "", ~/~/ ID  задания
645 645   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 -)))
647 -
648 -(((
649 649   "name": "", ~/~/ Наименование задания
650 -)))
651 -
652 -(((
653 653   "description": "", ~/~/ Описание задания
654 -)))
655 -
656 -(((
657 657   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 -)))
659 -
660 -(((
661 661   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 -)))
663 -
664 -(((
665 665   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 -)))
667 -
668 -(((
669 669   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 -)))
671 -
672 -(((
673 673   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 -)))
675 -
676 -(((
677 677   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 -)))
679 -
680 -(((
681 681   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
682 -)))
683 -
684 -(((
685 685   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
686 -)))
687 -
688 -(((
689 689   }
690 -)))
853 + ],
691 691  
692 -(((
693 - ]
694 -)))
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
695 695  
696 -(((
697 697  }
698 698  )))
699 699  
... ... @@ -703,13 +703,14 @@
703 703  (% style="text-align:left" %)
704 704  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
705 705  
873 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
706 706  
707 707  (% class="box successmessage" %)
708 708  (((
709 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
877 +(% lang="en-US" %)**POST /api/v3/vehicles**
710 710  )))
711 711  
712 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
713 713  
714 714  (% style="color:#000000" %)Метод запроса: **POST**
715 715  
... ... @@ -741,6 +741,11 @@
741 741   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
742 742   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
743 743   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
744 744   "counters": ~/~/ счетчики
745 745   {
746 746   "mileage": "" , ~/~/ пробег
... ... @@ -770,7 +770,72 @@
770 770   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
771 771   }
772 772  
773 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
774 774  
775 775  (% style="color:#000000" %)Ответ:
776 776  
... ... @@ -822,15 +822,16 @@
822 822  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
823 823  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
824 824  
1063 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
825 825  
826 -(% class="box successmessage" %)
1065 +(% class="box infomessage" %)
827 827  (((
828 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1067 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
829 829  )))
830 830  
831 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1070 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
832 832  
833 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
1072 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
834 834  
835 835  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
836 836  
... ... @@ -856,19 +856,19 @@
856 856  
857 857  (% style="color:#000000" %)Параметры в теле запроса (JSON):
858 858  
859 -(% class="western" style="color:#000000" %)##{##
1098 +{
1099 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1100 + "name": null, ~/~/ Имя ТС (string, опционально)
1101 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1102 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1103 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1104 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1105 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1106 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1107 +}
860 860  
861 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
862 - "name": null, ~/~/ Имя ТС (string, опционально) 
863 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
864 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
865 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
866 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
867 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
868 -(% style="color:#000000" %)}
1109 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
869 869  
870 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
871 -
872 872  (% style="color:#000000" %)Ответ:
873 873  
874 874  (% style="color:#000000" %){
... ... @@ -889,18 +889,28 @@
889 889   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
890 890   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
891 891   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
892 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
1131 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1132 + "customFields": [ 
1133 + {
1134 + "id": "", ~/~/ идентификатор произвольного поля
1135 + "name": "", ~/~/ имя произвольного поля
1136 + "value": "", ~/~/ значение произвольного поля
1137 + "forClient": true, ~/~/ право на отображение у клиента
1138 + "forTooltip": false, ~/~/ право на отображение в подсказке
1139 + "forReport": false ~/~/ право на отображение в отчетах
1140 + }(%%)
893 893  (% style="color:#000000" %)}
894 894  
895 895  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
896 896  
1145 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
897 897  
898 898  (% class="box successmessage" %)
899 899  (((
900 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1149 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
901 901  )))
902 902  
903 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1152 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
904 904  
905 905  (% style="color:#000000" %)Метод запроса: **POST**
906 906  
... ... @@ -939,13 +939,14 @@
939 939  (% style="text-align:left" %)
940 940  (% style="color:#000000" %) }
941 941  
1191 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
942 942  
943 943  (% class="box warningmessage" %)
944 944  (((
945 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1195 +(% lang="en-US" %)**PUT /api/v3/vehicles**
946 946  )))
947 947  
948 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
949 949  
950 950  (% style="color:#000000" %)Метод запроса: **PUT**
951 951  
... ... @@ -1062,18 +1062,19 @@
1062 1062  (% lang="en-US" style="text-align:left" %)
1063 1063  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1064 1064  
1065 -**валидация:**
1315 +**Валидация:**
1066 1066  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1067 1067  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1068 1068  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1069 1069  
1320 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1070 1070  
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1324 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1074 1074  )))
1075 1075  
1076 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1327 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1077 1077  
1078 1078  (% style="color:#000000" %)Метод запроса: **DELETE**
1079 1079  
... ... @@ -1086,18 +1086,16 @@
1086 1086  (% style="text-align:left" %)
1087 1087  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1088 1088  
1340 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1089 1089  
1090 -(% class="box" lang="en-US" style="text-align: center;" %)
1091 -(((
1092 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1093 -)))
1342 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1094 1094  
1095 1095  (% class="box infomessage" %)
1096 1096  (((
1097 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1346 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1098 1098  )))
1099 1099  
1100 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1349 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1101 1101  
1102 1102  (% style="color:#000000" %)Метод запроса: **GET**
1103 1103  
... ... @@ -1115,24 +1115,22 @@
1115 1115  (% style="text-align:left" %)
1116 1116  (% style="color:#000000" %)}
1117 1117  
1367 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1118 1118  
1119 -(% class="box" style="text-align: center;" %)
1120 -(((
1121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1122 -)))
1369 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1123 1123  
1124 1124  (% class="box infomessage" %)
1125 1125  (((
1126 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1373 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1127 1127  )))
1128 1128  
1129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1376 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
1130 1130  
1131 1131  (% style="color:#000000" %)Метод запроса: **GET**
1132 1132  
1133 1133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1134 1134  
1135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1382 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1136 1136  
1137 1137  (% style="color:#000000" %)Ответ:
1138 1138  
... ... @@ -1145,7 +1145,296 @@
1145 1145  (% style="text-align:left" %)
1146 1146  (% style="color:#000000" %)}
1147 1147  
1395 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1148 1148  
1397 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1398 +
1399 +(% class="box infomessage" style="text-align: left;" %)
1400 +(((
1401 +**POST /api/v3/terminalMessages/count**
1402 +)))
1403 +
1404 +(% style="text-align: left;" %)
1405 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1406 +
1407 +(% style="text-align: left;" %)
1408 +Метод запроса **POST**
1409 +
1410 +(% style="text-align: left;" %)
1411 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1412 +
1413 +(% style="text-align: left;" %)
1414 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1415 +
1416 +(% style="text-align: left;" %)
1417 +{
1418 + "vehicleIds": [
1419 + id ~/~/ здесь передается список идентификаторов объектов
1420 + ],
1421 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1422 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1423 +}
1424 +
1425 +(% style="text-align: left;" %)
1426 +Ответ:
1427 +
1428 +(% style="text-align: left;" %)
1429 +[
1430 + {
1431 + "vehicleId": 0, ~/~/ идентификатор объекта
1432 + "count": 0 ~/~/ количество сообщений за период
1433 + }
1434 +]
1435 +
1436 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1437 +
1438 +(% class="box infomessage" %)
1439 +(((
1440 +**POST /api/v3/terminalMessages**
1441 +)))
1442 +
1443 +Метод возвращает список сообщений терминала объекта за выбранный период.
1444 +
1445 +(% style="text-align: left;" %)
1446 +Метод запроса **POST**
1447 +
1448 +(% style="text-align: left;" %)
1449 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
1450 +
1451 +(% style="text-align: left;" %)
1452 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1453 +
1454 +{
1455 + "vehicleId": 0, ~/~/ id объекта
1456 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1457 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1458 +}
1459 +
1460 +Ответ:
1461 +
1462 +[
1463 + {
1464 + "messages": [
1465 + {
1466 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1467 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1468 + "speed": 0, ~/~/ Скорость, км/ч
1469 + "altitude": 0, ~/~/ Высота, м
1470 + "latitude": 0, ~/~/ Широта [-90°;90°]
1471 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1472 + "satellites": 0, ~/~/ Кол-во спутников
1473 + "voltage": 0, ~/~/ Напряжение
1474 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1475 + "additionalProp1": "string",
1476 + "additionalProp2": "string",
1477 + "additionalProp3": "string"
1478 + },
1479 + "photoCount": 0 ~/~/ Кол-во фото
1480 + }
1481 + ]
1482 + }
1483 +]
1484 +
1485 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1486 +
1487 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1488 +
1489 +(% class="box infomessage" %)
1490 +(((
1491 +**POST /api/v3/notifications/find**
1492 +)))
1493 +
1494 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1495 +
1496 +(% style="text-align: left;" %)
1497 +Метод запроса **POST**
1498 +
1499 +(% style="text-align: left;" %)
1500 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1501 +
1502 +(% style="text-align: left;" %)
1503 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1504 +
1505 +{
1506 + "parentId": "" ~/~/ id клиента
1507 +}
1508 +
1509 +Ответ:
1510 +
1511 +[
1512 + {
1513 + "id": 0, ~/~/ ID уведомления
1514 + "name": "string", ~/~/ Название уведомления
1515 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1516 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1517 + "userId": "", ~/~/ Пользователь, создавший уведомление
1518 + "parentId": "", ~/~/ Идентификатор клиента
1519 + "parentName": "string" ~/~/ Имя клиента
1520 + }
1521 +]
1522 +
1523 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1524 +
1525 +(% class="box infomessage" %)
1526 +(((
1527 +**GET /api/v3/notifications/{id}**
1528 +)))
1529 +
1530 +Метод возвращает данные правил формирования выбранного уведомления.
1531 +
1532 +(% style="text-align: left;" %)
1533 +Метод запроса **GET**
1534 +
1535 +(% style="text-align: left;" %)
1536 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1537 +
1538 +(% style="text-align: left;" %)
1539 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1540 +
1541 +(% style="text-align: left;" %)
1542 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1543 +
1544 +(% style="text-align: left;" %)
1545 +(% style="color:#000000" %)Ответ:
1546 +
1547 +(% style="text-align: left;" %)
1548 +(% style="color:#000000" %){
1549 + "id": 0, ~/~/ (%%)id уведомления
1550 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1551 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1552 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1553 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1554 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1555 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1556 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1557 +(% style="color:#000000" %) 0
1558 + ],
1559 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1560 +(% style="color:#000000" %) 0
1561 + ],
1562 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1563 +(% style="color:#000000" %) 0
1564 + ],
1565 + "settings": { ~/~/ Список параметров уведомления
1566 + "additionalProp1": "string",
1567 + "additionalProp2": "string",
1568 + "additionalProp3": "string"
1569 + },
1570 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1571 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1572 +(% style="color:#000000" %) ""
1573 + ],
1574 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1575 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1576 +(% style="color:#000000" %) "string"
1577 + ],
1578 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1579 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1580 +(% style="color:#000000" %) {
1581 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1582 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1583 +(% style="color:#000000" %) }
1584 + ],
1585 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1586 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1587 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1588 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1589 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1590 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1591 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1592 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1593 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1594 +(% style="color:#000000" %)}
1595 +
1596 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1597 +
1598 +(% class="box warningmessage" %)
1599 +(((
1600 +**PUT /api/v3/notifications/**
1601 +)))
1602 +
1603 +Метод позволяет отредактировать уведомление.
1604 +
1605 +Метод запроса **PUT**
1606 +
1607 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Тело запроса:
1612 +{
1613 + "id": 0, ~/~/ id уведомления
1614 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1615 + "userId": "", ~/~/ Пользователь, создавший уведомление
1616 + "parentId": "", ~/~/ Идентификатор клиента
1617 + "parentName": "string", ~/~/ Имя клиента
1618 + "name": "string", ~/~/ Название уведомления
1619 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1620 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1621 + 0
1622 + ],
1623 + "geoids": [ ~/~/ Список id геообъектов для анализа
1624 + 0
1625 + ],
1626 + "fieldids": [ ~/~/ Список id полей для анализа
1627 + 0
1628 + ],
1629 + "settings": { ~/~/ Список параметров уведомления
1630 + "additionalProp1": "string",
1631 + "additionalProp2": "string",
1632 + "additionalProp3": "string"
1633 + },
1634 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1635 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1636 + ""
1637 + ],
1638 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1639 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1640 + "string"
1641 + ],
1642 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1643 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1644 + {
1645 + "id": 0, ~/~/ Идентификатор участника чата
1646 + "info": "string" ~/~/ Дополнительные сведения
1647 + }
1648 + ],
1649 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1650 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1651 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1652 + "kind": 0, ~/~/ Определяет вид уведомления
1653 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1654 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1655 + "timezone": 0, ~/~/ Сдвиг часового пояса
1656 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1657 + "autoProlongation": true ~/~/ Автопродление срока действия
1658 +}
1659 +
1660 +Ответ:
1661 +
1662 +Success
1663 +
1664 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1665 +
1666 +(% class="box errormessage" %)
1667 +(((
1668 +**DELETE /api/v3/notifications/{id}**
1669 +)))
1670 +
1671 +Метод позволяет удалить выбранное уведомление.
1672 +
1673 +Метод запроса **DELETE**
1674 +
1675 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1676 +
1677 +Передаваемый параметр: {id} - id уведомления
1678 +
1679 +В заголовках запроса: X-Auth: Токен авторизации
1680 +
1681 +Ответ:
1682 +
1683 +Success
1684 +
1149 1149  (% class="box" lang="en-US" style="text-align: center;" %)
1150 1150  (((
1151 1151  (% 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 г.