Last modified by Андрей Калиновский on 2025/03/28 11:43
<
From version < 93.1 >
edited by Илья Крайнов
on 2023/05/22 16:01
To version < 20.1 >
edited by Артем Шемяков
on 2022/09/01 16:51
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,68 +1,50 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 +
4 +== ==
5 +
6 +(% class="box" style="text-align: center;" %)
2 2  (((
3 -**Содержание страницы:**
8 +(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
4 4  )))
5 5  
6 -{{toc/}}
11 +(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
7 7  
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
8 8  
9 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 -
11 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 -
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 -
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 +
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 +(% class="box" style="text-align: center;" %)
19 +(((
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 +)))
18 18  
19 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 -
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 -
23 23  (% class="box infomessage" %)
24 24  (((
25 -(% lang="en-US" %)**POST /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}
42 -
43 -
44 -(% style="color:#000000" %)**Ответ:**
45 -
46 46  (% lang="en-US" %)
47 -(% style="color:#000000" %){
37 +(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
48 48  
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
54 -}
55 -
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
61 61  (((
62 -(% lang="en-US" %)**GET /api/v3/auth/check**
44 +(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
63 63  )))
64 64  
65 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
47 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
66 66  
67 67  (% style="color:#000000" %)Метод запроса: **GET**
68 68  
... ... @@ -73,243 +73,49 @@
73 73  (% lang="en-US" %)
74 74  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
75 75  
76 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
77 77  
78 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 -
80 -(% class="box infomessage" %)
59 +(% class="box" style="text-align: center;" %)
81 81  (((
82 -**GET api/v3/agents/{id}**
61 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
83 83  )))
84 84  
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 -
122 122  (% class="box infomessage" %)
123 123  (((
124 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
66 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
125 125  )))
126 126  
127 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
69 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
128 128  
129 129  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
75 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
134 134  
135 -(% style="color:#000000" %)Метод запроса: **POST**
77 +(% style="color:#000000" %)Метод запроса: **GET**
136 136  
137 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
79 +(% 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>
138 138  
139 -(% style="color:#000000" %)Параметр запроса:
81 +(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
140 140  
141 -(% style="color:#000000" %){
142 - "parentId": "string"
143 -}
83 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
144 144  
145 -(% style="color:#000000" %)Ответ:
85 +(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
146 146  
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 - Отказ)
155 -}
87 +(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
156 156  
157 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 -(% class="box successmessage" %)
90 +(% class="box" style="text-align: center;" %)
160 160  (((
161 -**POST /api/v3/agents **
92 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
162 162  )))
163 163  
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 -
307 307  (% class="box successmessage" %)
308 308  (((
309 -(% lang="en-US" %)**POST /api/v3/users**
97 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
310 310  )))
311 311  
312 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
100 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
313 313  
314 314  (% style="color:#000000" %)Метод запроса: **POST**
315 315  
... ... @@ -317,189 +317,50 @@
317 317  
318 318  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
319 319  
320 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
108 +(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
321 321  
322 -(% style="color:#000000" %)
323 -{ 
324 - "lastName": "", ~/~/ фамилия
325 - "firstName": "", ~/~/ имя
326 - "position": "", ~/~/ должность
327 - "phone": "", ~/~/ телефон
328 - "organization": "", ~/~/ организация
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 - отключен
336 - "parentId": "", ~/~/ Guid родительского агента
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 - Азербайджанский
353 -}
354 -
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 -
367 367  (% style="text-align:left" %)
368 -(% style="color:#000000; font-weight:normal" %)Ответ:
111 +(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
369 369  
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 372  
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
375 - "lastName": "" , ~/~/ Фамилия ,
376 - "firstName": "" , ~/~/ Имя
377 - "position": "" , ~/~/ Должность
378 - "phone": "" , ~/~/ Телефон
379 - "organization": "" , ~/~/ Организация
380 - "login": "" , ~/~/ Логин
381 - "password": "" , ~/~/ Пароль
382 - "email": "" , ~/~/ Email
383 - "description": "" , ~/~/ Описание
384 - "isEnabled": "" , ~/~/ Признак включения
385 - "parentId": "" , ~/~/ Guid родительского агента
386 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
387 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
388 - "kind": "" , ~/~/ тип аутентификации
389 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
391 -
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
394 -
395 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 -
397 -(% class="box infomessage" %)
114 +(% class="box successmessage" %)
398 398  (((
399 -(% lang="en-US" %)**POST /api/v3/users/find**
116 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
400 400  )))
401 401  
402 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
119 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
403 403  
404 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
121 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
405 405  
406 406  (% style="color:#000000" %)Метод запроса: **POST**
407 407  
408 408  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
409 409  
410 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
127 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
411 411  
412 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
129 +(% class="western" %)
130 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
131 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
132 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
133 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
413 413  
414 -(% style="color:#000000" %){
415 -
416 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 421  (% style="color:#000000" %)}
422 422  
423 -(% style="color:#000000" %)Ответ:
137 +(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
424 424  
425 -(% style="color:#000000" %){         (%%)
139 +(% class="western" style="margin-bottom:19px" %)
140 +{{{ "sessionDuration":"", // длительность сессии в минутах}}}
426 426  
427 - "id": "" , ~/~/ идентификатор пользователя
428 - "lastName": "" , ~/~/ фамилия
429 - "firstName": "" , ~/~/ имя
430 - "position": "" , ~/~/ должность
431 - "phone": "" , ~/~/ телефон
432 - "parentId": "" , ~/~/ идентификатор клиента-родителя
433 - "parentName": "" , ~/~/ наименование клиента-родителя
434 - "organization": "" , ~/~/ организация
435 - "login": "" , ~/~/ логин
436 - "email": "" , ~/~/ E-mail
437 - "sessionDuration":"", ~/~/ длительность сессии в минутах
438 - "status": "1",  ~/~/ статус пользователя
439 - "lastLogged": "", ~/~/ дата/время последней авторизации
142 +(% lang="en-US" style="text-align:left" %)
143 +(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
440 440  
441 -(% style="color:#000000" %)}
442 442  
443 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
444 -
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 -
497 497  (% class="box warningmessage" %)
498 498  (((
499 -(% lang="en-US" %)**PUT /api/v3/users**
148 +(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
500 500  )))
501 501  
502 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
151 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
503 503  
504 504  (% style="color:#000000" %)Метод запроса: **PUT**
505 505  
... ... @@ -508,386 +508,98 @@
508 508  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
509 509  
510 510  (% lang="en-US" style="text-align:left" %)
511 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
160 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
512 512  
513 -(% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 515  
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
518 - "lastName": "" , ~/~/ фамилия
519 - "firstName": "" , ~/~/ имя
520 - "position": "" , ~/~/ должность
521 - "phone": "" , ~/~/ телефон
522 - "organization": "" , ~/~/ организация
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": "" , ~/~/ описание
529 - "isEnabled": "" , ~/~/ признак включения
530 - "parentId": "" , ~/~/ Guid родительского агента
531 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
532 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
533 - "doubleAuth":
534 - {
535 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
536 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 - },
538 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 -
541 -(% lang="en-US" style="text-align:left" %)
542 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 -
544 -(% lang="en-US" style="text-align:left" %)
545 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 -
547 -(% lang="en-US" style="text-align:left" %)
548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 -
550 -(% lang="en-US" style="text-align:left" %)
551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
552 - "lastName": "" , ~/~/ фамилия
553 - "firstName": "" , ~/~/ имя
554 - "position": "" , ~/~/ должность
555 - "phone": "" , ~/~/ телефон
556 - "organization": "" , ~/~/ организация
557 - "login": "" , ~/~/ логин
558 - "password": "" , ~/~/ пароль 
559 - "email": "" , ~/~/ email
560 - "description": "" , ~/~/ описание
561 - "isEnabled": "" , ~/~/ признак включения
562 - "parentId": "" , ~/~/ Guid родительского агента
563 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
564 - "doubleAuth":
565 - {
566 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
567 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
568 - },
569 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
572 -
573 -(% lang="en-US" style="text-align:left" %)
574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 -
576 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 -
578 578  (% class="box warningmessage" %)
579 579  (((
580 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
165 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
581 581  )))
582 582  
583 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
168 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
584 584  
585 585  (% style="color:#000000" %)Метод запроса: **PUT**
586 586  
587 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
172 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id} Параметр запроса:
588 588  
589 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
174 +(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
590 590  
591 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
176 +(% class="western" %)
177 +{{{ "description": "", // описание
178 + "data": "" // данные, связанные со сменой статуса}}}
592 592  
593 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
594 -
595 -(% style="color:#000000" %){
596 -
597 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 - "description": "" , ~/~/ описание
599 - "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 601  (% style="color:#000000" %)}
602 602  
603 603  (% style="text-align:left" %)
604 604  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
605 605  
606 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
607 607  
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 -
667 667  (% class="box errormessage" %)
668 668  (((
669 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
188 +(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
670 670  )))
671 671  
672 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
191 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
673 673  
674 674  (% style="color:#000000" %)Метод запроса: **DELETE**
675 675  
676 676  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
677 677  
678 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
197 +(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
679 679  
680 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
681 -
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
203 +(% class="box" style="text-align: center;" %)
204 +(((
205 +(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
206 +)))
688 688  
689 689  (% class="box infomessage" %)
690 690  (((
691 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
210 +(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
692 692  )))
693 693  
694 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
213 +(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
695 695  
696 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
215 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
697 697  
698 698  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
699 699  
700 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
219 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
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}
223 +(% 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>
705 705  
706 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
225 +(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
710 710  (% style="color:#000000" %)Ответ:
711 711  
712 -(((
713 -{
714 - "vehicleId": "", ~/~/ ID объекта
715 - "name": "", ~/~/ Имя объекта
716 - "imei": "", ~/~/ IMEI объекта
717 - "deviceTypeId": , ~/~/ ID типа устройства
718 - "deviceTypeName": "", ~/~/ Название типа устройства
719 - "sim1": "", ~/~/ Номер SIM1
720 - "sim2": "", ~/~/ Номер SIM2
231 +(% style="color:#000000" %){
721 721  
722 - "parentId": "", ~/~/ ID клиента-родителя
723 - "parentName": "", ~/~/ Наименование клиента-родителя
724 - "modelId": "", ~/~/ ID модели объекта
725 - "modelName": "", ~/~/ Имя модели объекта
726 -
727 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 - "unitName": "string", ~/~/ Наименование подразделения
729 - "status": 0, ~/~/ Статус объекта
730 -
731 - "createdAt": "", ~/~/ Дата создания объекта
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" ~/~/ Дата пересчета последних моточасов
233 +(% class="western" %)
234 +{{{ "vehicleId": “”, // идентификатор объекта
235 + "name": "", // имя объекта
236 + "imei": "", // IMEI объекта
237 + "deviceTypeId": “”, // идентификатор устройства объекта
238 + "deviceTypeName": "" // наименование устройства объекта
239 + "parentId": "", // идентификатор клиента-родителя
240 + "parentName": "" // наименование клиента-родителя,
241 + "modelId": "", // идентификатор модели объекта
242 + "modelName": "" // наименование модели объекта,
243 + "unitId": "", // идентификатор подразделения
244 + "unitName": "", // наименование подразделения
245 + "status": “”, // статус объекта
246 + ...
769 769   },
248 + ...}}}
770 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 - },
250 +(% style="color:#000000" %)}
778 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, ~/~/ Тип, Simple - простой, Composite - виртуальный
792 - "type": 0, ~/~/ Тип датчика
793 - "name": "string", ~/~/ Имя датчика
794 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
795 - "inputNumber": 0, ~/~/ Номер входа
796 - "pseudonym": "string", ~/~/ Псевдоним
797 - "medianDegree": 0, ~/~/ Медианная фильтрация
798 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
801 - "gradesTables": [ ~/~/ Массив таблиц тарировки
802 - {
803 - "grades": [ ~/~/ Таблица тарировки 1
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, ~/~/ Функция, SUM, AVG, EXPRESSION
817 - "expr": "string", ~/~/ Формула
818 - "children": [ ~/~/ массив дочерних датчиков
819 - "string"
820 - ],
821 - "customParams": { ~/~/ прочие произвольные параметры
822 - "additionalProp1": "string",
823 - "additionalProp2": "string",
824 - "additionalProp3": "string"
825 - },
826 -
827 -~/~/ Характерные для произвольного:
828 -
829 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 -~/~/ "ValueOn": "Вкл.",
848 -
849 -~/~/ "ValueOff": "Выкл."
850 - "summaryMaxValue": 0 ~/~/ Макс. значение
851 - }
852 -
853 - "drivers": [ ~/~/ Водители
854 - {
855 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
856 - "name": "string", ~/~/ Наименование
857 - "description": "string",
858 - "isDefault": true ~/~/ По умолчанию
859 - }
860 - ],
861 -
862 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 - {
864 - "id": "", ~/~/ ID  задания
865 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
866 - "name": "", ~/~/ Наименование задания
867 - "description": "", ~/~/ Описание задания
868 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
869 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
870 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
871 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
872 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
873 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
874 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
875 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 - }
877 - ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
880 - {
881 - "status": 0,
882 - "date": "2023-05-22T09:57:39.562Z",
883 - "description": "string",
884 - "additionalInfo": "string"
885 - }
886 - ]
887 -
888 -}
889 -)))
890 -
891 891  (% style="text-align:left" %)
892 892  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
893 893  
... ... @@ -894,14 +894,13 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
897 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
900 900  (((
901 -(% lang="en-US" %)**POST /api/v3/vehicles**
261 +(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
902 902  )))
903 903  
904 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
264 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
905 905  
906 906  (% style="color:#000000" %)Метод запроса: **POST**
907 907  
... ... @@ -909,201 +909,118 @@
909 909  
910 910  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
911 911  
912 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
272 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
913 913  
914 -(% style="color:#000000" %){
915 -
916 - "parentId": "" , ~/~/ ID клиента
917 - "name": "" , ~/~/ имя ТС
918 - "imei": "" , ~/~/ IMEI
919 - "deviceTypeId": "" , ~/~/ ID типа устройства
920 - "modelId": "" , ~/~/ ID модели
921 - "unitId": "" , ~/~/ ID подразделения
922 - "sim1": "" , ~/~/ Номер SIM 1
923 - "sim2": "" , ~/~/ Номер SIM2
924 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
925 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
926 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
927 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
928 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
929 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
930 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
931 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
932 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
933 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 -
937 - "mileageCalcMethod": 0,
938 - "mileageCoeff": 0,
939 - "locationByCellId": true,
940 - "dottedLineTrackWhenNoCoords": true,
941 - "counters": ~/~/ счетчики
942 - {
943 - "mileage": "" , ~/~/ пробег
944 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
945 - "motohours": "" , ~/~/ моточасы
946 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
274 +(% class="western" %)
275 +{{{ "parentId": "", // ID клиента
276 + "name": "", // имя ТС
277 + "imei": "", // IMEI
278 + "deviceTypeId": "",// ID типа устройства
279 + "modelId": "",
280 + "unitId": "", // ID подразделения
281 + "sim1": "", // Номер SIM 1
282 + "sim2": "", // Номер SIM2
283 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
284 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
285 + "consumptionIdle": "",// Расход топлива на холостом ходу
286 + "counters": {
287 + "mileage": "", // пробег
288 + "mileageEnabled": true, // флаг активности счётчика "пробег"
289 + "motohours":"", // моточасы
290 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
291 + },
292 + "cmsv6Parameters": { // параметры CMSv6
293 + "enabled": true, // флаг включения
294 + //"id": "", // идентификатор
295 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
296 + "login": "", // имя учетной записи
297 + "password": "" // пароль учетной записи
947 947   },
948 - "cmsv6Parameters": { ~/~/ параметры CMSv6
949 - "enabled": true, ~/~/ флаг включения
950 - "id": "" , ~/~/ идентификатор
951 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
952 - "login": "" , ~/~/ имя учетной записи
953 - "password": "" ~/~/ пароль учетной записи
954 - },
955 - "inspectionTasks": ~/~/ задания на ТО
299 + "inspectionTasks": [ // задания на ТО
956 956   {
957 - "enabled": "" , ~/~/ Признак включения
958 - "name": "" , ~/~/ Имя задания
959 - "description": "" , ~/~/ Описание задания
960 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
961 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
962 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
963 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
964 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
965 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
966 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 - }
969 -
970 -"drivers": [ ~/~/ Водители
971 - {
972 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
973 - "isDefault": true
974 - }
975 - ],
976 - "commandTemplates": [ ~/~/ Шаблон команды
977 - {
978 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
979 - "name": "string",
980 - "command": "string",
981 - "retries": 0
982 - }
983 - ],
984 - "sensors": [ ~/~/ Датчики
985 - {
986 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
987 - "kind": 0,
988 - "type": 0,
989 - "name": "string",
990 - "inputType": 0,
991 - "inputNumber": 0,
992 - "pseudonym": "string",
993 - "medianDegree": 0,
994 - "isInverted": true,
995 - "disabled": true,
996 - "gradeType": 0,
997 - "gradesTables": [
998 - {
999 - "grades": [
1000 - {
1001 - "input": 0,
1002 - "output": 0
1003 - }
1004 - ],
1005 - "relevanceTime": "2023-05-22T12:19:59.728Z"
1006 - }
1007 - ],
1008 - "showInTooltip": true,
1009 - "showLastValid": true,
1010 - "showAsDutOnGraph": true,
1011 - "showWithoutIgn": true,
1012 - "agrFunction": 0,
1013 - "expr": "string",
1014 - "children": [
1015 - "string"
1016 - ],
1017 - "customParams": {
1018 - "additionalProp1": "string",
1019 - "additionalProp2": "string",
1020 - "additionalProp3": "string"
301 + "enabled": "", // Признак включения
302 + "name": "", // Имя задания
303 + "description": "", // Описание задания
304 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
305 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
306 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
307 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
308 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
309 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
310 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
311 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1021 1021   },
1022 - "summaryMaxValue": 0
1023 - }
1024 - ],
1025 - "customFields": [ ~/~/ Произвольные поля
1026 - {
1027 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1028 - "name": "string",
1029 - "value": "string",
1030 - "forClient": true,
1031 - "forTooltip": true,
1032 - "forReport": true
1033 - }
1034 - ]
1035 -}
313 + ]}}}
1036 1036  
315 +(% style="color:#000000" %)… }
316 +
1037 1037  (% style="color:#000000" %)Ответ:
1038 1038  
1039 1039  (% style="color:#000000" %){
1040 1040  
1041 - "vehicleId": "", ~/~/ID ТС 
1042 - "parentId": "", ~/~/Guid владельца ТС
1043 - "name": "", ~/~/Имя объекта
1044 - "imei": "", ~/~/IMEI
1045 - "deviceTypeId": "", ~/~/ID типа устройства
1046 - "modelId": "", ~/~/ID модели
1047 - "unitId": "", ~/~/ID подразделения
1048 - "sim1": "", ~/~/SIM1
1049 - "sim2": "", ~/~/SIM2
1050 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1051 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1052 - "counters": { ~/~/Счётчики
1053 - "mileageEnabled": true,
1054 - "motohoursEnabled": true,
1055 - "mileage": "",
1056 - "motohours": 345.0
1057 - },
1058 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1059 - "id": null,
1060 - "enabled": true, ~/~/флаг включения
1061 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1062 - "login": "", ~/~/ имя учетной записи
1063 - "password": "" ~/~/ пароль учетной записи
1064 - },
1065 - "inspectionTasks": { ~/~/ задания на ТО
1066 - "id": "", ~/~/ ID задачи
1067 - "enabled": false, ~/~/ Признак включения
1068 - "name": "", ~/~/ Имя задания
1069 - "description": "", ~/~/ Описание задания
1070 - "mileageCondition": "", ~/~/ Условие по пробегу
1071 - "lastMileage": "", ~/~/ Пробег (в метрах)
1072 - "motohoursCondition": "", ~/~/ Условие по моточасам
1073 - "lastMotohours": "", ~/~/ Моточасы
1074 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1075 - "kind": "", ~/~/ Вид периодичности по времени 
1076 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1077 - }
321 +(% class="western" %)
322 +{{{ "vehicleId": "", //ID ТС
323 + "parentId": "", //Guid владельца ТС
324 + "name": "", //Имя объекта
325 + "imei": "", //IMEI
326 + "deviceTypeId": "", //ID типа устройства
327 + "modelId": "", //ID модели
328 + "unitId": "", //ID подразделения
329 + "sim1": "", //SIM1
330 + "sim2": "", //SIM2
331 + "consumptionPer100Km": "", //Расход топлива на 100 км
332 + "consumptionIdle": "", //Расход топлива на холостом ходу
333 + "counters": { //Счётчики
334 + "mileageEnabled": true,
335 + "motohoursEnabled": true,
336 + "mileage": "",
337 + "motohours": 345.0
338 + },
339 + "cmsv6Parameters": { //Параметры CmsV6
340 + "id": null,
341 + "enabled": true, //флаг включения
342 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
343 + "login": "", // имя учетной записи
344 + "password": "" // пароль учетной записи
345 + },
346 + "inspectionTasks": [ // задания на ТО
347 + {
348 + "id": "", // ID задачи
349 + "enabled": false, // Признак включения
350 + "name": "", // Имя задания
351 + "description": "", // Описание задания
352 + "mileageCondition": "", // Условие по пробегу
353 + "lastMileage": "", // Пробег (в метрах)
354 + "motohoursCondition": "", // Условие по моточасам
355 + "lastMotohours": "", // Моточасы
356 + "periodicCondition": "", // Условие периодичности по времени
357 + "kind": "", // Вид периодичности по времени
358 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
359 + }
360 + ]}}}
1078 1078  
1079 1079  (% style="text-align:left" %)
1080 1080  (% style="color:#000000" %)}
1081 1081  
1082 -**Валидация:**
1083 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1084 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1085 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1086 1086  
1087 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1088 -
1089 -(% class="box infomessage" %)
366 +(% class="box successmessage" %)
1090 1090  (((
1091 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
368 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
1092 1092  )))
1093 1093  
1094 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
371 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1095 1095  
1096 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
373 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
1097 1097  
1098 1098  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1099 1099  
1100 1100  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1101 1101  
1102 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
379 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
1103 1103  
1104 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
381 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
1105 1105  
1106 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
383 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
1107 1107  
1108 1108  (% style="color:#000000" %)Метод запроса: **POST**
1109 1109  
... ... @@ -1111,115 +1111,78 @@
1111 1111  
1112 1112  (% style="color:#000000" %)В заголовках запроса:
1113 1113  
1114 -(% style="color:#000000" %)− Content-Type: __**application/json**__
391 +(% style="color:#000000" %)− Content-Type: application/json
1115 1115  
1116 1116  (% style="color:#000000" %)− X-Auth: Токен авторизации
1117 1117  
1118 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
395 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
1119 1119  
1120 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
397 +(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
1121 1121  
1122 -{
1123 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1124 - "name": null, ~/~/ Имя ТС (string, опционально)
1125 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1126 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1127 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1128 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1129 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1130 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1131 -}
399 +(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
1132 1132  
1133 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
401 +(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
1134 1134  
1135 -(% style="color:#000000" %)Ответ:
403 +(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
1136 1136  
1137 -(% style="color:#000000" %){
405 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
1138 1138  
1139 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1140 - "name": "" ~/~/ наименование объекта
1141 - "imei": "" ~/~/ IMEI объекта
1142 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1143 - "deviceTypeName": "" ~/~/ наименование типа устройства
1144 - "sim1": "" ~/~/ первый номер телефона
1145 - "sim2": "" ~/~/ второй номер телефона
1146 - "parentId": "" ~/~/ идентификатор клиента-родителя
1147 - "parentName": "" ~/~/ наименование клиента-родителя
1148 - "modelId": "" ~/~/ идентификатор модели объекта
1149 - "modelName": "" ~/~/ наименование модели объекта
1150 - "unitId": "" ~/~/ идентификатор подразделения
1151 - "unitName": "" ~/~/ наименование подразделения
1152 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1153 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1154 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1155 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1156 - "customFields": [ 
1157 - {
1158 - "id": "", ~/~/ идентификатор произвольного поля
1159 - "name": "", ~/~/ имя произвольного поля
1160 - "value": "", ~/~/ значение произвольного поля
1161 - "forClient": true, ~/~/ право на отображение у клиента
1162 - "forTooltip": false, ~/~/ право на отображение в подсказке
1163 - "forReport": false ~/~/ право на отображение в отчетах
1164 - }(%%)
1165 -(% style="color:#000000" %)}
407 +(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
1166 1166  
1167 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
409 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1168 1168  
1169 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
411 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1170 1170  
413 +
1171 1171  (% class="box successmessage" %)
1172 1172  (((
1173 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
416 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1174 1174  )))
1175 1175  
1176 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
419 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1177 1177  
1178 1178  (% style="color:#000000" %)Метод запроса: **POST**
1179 1179  
1180 1180  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1181 1181  
1182 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
425 +(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
1183 1183  
1184 1184  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1185 1185  
1186 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
429 +(% style="color:#000000" %)Параметры в теле запроса (JSON): {
1187 1187  
1188 -(% style="color:#000000" %){
431 +(% class="western" %)
432 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
433 +  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
434 +  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
435 + "date": "", // Дата смены статуса (null если сменить немедленно)
436 + "description": "", // Описание
437 + "data": "", // Данные
438 + "overwrite": false, // Флаг перезаписи
439 + "stage": "", // Состояние, может быть null}}}
1189 1189  
1190 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1191 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1192 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1193 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1194 - "description": "", ~/~/ Описание
1195 - "data": "", ~/~/ Данные
1196 - "overwrite": false, ~/~/ Флаг перезаписи
1197 - "stage": "", ~/~/ Состояние, может быть null
1198 -
1199 1199  (% style="color:#000000" %)}
1200 1200  
1201 -(% style="color:#000000" %)Ответ:
443 +(% style="color:#000000" %)Ответ: {
1202 1202  
1203 -(% style="color:#000000" %){
445 +(% class="western" %)
446 +{{{ "status": "", // значение статуса
447 + "date": "", // Дата смены статуса
448 + "description": "", // Описание
449 + "data": "", // Данные
450 + "overwrite": false, // Флаг перезаписи
451 + "stage": "", // Состояние}}}
1204 1204  
1205 - "status": "", ~/~/ значение статуса
1206 - "date": "", ~/~/ Дата смены статуса 
1207 - "description": "", ~/~/ Описание
1208 - "data": "", ~/~/ Данные
1209 - "overwrite": false, ~/~/ Флаг перезаписи
1210 - "stage": "", ~/~/ Состояние
1211 -
1212 1212  (% style="text-align:left" %)
1213 -(% style="color:#000000" %) }
454 +(% style="color:#000000" %)}
1214 1214  
1215 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1216 1216  
1217 1217  (% class="box warningmessage" %)
1218 1218  (((
1219 -(% lang="en-US" %)**PUT /api/v3/vehicles**
459 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1220 1220  )))
1221 1221  
1222 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
462 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1223 1223  
1224 1224  (% style="color:#000000" %)Метод запроса: **PUT**
1225 1225  
... ... @@ -1229,198 +1229,26 @@
1229 1229  
1230 1230  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1231 1231  
1232 -(% style="color:#000000" %){
472 +(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1233 1233  
1234 - "parentId": "" , ~/~/ ID клиента
1235 - "name": "" , ~/~/ имя ТС
1236 - "imei": "" , ~/~/ IMEI
1237 - "deviceTypeId": "" , ~/~/ ID типа устройства
1238 - "modelId": "" , ~/~/ ID модели
1239 - "unitId": "" , ~/~/ ID подразделения
1240 - "sim1": "" , ~/~/ Номер SIM 1
1241 - "sim2": "" , ~/~/ Номер SIM2
1242 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1243 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1244 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1245 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1246 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1247 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1248 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1249 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1250 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1251 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1252 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1253 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1254 -
1255 - "mileageCalcMethod": 0,
1256 - "mileageCoeff": 0,
1257 - "locationByCellId": true,
1258 - "dottedLineTrackWhenNoCoords": true,
1259 - "counters": ~/~/ счетчики
1260 - {
1261 - "mileage": "" , ~/~/ пробег
1262 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1263 - "motohours": "" , ~/~/ моточасы
1264 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1265 - },
1266 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1267 - "enabled": true, ~/~/ флаг включения
1268 - "id": "" , ~/~/ идентификатор
1269 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1270 - "login": "" , ~/~/ имя учетной записи
1271 - "password": "" ~/~/ пароль учетной записи
1272 - },
1273 - "inspectionTasks": ~/~/ задания на ТО
1274 - {
1275 - "enabled": "" , ~/~/ Признак включения
1276 - "name": "" , ~/~/ Имя задания
1277 - "description": "" , ~/~/ Описание задания
1278 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1279 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1280 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1281 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1282 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1283 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1284 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1285 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1286 - }
1287 -
1288 -"drivers": [ ~/~/ Водители
1289 - {
1290 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1291 - "isDefault": true
1292 - }
1293 - ],
1294 - "commandTemplates": [ ~/~/ Шаблон команды
1295 - {
1296 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1297 - "name": "string",
1298 - "command": "string",
1299 - "retries": 0
1300 - }
1301 - ],
1302 - "sensors": [ ~/~/ Датчики
1303 - {
1304 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305 - "kind": 0,
1306 - "type": 0,
1307 - "name": "string",
1308 - "inputType": 0,
1309 - "inputNumber": 0,
1310 - "pseudonym": "string",
1311 - "medianDegree": 0,
1312 - "isInverted": true,
1313 - "disabled": true,
1314 - "gradeType": 0,
1315 - "gradesTables": [
1316 - {
1317 - "grades": [
1318 - {
1319 - "input": 0,
1320 - "output": 0
1321 - }
1322 - ],
1323 - "relevanceTime": "2023-05-22T12:19:59.728Z"
1324 - }
1325 - ],
1326 - "showInTooltip": true,
1327 - "showLastValid": true,
1328 - "showAsDutOnGraph": true,
1329 - "showWithoutIgn": true,
1330 - "agrFunction": 0,
1331 - "expr": "string",
1332 - "children": [
1333 - "string"
1334 - ],
1335 - "customParams": {
1336 - "additionalProp1": "string",
1337 - "additionalProp2": "string",
1338 - "additionalProp3": "string"
1339 - },
1340 - "summaryMaxValue": 0
1341 - }
1342 - ],
1343 - "customFields": [ ~/~/ Произвольные поля
1344 - {
1345 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1346 - "name": "string",
1347 - "value": "string",
1348 - "forClient": true,
1349 - "forTooltip": true,
1350 - "forReport": true
1351 - }
1352 - ]
1353 -}
1354 -
1355 1355  (% style="color:#000000" %)Ответ:
1356 1356  
1357 1357  (% lang="en-US" style="text-align:left" %)
1358 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
477 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
1359 1359  
1360 -(% lang="en-US" style="text-align:left" %)
1361 - "vehicleId": "", ~/~/ ID ТС
1362 - "parentId": "", ~/~/ ID клиента
1363 - "name": "", ~/~/ имя ТС
1364 - "imei": "", ~/~/ IMEI
1365 - "deviceTypeId": "", ~/~/ типа устройства
1366 - "modelId": "", ~/~/ ID модели
1367 - "unitId": "", ~/~/ ID подразделения
1368 - "sim1": "", ~/~/ SIM 1
1369 - "sim2": "", ~/~/ SIM2
1370 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1371 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1372 - "counters": 
1373 - {
1374 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1375 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1376 - "mileage": "", ~/~/ пробег
1377 - "motohours": "", ~/~/ моточасы
1378 - }
1379 - "cmsv6Parameters": ~/~/ параметры CMSv6
1380 - {
1381 - "id": ~/~/ идентификатор
1382 - "enabled": true, ~/~/ флаг включения
1383 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1384 - "login": "", ~/~/ имя учетной записи
1385 - "password": "", ~/~/ пароль учетной записи
1386 - }
1387 - "inspectionTasks": ~/~/ задания на ТО
1388 - {
1389 - "id": "", ~/~/ ID задания
1390 - "enabled": false, ~/~/ Признак включения
1391 - "name": "", ~/~/ Имя задания
1392 - "description": "", ~/~/ Описание задания
1393 - "mileageCondition": "", ~/~/ Условие по пробегу
1394 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1395 - "motohoursCondition": "", ~/~/ Условие по моточасам
1396 - "lastMotohours": "", ~/~/ Моточасы
1397 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1398 - "kind": "", ~/~/ Вид периодичности по времени
1399 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1400 - }
1401 1401  
1402 -(% lang="en-US" style="text-align:left" %)
1403 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1404 -
1405 -**Валидация:**
1406 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1407 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1408 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1409 -
1410 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1411 -
1412 1412  (% class="box errormessage" %)
1413 1413  (((
1414 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
482 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1415 1415  )))
1416 1416  
1417 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
485 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1418 1418  
1419 1419  (% style="color:#000000" %)Метод запроса: **DELETE**
1420 1420  
1421 1421  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1422 1422  
1423 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
491 +(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1424 1424  
1425 1425  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1426 1426  
... ... @@ -1427,351 +1427,70 @@
1427 1427  (% style="text-align:left" %)
1428 1428  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1429 1429  
1430 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1431 1431  
1432 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1433 -
1434 -(% class="box infomessage" %)
499 +(% class="box" lang="en-US" style="text-align: center;" %)
1435 1435  (((
1436 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
501 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1437 1437  )))
1438 1438  
1439 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1440 -
1441 -(% style="color:#000000" %)Метод запроса: **GET**
1442 -
1443 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1444 -
1445 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1446 -
1447 -(% style="color:#000000" %)Ответ:
1448 -
1449 -(% style="color:#000000" %){
1450 -
1451 - "deviceTypeId" : "", ~/~/ ID типа устройства
1452 - "deviceTypeName" : "" ~/~/ Название типа устройства
1453 -
1454 -(% style="text-align:left" %)
1455 -(% style="color:#000000" %)}
1456 -
1457 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1458 -
1459 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1460 -
1461 1461  (% class="box infomessage" %)
1462 1462  (((
1463 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
506 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1464 1464  )))
1465 1465  
1466 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
509 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1467 1467  
1468 1468  (% style="color:#000000" %)Метод запроса: **GET**
1469 1469  
1470 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
513 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1471 1471  
1472 1472  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1473 1473  
1474 -(% style="color:#000000" %)Ответ:
517 +(% style="color:#000000" %)Ответ: [
1475 1475  
1476 -(% style="color:#000000" %){
519 +(% class="western" %)
520 +{{{ {
521 + "deviceTypeId" : "", // ID типа устройства
522 + "deviceTypeName" : "" // Название типа устройства
523 + },}}}
1477 1477  
1478 - "id": "", ~/~/ ID типа датчика 
1479 - "name": "", ~/~/ Название
1480 - "description": "", ~/~/ Описание
1481 -
1482 1482  (% style="text-align:left" %)
1483 -(% style="color:#000000" %)}
526 +(% style="color:#000000" %)…** **]
1484 1484  
1485 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
1486 1486  
1487 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1488 -
1489 -(% class="box infomessage" style="text-align: left;" %)
529 +(% class="box" style="text-align: center;" %)
1490 1490  (((
1491 -**POST /api/v3/terminalMessages/count**
531 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1492 1492  )))
1493 1493  
1494 -(% style="text-align: left;" %)
1495 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1496 -
1497 -(% style="text-align: left;" %)
1498 -Метод запроса **POST**
1499 -
1500 -(% style="text-align: left;" %)
1501 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1502 -
1503 -(% style="text-align: left;" %)
1504 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1505 -
1506 -(% style="text-align: left;" %)
1507 -{
1508 - "vehicleIds": [
1509 - id ~/~/ здесь передается список идентификаторов объектов
1510 - ],
1511 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1512 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1513 -}
1514 -
1515 -(% style="text-align: left;" %)
1516 -Ответ:
1517 -
1518 -(% style="text-align: left;" %)
1519 -[
1520 - {
1521 - "vehicleId": 0, ~/~/ идентификатор объекта
1522 - "count": 0 ~/~/ количество сообщений за период
1523 - }
1524 -]
1525 -
1526 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1527 -
1528 1528  (% class="box infomessage" %)
1529 1529  (((
1530 -**POST /api/v3/terminalMessages**
536 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1531 1531  )))
1532 1532  
1533 -Метод возвращает список сообщений терминала объекта за выбранный период.
539 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1534 1534  
1535 -(% style="text-align: left;" %)
1536 -Метод запроса **POST**
541 +(% style="color:#000000" %)Метод запроса: **GET**
1537 1537  
1538 -(% style="text-align: left;" %)
1539 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
543 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1540 1540  
1541 -(% style="text-align: left;" %)
1542 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
545 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1543 1543  
1544 -{
1545 - "vehicleId": 0, ~/~/ id объекта
1546 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1547 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1548 -}
547 +(% style="color:#000000" %)Ответ: [
1549 1549  
1550 -Ответ:
549 +(% class="western" style="margin-bottom:19px" %)
550 +{{{ {}}}
1551 1551  
1552 -[
1553 - {
1554 - "messages": [
1555 - {
1556 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1557 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1558 - "speed": 0, ~/~/ Скорость, км/ч
1559 - "altitude": 0, ~/~/ Высота, м
1560 - "latitude": 0, ~/~/ Широта [-90°;90°]
1561 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1562 - "satellites": 0, ~/~/ Кол-во спутников
1563 - "voltage": 0, ~/~/ Напряжение
1564 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1565 - "additionalProp1": "string",
1566 - "additionalProp2": "string",
1567 - "additionalProp3": "string"
1568 - },
1569 - "photoCount": 0 ~/~/ Кол-во фото
1570 - }
1571 - ]
1572 - }
1573 -]
552 +(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1574 1574  
1575 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
554 +(% class="western" %)
555 +{{{ "description": "" // Описание
556 + },}}}
1576 1576  
1577 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
558 +(% style="text-align:left" %)
559 +(% style="color:#000000" %)… ]
1578 1578  
1579 -(% class="box infomessage" %)
1580 -(((
1581 -**POST /api/v3/notifications/find**
1582 -)))
1583 1583  
1584 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1585 -
1586 -(% style="text-align: left;" %)
1587 -Метод запроса **POST**
1588 -
1589 -(% style="text-align: left;" %)
1590 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1591 -
1592 -(% style="text-align: left;" %)
1593 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1594 -
1595 -{
1596 - "parentId": "" ~/~/ id клиента
1597 -}
1598 -
1599 -Ответ:
1600 -
1601 -[
1602 - {
1603 - "id": 0, ~/~/ ID уведомления
1604 - "name": "string", ~/~/ Название уведомления
1605 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1606 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1607 - "userId": "", ~/~/ Пользователь, создавший уведомление
1608 - "parentId": "", ~/~/ Идентификатор клиента
1609 - "parentName": "string" ~/~/ Имя клиента
1610 - }
1611 -]
1612 -
1613 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1614 -
1615 -(% class="box infomessage" %)
1616 -(((
1617 -**GET /api/v3/notifications/{id}**
1618 -)))
1619 -
1620 -Метод возвращает данные правил формирования выбранного уведомления.
1621 -
1622 -(% style="text-align: left;" %)
1623 -Метод запроса **GET**
1624 -
1625 -(% style="text-align: left;" %)
1626 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1627 -
1628 -(% style="text-align: left;" %)
1629 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1630 -
1631 -(% style="text-align: left;" %)
1632 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1633 -
1634 -(% style="text-align: left;" %)
1635 -(% style="color:#000000" %)Ответ:
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %){
1639 - "id": 0, ~/~/ (%%)id уведомления
1640 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1641 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1642 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1643 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1644 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1645 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1646 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1647 -(% style="color:#000000" %) 0
1648 - ],
1649 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1650 -(% style="color:#000000" %) 0
1651 - ],
1652 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
1653 -(% style="color:#000000" %) 0
1654 - ],
1655 - "settings": { ~/~/ Список параметров уведомления
1656 - "additionalProp1": "string",
1657 - "additionalProp2": "string",
1658 - "additionalProp3": "string"
1659 - },
1660 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1661 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1662 -(% style="color:#000000" %) ""
1663 - ],
1664 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1665 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1666 -(% style="color:#000000" %) "string"
1667 - ],
1668 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1669 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1670 -(% style="color:#000000" %) {
1671 - "id": 0, ~/~/ (%%)Идентификатор участника чата
1672 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1673 -(% style="color:#000000" %) }
1674 - ],
1675 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1676 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1677 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1678 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1679 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1680 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1681 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1682 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1683 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1684 -(% style="color:#000000" %)}
1685 -
1686 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1687 -
1688 -(% class="box warningmessage" %)
1689 -(((
1690 -**PUT /api/v3/notifications/**
1691 -)))
1692 -
1693 -Метод позволяет отредактировать уведомление.
1694 -
1695 -Метод запроса **PUT**
1696 -
1697 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1698 -
1699 -В заголовках запроса: X-Auth: Токен авторизации
1700 -
1701 -Тело запроса:
1702 -{
1703 - "id": 0, ~/~/ id уведомления
1704 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1705 - "userId": "", ~/~/ Пользователь, создавший уведомление
1706 - "parentId": "", ~/~/ Идентификатор клиента
1707 - "parentName": "string", ~/~/ Имя клиента
1708 - "name": "string", ~/~/ Название уведомления
1709 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
1710 - "vehicleIds": [ ~/~/ Список id объектов для анализа
1711 - 0
1712 - ],
1713 - "geoids": [ ~/~/ Список id геообъектов для анализа
1714 - 0
1715 - ],
1716 - "fieldids": [ ~/~/ Список id полей для анализа
1717 - 0
1718 - ],
1719 - "settings": { ~/~/ Список параметров уведомления
1720 - "additionalProp1": "string",
1721 - "additionalProp2": "string",
1722 - "additionalProp3": "string"
1723 - },
1724 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1725 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1726 - ""
1727 - ],
1728 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1729 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1730 - "string"
1731 - ],
1732 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1733 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1734 - {
1735 - "id": 0, ~/~/ Идентификатор участника чата
1736 - "info": "string" ~/~/ Дополнительные сведения
1737 - }
1738 - ],
1739 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1740 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1741 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1742 - "kind": 0, ~/~/ Определяет вид уведомления
1743 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1744 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1745 - "timezone": 0, ~/~/ Сдвиг часового пояса
1746 - "validity": 0, ~/~/ Срок действия в днях (1-90)
1747 - "autoProlongation": true ~/~/ Автопродление срока действия
1748 -}
1749 -
1750 -Ответ:
1751 -
1752 -Success
1753 -
1754 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1755 -
1756 -(% class="box errormessage" %)
1757 -(((
1758 -**DELETE /api/v3/notifications/{id}**
1759 -)))
1760 -
1761 -Метод позволяет удалить выбранное уведомление.
1762 -
1763 -Метод запроса **DELETE**
1764 -
1765 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1766 -
1767 -Передаваемый параметр: {id} - id уведомления
1768 -
1769 -В заголовках запроса: X-Auth: Токен авторизации
1770 -
1771 -Ответ:
1772 -
1773 -Success
1774 -
1775 1775  (% class="box" lang="en-US" style="text-align: center;" %)
1776 1776  (((
1777 1777  (% 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 г.