Last modified by Андрей Калиновский on 2025/03/19 14:01
<
From version < 22.4 >
edited by Артем Шемяков
on 2022/09/02 10:05
To version < 76.6 >
edited by Илья Крайнов
on 2023/03/14 14:35
>
Change comment: (Autosaved)

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,39 +1,46 @@
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 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}
42 +
43 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,8 +40,8 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 47  }
... ... @@ -48,13 +48,14 @@
48 48  
49 49  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
50 50  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
51 51  
52 52  (% class="box infomessage" %)
53 53  (((
54 -(% 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**
55 55  )))
56 56  
57 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
58 58  
59 59  (% style="color:#000000" %)Метод запроса: **GET**
60 60  
... ... @@ -65,18 +65,58 @@
65 65  (% lang="en-US" %)
66 66  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
67 67  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
68 68  
69 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
70 70  (((
71 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
72 72  )))
73 73  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
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": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
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 +
74 74  (% class="box infomessage" %)
75 75  (((
76 -(% 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(%%)**
77 77  )))
78 78  
79 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
80 80  
81 81  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
82 82  
... ... @@ -84,37 +84,184 @@
84 84  
85 85  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
86 86  
87 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
88 88  
89 -(% 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
90 90  
91 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
92 92  
93 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 96  
97 -(% style="color:#000000" %){
98 - "agentId": "", ~/~/ идентификатор клиента
99 - "parentId": "", ~/~/ идентификатор клиента-родителя
100 - "name": "", ~/~/ наименование клиента
101 - "fullName": "", ~/~/ полное наименование клиента
102 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента
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 - Отказ)
104 104  }
105 105  
157 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
106 106  
107 -(% class="box" style="text-align: center;" %)
159 +(% class="box successmessage" %)
108 108  (((
109 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
161 +**POST /api/v3/agents **
110 110  )))
111 111  
164 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
165 +
166 +Метод запроса: **POST**
167 +
168 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
169 +
170 +В заголовках запроса: X-Auth: Токен авторизации
171 +
172 +Параметры в теле запроса (JSON):
173 +
174 +{
175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 + "name": "string", ~/~/ имя
177 + "fullName": "string", ~/~/ полное наименование
178 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
179 + "isForeign": true, ~/~/ иностранный контрагент
180 + "district": "string", ~/~/ округ
181 + "region": "string", ~/~/ регион
182 + "city": "string", ~/~/ город
183 + "inn": "string", ~/~/ ИНН
184 + "kpp": "string", ~/~/ КПП
185 + "address": "string", ~/~/ юридический адрес
186 + "addressFact": "string", ~/~/ фактический адрес
187 + "email": "string", ~/~/ email
188 + "director": "string", ~/~/ ФИО руководителя
189 + "bankName": "string", ~/~/ банк
190 + "bankBIK": "string", ~/~/ БИК
191 + "bankRS": "string", ~/~/ номер счёта
192 + "bankKS": "string" ~/~/ корр. счёт
193 +}
194 +
195 +
196 +Ответ:
197 +
198 +{
199 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
200 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
201 + "name": "string", ~/~/ имя
202 + "fullName": "string", ~/~/ полное наименование
203 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
204 + "isForeign": true, ~/~/ иностранный контрагент
205 + "district": "string", ~/~/ округ
206 + "region": "string", ~/~/ регион
207 + "city": "string", ~/~/ город
208 + "inn": "string", ~/~/ ИНН
209 + "kpp": "string", ~/~/ КПП
210 + "address": "string", ~/~/ юридический адрес
211 + "addressFact": "string", ~/~/ фактический адрес
212 + "email": "string", ~/~/ email
213 + "director": "string", ~/~/ ФИО руководителя
214 + "bankName": "string", ~/~/ банк
215 + "bankBIK": "string", ~/~/ БИК
216 + "bankRS": "string", ~/~/ номер счёта
217 + "bankKS": "string" ~/~/ корр. счёт
218 +}
219 +
220 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 +
222 +(% class="box warningmessage" %)
223 +(((
224 +**PUT /api/v3/agents**
225 +)))
226 +
227 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
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 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
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 +
112 112  (% class="box successmessage" %)
113 113  (((
114 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
309 +(% lang="en-US" %)**POST /api/v3/users**
115 115  )))
116 116  
117 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
312 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
118 118  
119 119  (% style="color:#000000" %)Метод запроса: **POST**
120 120  
... ... @@ -130,9 +130,9 @@
130 130   "position": "", ~/~/ должность
131 131   "phone": "", ~/~/ телефон
132 132   "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
328 + "login": "", ~/~/ логин (обязателен)
329 + "password": "", ~/~/ пароль (обязателен)
330 + "email": "", ~/~/ email (обязателен)
136 136   "description": "", ~/~/ описание
137 137   "isEnabled": "", ~/~/ признак включения
138 138   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -141,7 +141,7 @@
141 141   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
339 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
145 145  }
146 146  
147 147  (% style="text-align:left" %)
... ... @@ -167,27 +167,30 @@
167 167   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 168   "kind": "" , ~/~/ тип аутентификации
169 169   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
365 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
171 171  
172 172  (% style="text-align:left" %)
173 173  (% style="color:#000000; font-weight:normal" %)}
174 174  
370 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
175 175  
176 -(% class="box successmessage" %)
372 +(% class="box infomessage" %)
177 177  (((
178 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
374 +(% lang="en-US" %)**POST /api/v3/users/find**
179 179  )))
180 180  
181 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
377 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
182 182  
183 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
379 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
184 184  
185 185  (% style="color:#000000" %)Метод запроса: **POST**
186 186  
187 187  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
188 188  
189 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
385 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
190 190  
387 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
388 +
191 191  (% style="color:#000000" %){
192 192  
193 193   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
... ... @@ -217,13 +217,66 @@
217 217  
218 218  (% style="color:#000000" %)}
219 219  
418 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
220 220  
420 +(% class="box infomessage" %)
421 +(((
422 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
423 +)))
424 +
425 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
426 +
427 +(% style="color:#000000" %)Метод запроса: **GET**
428 +
429 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
430 +
431 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
432 +
433 +(% style="color:#000000" %)Ответ:
434 +
435 +(((
436 +(((
437 +{
438 + "id": "", ~/~/ GUID пользователя
439 + "lastName": "", ~/~/ Фамилия 
440 + "firstName": "", ~/~/ Имя
441 + "position": "", ~/~/ Должность
442 + "phone": "", ~/~/ Номер телефона
443 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
444 + "parentName": "", Наименование клиента, которому принадлежит пользователь
445 + "organization": "", ~/~/ Организация
446 + "login": "", ~/~/ Логин пользователя
447 + "email": "", ~/~/ Адрес электронной почты
448 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
449 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
450 + "description": "", ~/~/ Описание
451 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
452 + "doubleAuth":
453 + {
454 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
455 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
456 + },
457 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
458 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
459 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
460 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
461 + "groups": [], ~/~/ Список ролей пользователя
462 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
463 + "authDevices": [ ], ~/~/ Список авторизованных устройств
464 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
465 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
466 +}
467 +)))
468 +)))
469 +
470 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
471 +
221 221  (% class="box warningmessage" %)
222 222  (((
223 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
474 +(% lang="en-US" %)**PUT /api/v3/users**
224 224  )))
225 225  
226 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
477 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
227 227  
228 228  (% style="color:#000000" %)Метод запроса: **PUT**
229 229  
... ... @@ -244,17 +244,19 @@
244 244   "position": "" , ~/~/ должность
245 245   "phone": "" , ~/~/ телефон
246 246   "organization": "" , ~/~/ организация
247 - "login": "" , ~/~/ логин
248 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
249 - "email": "" , ~/~/ email
250 - "description": "" , ~/~/ описание
498 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
499 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
500 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
501 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
251 251   "isEnabled": "" , ~/~/ признак включения
252 252   "parentId": "" , ~/~/ Guid родительского агента
253 253   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
254 254   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
255 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
256 - "kind": "" , ~/~/ тип аутентификации
257 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
506 + "doubleAuth":
507 + {
508 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
509 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
510 + },
258 258   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
259 259  
260 260  (% lang="en-US" style="text-align:left" %)
... ... @@ -280,8 +280,11 @@
280 280   "isEnabled": "" , ~/~/ признак включения
281 281   "parentId": "" , ~/~/ Guid родительского агента
282 282   "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
283 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
284 - "kind": "" , ~/~/ тип аутентификации
536 + "doubleAuth":
537 + {
538 + "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
539 + "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
540 + },
285 285   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
286 286   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
287 287  
... ... @@ -288,13 +288,14 @@
288 288  (% lang="en-US" style="text-align:left" %)
289 289  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
290 290  
547 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
291 291  
292 292  (% class="box warningmessage" %)
293 293  (((
294 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
551 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
295 295  )))
296 296  
297 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
554 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
298 298  
299 299  (% style="color:#000000" %)Метод запроса: **PUT**
300 300  
... ... @@ -317,19 +317,79 @@
317 317  (% style="text-align:left" %)
318 318  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
319 319  
577 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
320 320  
579 +(% class="box warningmessage" %)
580 +(((
581 +**POST /api/v3/users/disable**
582 +)))
583 +
584 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
585 +
586 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
587 +
588 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
589 +
590 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
591 +
592 + [ 
593 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
594 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
595 + ]
596 +
597 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
598 +
599 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
600 +
601 +(% class="box warningmessage" %)
602 +(((
603 +**POST /api/v3/users/enable**
604 +)))
605 +
606 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
607 +
608 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
609 +
610 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
611 +
612 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
613 +
614 + [ 
615 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
616 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
617 + ]
618 +
619 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
620 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
621 +
622 +(((
623 +В теле ответа:
624 +{
625 + "errorMessages": [
626 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
627 + ],
628 + "users": [
629 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
630 + ]
631 +}
632 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
633 +"users" - массив id пользователей, которых не удалось включить или отключить.
634 +)))
635 +
636 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
637 +
321 321  (% class="box errormessage" %)
322 322  (((
323 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
640 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
324 324  )))
325 325  
326 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
643 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
327 327  
328 328  (% style="color:#000000" %)Метод запроса: **DELETE**
329 329  
330 330  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
331 331  
332 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
649 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
333 333  
334 334  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
335 335  
... ... @@ -336,51 +336,73 @@
336 336  (% style="text-align:left" %)
337 337  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
338 338  
656 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
339 339  
340 -(% class="box" style="text-align: center;" %)
341 -(((
342 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
343 -)))
658 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
344 344  
345 345  (% class="box infomessage" %)
346 346  (((
347 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
662 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
348 348  )))
349 349  
350 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
665 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
351 351  
352 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
667 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
353 353  
354 354  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
355 355  
356 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
671 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
357 357  
358 358  (% style="color:#000000" %)Метод запроса: **GET**
359 359  
360 360  (% 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>
361 361  
362 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
677 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
363 363  
364 364  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
365 365  
366 366  (% style="color:#000000" %)Ответ:
367 367  
368 -(% style="color:#000000" %){
369 -
370 - "vehicleId": "" , ~/~/ идентификатор объекта
371 - "name": "" , ~/~/ имя объекта
372 - "imei": "" , ~/~/ IMEI объекта
373 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
374 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
375 - "parentId": "" , ~/~/ идентификатор клиента-родителя
376 - "parentName": "" , ~/~/ наименование клиента-родителя,
377 - "modelId": "" , ~/~/ идентификатор модели объекта
378 - "modelName": "" , ~/~/ наименование модели объекта,
379 - "unitId": "" , ~/~/ идентификатор подразделения
380 - "unitName": "" , ~/~/ наименование подразделения
381 - "status": "" , ~/~/ статус объекта
382 -
683 +(((
684 +{
685 + "vehicleId": "", ~/~/ ID объекта
686 + "name": "", ~/~/ Имя объекта
687 + "imei": "", ~/~/ IMEI объекта
688 + "deviceTypeId": , ~/~/ ID типа устройства
689 + "deviceTypeName": "", ~/~/ Название типа устройства
690 + "sim1": "", ~/~/ Номер SIM1
691 + "parentId": "", Номер SIM2
692 + "parentName": "", Наименование клиента-родителя
693 + "modelId": "", ID модели объекта
694 + "modelName": "", Имя модели объекта
695 + "createdAt": "", Дата создания объекта
696 + "mileageCalcMethod": "", Выбранный метод расчета пробега
697 + "counters": { ~/~/ Нормы
698 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
699 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
700 + "mileage": "", ~/~/ Пробег по нормам в метрах
701 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
702 + "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
703 + "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
704 + },
705 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
706 + {
707 + "id": "", ~/~/ ID  задания
708 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
709 + "name": "", ~/~/ Наименование задания
710 + "description": "", ~/~/ Описание задания
711 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
712 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
713 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
714 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
715 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
716 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
717 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
718 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
719 + }
720 + ]
383 383  }
722 +)))
384 384  
385 385  (% style="text-align:left" %)
386 386  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -388,13 +388,14 @@
388 388  (% style="text-align:left" %)
389 389  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
390 390  
730 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
391 391  
392 392  (% class="box successmessage" %)
393 393  (((
394 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
734 +(% lang="en-US" %)**POST /api/v3/vehicles**
395 395  )))
396 396  
397 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
737 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
398 398  
399 399  (% style="color:#000000" %)Метод запроса: **POST**
400 400  
... ... @@ -416,12 +416,22 @@
416 416   "sim2": "" , ~/~/ Номер SIM2
417 417   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
418 418   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
419 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
420 - "counters": {
421 - "mileage": "" , ~/~/ пробег
422 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
423 - "motohours": "" , ~/~/ моточасы
424 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
759 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
760 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
761 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
762 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
763 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
764 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
765 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
766 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
767 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
768 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
769 + "counters": ~/~/ счетчики
770 + {
771 + "mileage": "" , ~/~/ пробег
772 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
773 + "motohours": "" , ~/~/ моточасы
774 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
425 425   },
426 426   "cmsv6Parameters": { ~/~/ параметры CMSv6
427 427   "enabled": true, ~/~/ флаг включения
... ... @@ -492,15 +492,21 @@
492 492  (% style="text-align:left" %)
493 493  (% style="color:#000000" %)}
494 494  
845 +**Валидация:**
846 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
847 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
848 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
495 495  
496 -(% class="box successmessage" %)
850 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
851 +
852 +(% class="box infomessage" %)
497 497  (((
498 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
854 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
499 499  )))
500 500  
501 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
857 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
502 502  
503 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
859 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
504 504  
505 505  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
506 506  
... ... @@ -518,24 +518,26 @@
518 518  
519 519  (% style="color:#000000" %)В заголовках запроса:
520 520  
521 -(% style="color:#000000" %)− Content-Type: application/json
877 +(% style="color:#000000" %)− Content-Type: __**application/json**__
522 522  
523 523  (% style="color:#000000" %)− X-Auth: Токен авторизации
524 524  
525 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
881 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
526 526  
527 -(% class="western" style="color:#000000" %)##{##
883 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
528 528  
529 -(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
530 - "name": null, ~/~/ Имя ТС (string, опционально) 
531 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
532 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
533 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
534 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
535 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
536 -(% style="color:#000000" %)}
885 +{
886 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
887 + "name": null, ~/~/ Имя ТС (string, опционально)
888 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
889 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
890 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
891 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
892 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
893 + "customFields": null ~/~/ значение любого из произвольных полей ТС
894 +}
537 537  
538 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
896 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
539 539  
540 540  (% style="color:#000000" %)Ответ:
541 541  
... ... @@ -554,27 +554,37 @@
554 554   "modelName": "" ~/~/ наименование модели объекта
555 555   "unitId": "" ~/~/ идентификатор подразделения
556 556   "unitName": "" ~/~/ наименование подразделения
557 - "status": "" ~/~/ статус объекта         
558 - "createdAt": "" ~/~/ дата создания объектов  (%%)
915 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
916 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
917 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
918 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
919 + "customFields": [ 
920 + {
921 + "id": "", ~/~/ идентификатор произвольного поля
922 + "name": "", ~/~/ имя произвольного поля
923 + "value": "", ~/~/ значение произвольного поля
924 + "forClient": true, ~/~/ право на отображение у клиента
925 + "forTooltip": false, ~/~/ право на отображение в подсказке
926 + "forReport": false ~/~/ право на отображение в отчетах
927 + }(%%)
559 559  (% style="color:#000000" %)}
560 560  
561 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
930 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
562 562  
563 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
932 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
564 564  
565 -
566 566  (% class="box successmessage" %)
567 567  (((
568 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
936 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
569 569  )))
570 570  
571 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
939 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
572 572  
573 573  (% style="color:#000000" %)Метод запроса: **POST**
574 574  
575 575  (% 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}
576 576  
577 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
945 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
578 578  
579 579  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
580 580  
... ... @@ -607,13 +607,14 @@
607 607  (% style="text-align:left" %)
608 608  (% style="color:#000000" %) }
609 609  
978 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
610 610  
611 611  (% class="box warningmessage" %)
612 612  (((
613 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
982 +(% lang="en-US" %)**PUT /api/v3/vehicles**
614 614  )))
615 615  
616 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
985 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
617 617  
618 618  (% style="color:#000000" %)Метод запроса: **PUT**
619 619  
... ... @@ -625,6 +625,7 @@
625 625  
626 626  (% style="color:#000000" %){    
627 627  
997 +(((
628 628  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
629 629   "parentId": "", ~/~/ ID клиента
630 630   "name": "", ~/~/ имя ТС
... ... @@ -633,15 +633,25 @@
633 633   "modelId": "", ~/~/ , ID модели    
634 634   "unitId": "", ~/~/ подразделения
635 635   "sim1": "", ~/~/ SIM 1
636 - "sim2": "", ~/~/ SIM2
637 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
638 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
639 - "counters": 
1006 + "sim2": "", ~/~/ SIM2     (%%)
1007 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1008 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1009 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1010 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1011 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1012 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1013 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1014 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1015 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1016 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1017 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1018 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1019 +(% style="color:#000000" %) "counters": 
640 640   {
641 641   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
642 642   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
643 - "mileage": «», пробег
644 - "motohours": «» моточасы
1023 + "mileage": "", ~/~/ пробег, в метрах 
1024 + "motohours": "" ~/~/ моточасы, в секундах
645 645   }
646 646   "cmsv6Parameters": ~/~/ параметры CMSv6
647 647   {       
... ... @@ -665,6 +665,7 @@
665 665   "kind": "", ~/~/ Вид периодичности по времени
666 666   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
667 667   } 
1048 +)))
668 668  
669 669  (% style="color:#000000" %)}
670 670  
... ... @@ -718,19 +718,25 @@
718 718  (% lang="en-US" style="text-align:left" %)
719 719  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
720 720  
1102 +**валидация:**
1103 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1104 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1105 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
721 721  
1107 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1108 +
722 722  (% class="box errormessage" %)
723 723  (((
724 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1111 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
725 725  )))
726 726  
727 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1114 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
728 728  
729 729  (% style="color:#000000" %)Метод запроса: **DELETE**
730 730  
731 731  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
732 732  
733 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
1120 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
734 734  
735 735  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
736 736  
... ... @@ -737,18 +737,16 @@
737 737  (% style="text-align:left" %)
738 738  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
739 739  
1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
740 740  
741 -(% class="box" lang="en-US" style="text-align: center;" %)
742 -(((
743 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
744 -)))
1129 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
745 745  
746 746  (% class="box infomessage" %)
747 747  (((
748 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1133 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
749 749  )))
750 750  
751 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1136 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
752 752  
753 753  (% style="color:#000000" %)Метод запроса: **GET**
754 754  
... ... @@ -766,24 +766,22 @@
766 766  (% style="text-align:left" %)
767 767  (% style="color:#000000" %)}
768 768  
1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
769 769  
770 -(% class="box" style="text-align: center;" %)
771 -(((
772 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
773 -)))
1156 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
774 774  
775 775  (% class="box infomessage" %)
776 776  (((
777 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1160 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
778 778  )))
779 779  
780 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1163 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
781 781  
782 782  (% style="color:#000000" %)Метод запроса: **GET**
783 783  
784 784  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
785 785  
786 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787 787  
788 788  (% style="color:#000000" %)Ответ:
789 789  
... ... @@ -796,7 +796,48 @@
796 796  (% style="text-align:left" %)
797 797  (% style="color:#000000" %)}
798 798  
1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
799 799  
1184 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
1185 +
1186 +(% class="box infomessage" style="text-align: left;" %)
1187 +(((
1188 +**POST /api/v3/terminalMessages/count**
1189 +)))
1190 +
1191 +(% style="text-align: left;" %)
1192 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1193 +
1194 +(% style="text-align: left;" %)
1195 +Метод запроса **POST**
1196 +
1197 +(% style="text-align: left;" %)
1198 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
1199 +
1200 +(% style="text-align: left;" %)
1201 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1202 +
1203 +(% style="text-align: left;" %)
1204 +{
1205 + "vehicleIds": [
1206 + id ~/~/ здесь передается список идентификаторов объектов
1207 + ],
1208 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
1209 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
1210 +}
1211 +
1212 +(% style="text-align: left;" %)
1213 +Ответ:
1214 +
1215 +(% style="text-align: left;" %)
1216 +[
1217 + {
1218 + "vehicleId": 0, ~/~/ идентификатор объекта
1219 + "count": 0 ~/~/ количество сообщений за период
1220 + }
1221 +]
1222 +
1223 +
800 800  (% class="box" lang="en-US" style="text-align: center;" %)
801 801  (((
802 802  (% 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 г.