<
From version < 20.3 >
edited by Артем Шемяков
on 2022/09/01 17:21
To version < 87.1 >
edited by Михаил Жучков
on 2023/05/10 09:12
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.SupportZhuchkov
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,50 +1,68 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
14 14  
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 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
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 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
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]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
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 +
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
47 +(% style="color:#000000" %){
38 38  
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 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
41 41  
42 42  (% class="box infomessage" %)
43 43  (((
44 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
45 45  )))
46 46  
47 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
48 48  
49 49  (% style="color:#000000" %)Метод запроса: **GET**
50 50  
... ... @@ -55,57 +55,243 @@
55 55  (% lang="en-US" %)
56 56  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
57 57  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
58 58  
59 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
62 62  )))
63 63  
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 +
64 64  (% class="box infomessage" %)
65 65  (((
66 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
67 67  )))
68 68  
69 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
70 70  
71 71  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
72 72  
73 73  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
74 74  
75 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
76 76  
77 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
78 78  
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>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
80 80  
81 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
82 82  
83 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
84 84  
85 -(% style="color:#000000" %)Ответ: [ {
86 - "agentId": "", ~/~/ идентификатор клиента
87 - "parentId": "", ~/~/ идентификатор клиента-родителя
88 - "name": "", ~/~/ наименование клиента
89 - "fullName": "", ~/~/ полное наименование клиента
90 - "agentInfoType": "", ~/~/ тип клиента1
91 - "status": "", ~/~/ статус клиента
92 - }, … ]
145 +(% style="color:#000000" %)Ответ:
93 93  
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 +}
94 94  
95 -(% 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" %)]
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
96 96  
159 +(% class="box successmessage" %)
160 +(((
161 +**POST /api/v3/agents **
162 +)))
97 97  
98 -(% class="box" style="text-align: center;" %)
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" %)
99 99  (((
100 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
224 +**PUT /api/v3/agents**
101 101  )))
102 102  
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 +
103 103  (% class="box successmessage" %)
104 104  (((
105 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
106 106  )))
107 107  
108 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
109 109  
110 110  (% style="color:#000000" %)Метод запроса: **POST**
111 111  
... ... @@ -115,34 +115,59 @@
115 115  
116 116  (% style="color:#000000" %)Параметры в теле запроса (JSON):
117 117  
118 -(% style="color:#000000" %){ 
119 - "lastName": "", ~/~/ фамилия
322 +(% style="color:#000000" %)
323 +{ 
324 + "lastName": "", ~/~/ фамилия
120 120   "firstName": "", ~/~/ имя
121 121   "position": "", ~/~/ должность
122 122   "phone": "", ~/~/ телефон
123 123   "organization": "", ~/~/ организация
124 - "login": "", ~/~/ логин
125 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
126 - "email": "", ~/~/ email
127 - "description": "", ~/~/ описание
128 - "isEnabled": "", ~/~/ признак включения
329 + "login": "", ~/~/ логин (обязателен)
330 + "password": "", ~/~/ пароль (обязателен)
331 + "email": "", ~/~/ email (обязателен)
332 + "description": "string", ~/~/ Описание
333 + "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
334 + "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
335 + "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
129 129   "parentId": "", ~/~/ Guid родительского агента
130 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
131 - "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
132 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
133 - "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
134 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
135 - "groups": "" , ~/~/ группы пользователя, названия групп
136 - }
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 +}
137 137  
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 +
138 138  (% style="text-align:left" %)
139 139  (% style="color:#000000; font-weight:normal" %)Ответ:
140 140  
141 141  (% style="text-align:left" %)
142 -(% style="color:#000000; font-weight:normal" %){
371 +(% style="color:#000000; font-weight:normal" %){    
143 143  
144 144  (% style="text-align:left" %)
145 -(% style="color:#000000; font-weight:normal" %)"id": "" , ~/~/ ID пользователя
374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
146 146   "lastName": "" , ~/~/ Фамилия ,
147 147   "firstName": "" , ~/~/ Имя
148 148   "position": "" , ~/~/ Должность
... ... @@ -158,50 +158,119 @@
158 158   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
159 159   "kind": "" , ~/~/ тип аутентификации
160 160   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
161 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
390 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
162 162  
163 163  (% style="text-align:left" %)
164 164  (% style="color:#000000; font-weight:normal" %)}
165 165  
395 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
166 166  
167 -(% class="box successmessage" %)
397 +(% class="box infomessage" %)
168 168  (((
169 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
399 +(% lang="en-US" %)**POST /api/v3/users/find**
170 170  )))
171 171  
172 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
402 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
173 173  
174 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
404 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
175 175  
176 176  (% style="color:#000000" %)Метод запроса: **POST**
177 177  
178 178  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
179 179  
180 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
410 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
181 181  
182 -(% class="western" %)
183 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
184 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
185 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
186 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
412 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
187 187  
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 +
188 188  (% style="color:#000000" %)}
189 189  
190 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
423 +(% style="color:#000000" %)Ответ:
191 191  
192 -(% class="western" style="margin-bottom:19px" %)
193 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
425 +(% style="color:#000000" %){         (%%)
194 194  
195 -(% lang="en-US" style="text-align:left" %)
196 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
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": "", ~/~/ дата/время последней авторизации
197 197  
441 +(% style="color:#000000" %)}
198 198  
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 +
199 199  (% class="box warningmessage" %)
200 200  (((
201 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
499 +(% lang="en-US" %)**PUT /api/v3/users**
202 202  )))
203 203  
204 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
502 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
205 205  
206 206  (% style="color:#000000" %)Метод запроса: **PUT**
207 207  
... ... @@ -210,98 +210,248 @@
210 210  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
211 211  
212 212  (% lang="en-US" style="text-align:left" %)
213 -(% 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» //названия групп ] }  //
511 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
214 214  
513 +(% lang="en-US" style="text-align:left" %)
514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
215 215  
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 +
216 216  (% class="box warningmessage" %)
217 217  (((
218 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
580 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
219 219  )))
220 220  
221 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
583 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
222 222  
223 223  (% style="color:#000000" %)Метод запроса: **PUT**
224 224  
225 -(% 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} Параметр запроса:
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}
226 226  
227 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
589 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
228 228  
229 -(% class="western" %)
230 -{{{ "description": "", // описание
231 - "data": "" // данные, связанные со сменой статуса}}}
591 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
232 232  
593 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
594 +
595 +(% style="color:#000000" %){
596 +
597 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 + "description": "" , ~/~/ описание
599 + "data": "" , ~/~/ данные, связанные со сменой статуса
600 +
233 233  (% style="color:#000000" %)}
234 234  
235 235  (% style="text-align:left" %)
236 236  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
237 237  
606 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
238 238  
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 +
239 239  (% class="box errormessage" %)
240 240  (((
241 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
669 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
242 242  )))
243 243  
244 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
672 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
245 245  
246 246  (% style="color:#000000" %)Метод запроса: **DELETE**
247 247  
248 248  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
249 249  
250 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
678 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
251 251  
680 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
681 +
252 252  (% style="text-align:left" %)
253 253  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
254 254  
685 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
255 255  
256 -(% class="box" style="text-align: center;" %)
257 -(((
258 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
259 -)))
687 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
260 260  
261 261  (% class="box infomessage" %)
262 262  (((
263 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
691 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
264 264  )))
265 265  
266 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
694 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
267 267  
268 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
696 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
269 269  
270 270  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
271 271  
272 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
700 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
273 273  
274 274  (% style="color:#000000" %)Метод запроса: **GET**
275 275  
276 276  (% 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>
277 277  
278 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
279 279  
280 280  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
281 281  
282 282  (% style="color:#000000" %)Ответ:
283 283  
284 -(% style="color:#000000" %){
712 +(((
713 +{
714 + "vehicleId": "", ~/~/ ID объекта
715 + "name": "", ~/~/ Имя объекта
716 + "imei": "", ~/~/ IMEI объекта
717 + "deviceTypeId": , ~/~/ ID типа устройства
718 + "deviceTypeName": "", ~/~/ Название типа устройства
719 + "sim1": "", ~/~/ Номер SIM1
720 + "parentId": "", Номер SIM2
721 + "parentName": "", Наименование клиента-родителя
722 + "modelId": "", ID модели объекта
723 + "modelName": "", Имя модели объекта
724 + "createdAt": "", Дата создания объекта
725 + "mileageCalcMethod": "", Выбранный метод расчета пробега
726 + "counters": { ~/~/ Нормы
727 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 + "mileage": "", ~/~/ Пробег по нормам в метрах
730 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
733 + },
734 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 + {
736 + "id": "", ~/~/ ID  задания
737 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
738 + "name": "", ~/~/ Наименование задания
739 + "description": "", ~/~/ Описание задания
740 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
741 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
742 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
743 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
744 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
745 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
746 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
747 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
748 + }
749 + ]
750 +}
751 +)))
285 285  
286 -(% class="western" %)
287 -{{{ "vehicleId": “”, // идентификатор объекта
288 - "name": "", // имя объекта
289 - "imei": "", // IMEI объекта
290 - "deviceTypeId": “”, // идентификатор устройства объекта
291 - "deviceTypeName": "" // наименование устройства объекта
292 - "parentId": "", // идентификатор клиента-родителя
293 - "parentName": "" // наименование клиента-родителя,
294 - "modelId": "", // идентификатор модели объекта
295 - "modelName": "" // наименование модели объекта,
296 - "unitId": "", // идентификатор подразделения
297 - "unitName": "", // наименование подразделения
298 - "status": “”, // статус объекта
299 - ...
300 - },
301 - ...}}}
302 -
303 -(% style="color:#000000" %)}
304 -
305 305  (% style="text-align:left" %)
306 306  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
307 307  
... ... @@ -308,13 +308,14 @@
308 308  (% style="text-align:left" %)
309 309  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
310 310  
759 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
311 311  
312 312  (% class="box successmessage" %)
313 313  (((
314 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
763 +(% lang="en-US" %)**POST /api/v3/vehicles**
315 315  )))
316 316  
317 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
766 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
318 318  
319 319  (% style="color:#000000" %)Метод запроса: **POST**
320 320  
... ... @@ -322,118 +322,131 @@
322 322  
323 323  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
324 324  
325 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
774 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
326 326  
327 -(% class="western" %)
328 -{{{ "parentId": "", // ID клиента
329 - "name": "", // имя ТС
330 - "imei": "", // IMEI
331 - "deviceTypeId": "",// ID типа устройства
332 - "modelId": "",
333 - "unitId": "", // ID подразделения
334 - "sim1": "", // Номер SIM 1
335 - "sim2": "", // Номер SIM2
336 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
337 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
338 - "consumptionIdle": "",// Расход топлива на холостом ходу
339 - "counters": {
340 - "mileage": "", // пробег
341 - "mileageEnabled": true, // флаг активности счётчика "пробег"
342 - "motohours":"", // моточасы
343 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
344 - },
345 - "cmsv6Parameters": { // параметры CMSv6
346 - "enabled": true, // флаг включения
347 - //"id": "", // идентификатор
348 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
349 - "login": "", // имя учетной записи
350 - "password": "" // пароль учетной записи
351 - },
352 - "inspectionTasks": [ // задания на ТО
776 +(% style="color:#000000" %){
777 +
778 + "parentId": "" , ~/~/ ID клиента
779 + "name": "" , ~/~/ имя ТС
780 + "imei": "" , ~/~/ IMEI
781 + "deviceTypeId": "" , ~/~/ ID типа устройства
782 + "modelId": "" , ~/~/ ID модели
783 + "unitId": "" , ~/~/ ID подразделения
784 + "sim1": "" , ~/~/ Номер SIM 1
785 + "sim2": "" , ~/~/ Номер SIM2
786 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
787 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
788 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
789 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
790 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
791 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
792 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
793 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
794 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
795 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
796 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
797 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
798 + "counters": ~/~/ счетчики
353 353   {
354 - "enabled": "", // Признак включения
355 - "name": "", // Имя задания
356 - "description": "", // Описание задания
357 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
358 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
359 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
360 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
361 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
362 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
363 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
364 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
800 + "mileage": "" , ~/~/ пробег
801 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
802 + "motohours": "" , ~/~/ моточасы
803 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
365 365   },
366 - ]}}}
805 + "cmsv6Parameters": { ~/~/ параметры CMSv6
806 + "enabled": true, ~/~/ флаг включения
807 + "id": "" , ~/~/ идентификатор
808 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
809 + "login": "" , ~/~/ имя учетной записи
810 + "password": "" ~/~/ пароль учетной записи
811 + },
812 + "inspectionTasks": ~/~/ задания на ТО
813 + {
814 + "enabled": "" , ~/~/ Признак включения
815 + "name": "" , ~/~/ Имя задания
816 + "description": "" , ~/~/ Описание задания
817 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
818 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
819 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
820 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
821 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
822 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
823 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
824 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
825 + }
367 367  
368 -(% style="color:#000000" %) }
827 +(% style="color:#000000" %) }
369 369  
370 370  (% style="color:#000000" %)Ответ:
371 371  
372 372  (% style="color:#000000" %){
373 373  
374 -(% class="western" %)
375 -{{{ "vehicleId": "", //ID ТС
376 - "parentId": "", //Guid владельца ТС
377 - "name": "", //Имя объекта
378 - "imei": "", //IMEI
379 - "deviceTypeId": "", //ID типа устройства
380 - "modelId": "", //ID модели
381 - "unitId": "", //ID подразделения
382 - "sim1": "", //SIM1
383 - "sim2": "", //SIM2
384 - "consumptionPer100Km": "", //Расход топлива на 100 км
385 - "consumptionIdle": "", //Расход топлива на холостом ходу
386 - "counters": { //Счётчики
387 - "mileageEnabled": true,
388 - "motohoursEnabled": true,
389 - "mileage": "",
390 - "motohours": 345.0
391 - },
392 - "cmsv6Parameters": { //Параметры CmsV6
393 - "id": null,
394 - "enabled": true, //флаг включения
395 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
396 - "login": "", // имя учетной записи
397 - "password": "" // пароль учетной записи
398 - },
399 - "inspectionTasks": [ // задания на ТО
400 - {
401 - "id": "", // ID задачи
402 - "enabled": false, // Признак включения
403 - "name": "", // Имя задания
404 - "description": "", // Описание задания
405 - "mileageCondition": "", // Условие по пробегу
406 - "lastMileage": "", // Пробег (в метрах)
407 - "motohoursCondition": "", // Условие по моточасам
408 - "lastMotohours": "", // Моточасы
409 - "periodicCondition": "", // Условие периодичности по времени
410 - "kind": "", // Вид периодичности по времени
411 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
412 - }
413 - ]}}}
833 + "vehicleId": "", ~/~/ID ТС 
834 + "parentId": "", ~/~/Guid владельца ТС
835 + "name": "", ~/~/Имя объекта
836 + "imei": "", ~/~/IMEI
837 + "deviceTypeId": "", ~/~/ID типа устройства
838 + "modelId": "", ~/~/ID модели
839 + "unitId": "", ~/~/ID подразделения
840 + "sim1": "", ~/~/SIM1
841 + "sim2": "", ~/~/SIM2
842 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
843 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
844 + "counters": { ~/~/Счётчики
845 + "mileageEnabled": true,
846 + "motohoursEnabled": true,
847 + "mileage": "",
848 + "motohours": 345.0
849 + },
850 + "cmsv6Parameters": { ~/~/Параметры CmsV6
851 + "id": null,
852 + "enabled": true, ~/~/флаг включения
853 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
854 + "login": "", ~/~/ имя учетной записи
855 + "password": "" ~/~/ пароль учетной записи
856 + },
857 + "inspectionTasks": { ~/~/ задания на ТО
858 + "id": "", ~/~/ ID задачи
859 + "enabled": false, ~/~/ Признак включения
860 + "name": "", ~/~/ Имя задания
861 + "description": "", ~/~/ Описание задания
862 + "mileageCondition": "", ~/~/ Условие по пробегу
863 + "lastMileage": "", ~/~/ Пробег (в метрах)
864 + "motohoursCondition": "", ~/~/ Условие по моточасам
865 + "lastMotohours": "", ~/~/ Моточасы
866 + "periodicCondition": "", ~/~/ Условие периодичности по времени
867 + "kind": "", ~/~/ Вид периодичности по времени 
868 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
869 + }
414 414  
415 415  (% style="text-align:left" %)
416 416  (% style="color:#000000" %)}
417 417  
874 +**Валидация:**
875 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
876 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
877 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
418 418  
419 -(% class="box successmessage" %)
879 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
880 +
881 +(% class="box infomessage" %)
420 420  (((
421 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
883 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
422 422  )))
423 423  
424 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
886 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
425 425  
426 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
888 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
427 427  
428 428  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
429 429  
430 430  (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
431 431  
432 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
894 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
433 433  
434 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
896 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
435 435  
436 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
898 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
437 437  
438 438  (% style="color:#000000" %)Метод запроса: **POST**
439 439  
... ... @@ -441,78 +441,115 @@
441 441  
442 442  (% style="color:#000000" %)В заголовках запроса:
443 443  
444 -(% style="color:#000000" %)− Content-Type: application/json
906 +(% style="color:#000000" %)− Content-Type: __**application/json**__
445 445  
446 446  (% style="color:#000000" %)− X-Auth: Токен авторизации
447 447  
448 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
910 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
449 449  
450 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
912 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
451 451  
452 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
914 +{
915 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
916 + "name": null, ~/~/ Имя ТС (string, опционально)
917 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
918 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
919 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
920 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
921 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
922 + "customFields": null ~/~/ значение любого из произвольных полей ТС
923 +}
453 453  
454 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
925 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
455 455  
456 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
927 +(% style="color:#000000" %)Ответ:
457 457  
458 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
929 +(% style="color:#000000" %){
459 459  
460 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
931 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
932 + "name": "" ~/~/ наименование объекта
933 + "imei": "" ~/~/ IMEI объекта
934 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
935 + "deviceTypeName": "" ~/~/ наименование типа устройства
936 + "sim1": "" ~/~/ первый номер телефона
937 + "sim2": "" ~/~/ второй номер телефона
938 + "parentId": "" ~/~/ идентификатор клиента-родителя
939 + "parentName": "" ~/~/ наименование клиента-родителя
940 + "modelId": "" ~/~/ идентификатор модели объекта
941 + "modelName": "" ~/~/ наименование модели объекта
942 + "unitId": "" ~/~/ идентификатор подразделения
943 + "unitName": "" ~/~/ наименование подразделения
944 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
945 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
946 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
947 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
948 + "customFields": [ 
949 + {
950 + "id": "", ~/~/ идентификатор произвольного поля
951 + "name": "", ~/~/ имя произвольного поля
952 + "value": "", ~/~/ значение произвольного поля
953 + "forClient": true, ~/~/ право на отображение у клиента
954 + "forTooltip": false, ~/~/ право на отображение в подсказке
955 + "forReport": false ~/~/ право на отображение в отчетах
956 + }(%%)
957 +(% style="color:#000000" %)}
461 461  
462 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
959 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
463 463  
464 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
961 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
465 465  
466 -
467 467  (% class="box successmessage" %)
468 468  (((
469 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
965 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
470 470  )))
471 471  
472 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
968 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
473 473  
474 474  (% style="color:#000000" %)Метод запроса: **POST**
475 475  
476 476  (% 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}
477 477  
478 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
974 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
479 479  
480 480  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
481 481  
482 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
978 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
483 483  
484 -(% class="western" %)
485 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
486 -  // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
487 -  // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
488 - "date": "", // Дата смены статуса (null если сменить немедленно)
489 - "description": "", // Описание
490 - "data": "", // Данные
491 - "overwrite": false, // Флаг перезаписи
492 - "stage": "", // Состояние, может быть null}}}
980 +(% style="color:#000000" %){
493 493  
982 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
983 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
984 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
985 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
986 + "description": "", ~/~/ Описание
987 + "data": "", ~/~/ Данные
988 + "overwrite": false, ~/~/ Флаг перезаписи
989 + "stage": "", ~/~/ Состояние, может быть null
990 +
494 494  (% style="color:#000000" %)}
495 495  
496 -(% style="color:#000000" %)Ответ: {
993 +(% style="color:#000000" %)Ответ:
497 497  
498 -(% class="western" %)
499 -{{{ "status": "", // значение статуса
500 - "date": "", // Дата смены статуса
501 - "description": "", // Описание
502 - "data": "", // Данные
503 - "overwrite": false, // Флаг перезаписи
504 - "stage": "", // Состояние}}}
995 +(% style="color:#000000" %){
505 505  
997 + "status": "", ~/~/ значение статуса
998 + "date": "", ~/~/ Дата смены статуса 
999 + "description": "", ~/~/ Описание
1000 + "data": "", ~/~/ Данные
1001 + "overwrite": false, ~/~/ Флаг перезаписи
1002 + "stage": "", ~/~/ Состояние
1003 +
506 506  (% style="text-align:left" %)
507 -(% style="color:#000000" %)}
1005 +(% style="color:#000000" %) }
508 508  
1007 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
509 509  
510 510  (% class="box warningmessage" %)
511 511  (((
512 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1011 +(% lang="en-US" %)**PUT /api/v3/vehicles**
513 513  )))
514 514  
515 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1014 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
516 516  
517 517  (% style="color:#000000" %)Метод запроса: **PUT**
518 518  
... ... @@ -522,26 +522,132 @@
522 522  
523 523  (% style="color:#000000" %)Параметры в теле запроса (JSON):
524 524  
525 -(% 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»: «» //Сколько раз выполнить задание } ] }
1024 +(% style="color:#000000" %){    
526 526  
1026 +(((
1027 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1028 + "parentId": "", ~/~/ ID клиента
1029 + "name": "", ~/~/ имя ТС
1030 + "imei": "", ~/~/ IMEI
1031 + "deviceTypeId": "", ~/~/ ID типа устройства
1032 + "modelId": "", ~/~/ , ID модели    
1033 + "unitId": "", ~/~/ подразделения
1034 + "sim1": "", ~/~/ SIM 1
1035 + "sim2": "", ~/~/ SIM2     (%%)
1036 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1037 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1038 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1039 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1040 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1041 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1042 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1043 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1044 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1045 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1046 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1047 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1048 +(% style="color:#000000" %) "counters": 
1049 + {
1050 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1051 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1052 + "mileage": "", ~/~/ пробег, в метрах 
1053 + "motohours": "" ~/~/ моточасы, в секундах
1054 + }
1055 + "cmsv6Parameters": ~/~/ параметры CMSv6
1056 + {       
1057 + "id": "", ~/~/ идентификатор
1058 + "enabled": true, ~/~/ флаг включения
1059 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1060 + "login": "", ~/~/ имя учетной записи
1061 + "password": "", ~/~/ пароль учетной записи
1062 + }
1063 + "inspectionTasks": ~/~/ задания на ТО
1064 + {
1065 + "id": "", ~/~/ ID задания
1066 + "enabled": false, ~/~/ Признак включения
1067 + "name": "", ~/~/ Имя задания
1068 + "description": "", ~/~/ Описание задания
1069 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1070 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1071 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1072 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1073 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1074 + "kind": "", ~/~/ Вид периодичности по времени
1075 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1076 + } 
1077 +)))
1078 +
1079 +(% style="color:#000000" %)}
1080 +
527 527  (% style="color:#000000" %)Ответ:
528 528  
529 529  (% lang="en-US" style="text-align:left" %)
530 -(% 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»: «» //Сколько раз выполнить задание } ] }
1084 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
531 531  
1086 +(% lang="en-US" style="text-align:left" %)
1087 + "vehicleId": "", ~/~/ ID ТС
1088 + "parentId": "", ~/~/ ID клиента
1089 + "name": "", ~/~/ имя ТС
1090 + "imei": "", ~/~/ IMEI
1091 + "deviceTypeId": "", ~/~/ типа устройства
1092 + "modelId": "", ~/~/ ID модели
1093 + "unitId": "", ~/~/ ID подразделения
1094 + "sim1": "", ~/~/ SIM 1
1095 + "sim2": "", ~/~/ SIM2
1096 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1097 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1098 + "counters": 
1099 + {
1100 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1101 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1102 + "mileage": "", ~/~/ пробег
1103 + "motohours": "", ~/~/ моточасы
1104 + }
1105 + "cmsv6Parameters": ~/~/ параметры CMSv6
1106 + {
1107 + "id": ~/~/ идентификатор
1108 + "enabled": true, ~/~/ флаг включения
1109 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1110 + "login": "", ~/~/ имя учетной записи
1111 + "password": "", ~/~/ пароль учетной записи
1112 + }
1113 + "inspectionTasks": ~/~/ задания на ТО
1114 + {
1115 + "id": "", ~/~/ ID задания
1116 + "enabled": false, ~/~/ Признак включения
1117 + "name": "", ~/~/ Имя задания
1118 + "description": "", ~/~/ Описание задания
1119 + "mileageCondition": "", ~/~/ Условие по пробегу
1120 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1121 + "motohoursCondition": "", ~/~/ Условие по моточасам
1122 + "lastMotohours": "", ~/~/ Моточасы
1123 + "periodicCondition": "", ~/~/ Условие периодичности по времени
1124 + "kind": "", ~/~/ Вид периодичности по времени
1125 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1126 + }
532 532  
1128 +(% lang="en-US" style="text-align:left" %)
1129 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1130 +
1131 +**Валидация:**
1132 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1133 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1134 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1135 +
1136 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1137 +
533 533  (% class="box errormessage" %)
534 534  (((
535 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1140 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
536 536  )))
537 537  
538 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1143 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
539 539  
540 540  (% style="color:#000000" %)Метод запроса: **DELETE**
541 541  
542 542  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
543 543  
544 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1149 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
545 545  
546 546  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
547 547  
... ... @@ -548,70 +548,351 @@
548 548  (% style="text-align:left" %)
549 549  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
550 550  
1156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
551 551  
552 -(% class="box" lang="en-US" style="text-align: center;" %)
1158 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1159 +
1160 +(% class="box infomessage" %)
553 553  (((
554 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1162 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
555 555  )))
556 556  
1165 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
1166 +
1167 +(% style="color:#000000" %)Метод запроса: **GET**
1168 +
1169 +(% 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]]
1170 +
1171 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1172 +
1173 +(% style="color:#000000" %)Ответ:
1174 +
1175 +(% style="color:#000000" %){
1176 +
1177 + "deviceTypeId" : "", ~/~/ ID типа устройства
1178 + "deviceTypeName" : "" ~/~/ Название типа устройства
1179 +
1180 +(% style="text-align:left" %)
1181 +(% style="color:#000000" %)}
1182 +
1183 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1184 +
1185 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1186 +
557 557  (% class="box infomessage" %)
558 558  (((
559 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1189 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
560 560  )))
561 561  
562 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1192 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
563 563  
564 564  (% style="color:#000000" %)Метод запроса: **GET**
565 565  
566 -(% 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]]
1196 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
567 567  
568 568  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
569 569  
570 -(% style="color:#000000" %)Ответ: [
1200 +(% style="color:#000000" %)Ответ:
571 571  
572 -(% class="western" %)
573 -{{{ {
574 - "deviceTypeId" : "", // ID типа устройства
575 - "deviceTypeName" : "" // Название типа устройства
576 - },}}}
1202 +(% style="color:#000000" %){
577 577  
1204 + "id": "", ~/~/ ID типа датчика 
1205 + "name": "", ~/~/ Название
1206 + "description": "", ~/~/ Описание
1207 +
578 578  (% style="text-align:left" %)
579 -(% style="color:#000000" %)…** **]
1209 +(% style="color:#000000" %)}
580 580  
1211 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
581 581  
582 -(% class="box" style="text-align: center;" %)
1213 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1214 +
1215 +(% class="box infomessage" style="text-align: left;" %)
583 583  (((
584 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1217 +**POST /api/v3/terminalMessages/count**
585 585  )))
586 586  
1220 +(% style="text-align: left;" %)
1221 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
1222 +
1223 +(% style="text-align: left;" %)
1224 +Метод запроса **POST**
1225 +
1226 +(% style="text-align: left;" %)
1227 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1228 +
1229 +(% style="text-align: left;" %)
1230 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1231 +
1232 +(% style="text-align: left;" %)
1233 +{
1234 + "vehicleIds": [
1235 + id ~/~/ здесь передается список идентификаторов объектов
1236 + ],
1237 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1238 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1239 +}
1240 +
1241 +(% style="text-align: left;" %)
1242 +Ответ:
1243 +
1244 +(% style="text-align: left;" %)
1245 +[
1246 + {
1247 + "vehicleId": 0, ~/~/ идентификатор объекта
1248 + "count": 0 ~/~/ количество сообщений за период
1249 + }
1250 +]
1251 +
1252 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1253 +
587 587  (% class="box infomessage" %)
588 588  (((
589 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1256 +**POST /api/v3/terminalMessages**
590 590  )))
591 591  
592 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе бязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1259 +Метод возвращает список сообщений терминала объекта за выбранный период.
593 593  
594 -(% style="color:#000000" %)Метод запроса: **GET**
1261 +(% style="text-align: left;" %)
1262 +Метод запроса **POST**
595 595  
596 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1264 +(% style="text-align: left;" %)
1265 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
597 597  
598 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1267 +(% style="text-align: left;" %)
1268 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
599 599  
600 -(% style="color:#000000" %)Ответ: [
1270 +{
1271 + "vehicleId": 0, ~/~/ id объекта
1272 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
1273 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1274 +}
601 601  
602 -(% class="western" style="margin-bottom:19px" %)
603 -{{{ {}}}
1276 +Ответ:
604 604  
605 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
1278 +[
1279 + {
1280 + "messages": [
1281 + {
1282 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1283 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1284 + "speed": 0, ~/~/ Скорость, км/ч
1285 + "altitude": 0, ~/~/ Высота, м
1286 + "latitude": 0, ~/~/ Широта [-90°;90°]
1287 + "longitude": 0, ~/~/ Долгота [-180°;180°]
1288 + "satellites": 0, ~/~/ Кол-во спутников
1289 + "voltage": 0, ~/~/ Напряжение
1290 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1291 + "additionalProp1": "string",
1292 + "additionalProp2": "string",
1293 + "additionalProp3": "string"
1294 + },
1295 + "photoCount": 0 ~/~/ Кол-во фото
1296 + }
1297 + ]
1298 + }
1299 +]
606 606  
607 -(% class="western" %)
608 -{{{ "description": "" // Описание
609 - },}}}
1301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
610 610  
611 -(% style="text-align:left" %)
612 -(% style="color:#000000" %)… ]
1303 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
613 613  
1305 +(% class="box infomessage" %)
1306 +(((
1307 +**POST /api/v3/notifications/find**
1308 +)))
614 614  
1310 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1311 +
1312 +(% style="text-align: left;" %)
1313 +Метод запроса **POST**
1314 +
1315 +(% style="text-align: left;" %)
1316 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
1317 +
1318 +(% style="text-align: left;" %)
1319 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1320 +
1321 +{
1322 + "parentId": "" ~/~/ id клиента
1323 +}
1324 +
1325 +Ответ:
1326 +
1327 +[
1328 + {
1329 + "id": 0, ~/~/ ID уведомления
1330 + "name": "string", ~/~/ Название уведомления
1331 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1332 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1333 + "userId": "", ~/~/ Пользователь, создавший уведомление
1334 + "parentId": "", ~/~/ Идентификатор клиента
1335 + "parentName": "string" ~/~/ Имя клиента
1336 + }
1337 +]
1338 +
1339 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1340 +
1341 +(% class="box infomessage" %)
1342 +(((
1343 +**GET /api/v3/notifications/{id}**
1344 +)))
1345 +
1346 +Метод возвращает данные правил формирования выбранного уведомления.
1347 +
1348 +(% style="text-align: left;" %)
1349 +Метод запроса **GET**
1350 +
1351 +(% style="text-align: left;" %)
1352 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1353 +
1354 +(% style="text-align: left;" %)
1355 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
1356 +
1357 +(% style="text-align: left;" %)
1358 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1359 +
1360 +(% style="text-align: left;" %)
1361 +(% style="color:#000000" %)Ответ:
1362 +
1363 +(% style="text-align: left;" %)
1364 +(% style="color:#000000" %){
1365 + "id": 0, ~/~/ (%%)id уведомления
1366 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1367 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
1368 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
1369 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
1370 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
1371 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
1372 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
1373 +(% style="color:#000000" %) 0
1374 + ],
1375 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
1376 +(% style="color:#000000" %) 0
1377 + ],
1378 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
1379 +(% style="color:#000000" %) 0
1380 + ],
1381 + "settings": { ~/~/ Список параметров уведомления
1382 + "additionalProp1": "string",
1383 + "additionalProp2": "string",
1384 + "additionalProp3": "string"
1385 + },
1386 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1387 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1388 +(% style="color:#000000" %) ""
1389 + ],
1390 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1391 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
1392 +(% style="color:#000000" %) "string"
1393 + ],
1394 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
1395 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
1396 +(% style="color:#000000" %) {
1397 + "id": 0, ~/~/ (%%)Идентификатор участника чата
1398 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
1399 +(% style="color:#000000" %) }
1400 + ],
1401 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
1402 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
1403 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1404 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
1405 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1406 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
1407 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
1408 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
1409 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 +(% style="color:#000000" %)}
1411 +
1412 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1413 +
1414 +(% class="box warningmessage" %)
1415 +(((
1416 +**PUT /api/v3/notifications/**
1417 +)))
1418 +
1419 +Метод позволяет отредактировать уведомление.
1420 +
1421 +Метод запроса **PUT**
1422 +
1423 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1424 +
1425 +В заголовках запроса: X-Auth: Токен авторизации
1426 +
1427 +Тело запроса:
1428 +{
1429 + "id": 0, ~/~/ id уведомления
1430 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1431 + "userId": "", ~/~/ Пользователь, создавший уведомление
1432 + "parentId": "", ~/~/ Идентификатор клиента
1433 + "parentName": "string", ~/~/ Имя клиента
1434 + "name": "string", ~/~/ Название уведомления
1435 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1436 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1437 + 0
1438 + ],
1439 + "geoids": [ ~/~/ Список id геообъектов для анализа
1440 + 0
1441 + ],
1442 + "fieldids": [ ~/~/ Список id полей для анализа
1443 + 0
1444 + ],
1445 + "settings": { ~/~/ Список параметров уведомления
1446 + "additionalProp1": "string",
1447 + "additionalProp2": "string",
1448 + "additionalProp3": "string"
1449 + },
1450 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1451 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1452 + ""
1453 + ],
1454 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1455 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1456 + "string"
1457 + ],
1458 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1459 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1460 + {
1461 + "id": 0, ~/~/ Идентификатор участника чата
1462 + "info": "string" ~/~/ Дополнительные сведения
1463 + }
1464 + ],
1465 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1466 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1467 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1468 + "kind": 0, ~/~/ Определяет вид уведомления
1469 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1470 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1471 + "timezone": 0, ~/~/ Сдвиг часового пояса
1472 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1473 + "autoProlongation": true ~/~/ Автопродление срока действия
1474 +}
1475 +
1476 +Ответ:
1477 +
1478 +Success
1479 +
1480 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1481 +
1482 +(% class="box errormessage" %)
1483 +(((
1484 +**DELETE /api/v3/notifications/{id}**
1485 +)))
1486 +
1487 +Метод позволяет удалить выбранное уведомление.
1488 +
1489 +Метод запроса **DELETE**
1490 +
1491 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1492 +
1493 +Передаваемый параметр: {id} - id уведомления
1494 +
1495 +В заголовках запроса: X-Auth: Токен авторизации
1496 +
1497 +Ответ:
1498 +
1499 +Success
1500 +
615 615  (% class="box" lang="en-US" style="text-align: center;" %)
616 616  (((
617 617  (% 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 г.