Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 27.1 >
edited by Артем Шемяков
on 2022/09/20 09:17
To version < 76.1 >
edited by Илья Крайнов
on 2023/03/14 11:30
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Content
... ... @@ -1,37 +1,37 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
11 -(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
6 +{{toc/}}
12 12  
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 +(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 +
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 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" %)В случае успешного выполнения метода, поле «(% style="color: rgb(0, 0, 0);" %)__**AuthId**__(% style="color:#000000" %)» содержит токен авторизации «(% style="color: rgb(0, 0, 0);" %)__**X-Auth**__(% style="color:#000000" %)».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,58 @@
72 72  (% lang="en-US" %)
73 73  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74 74  
76 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
75 75  
76 -(% class="box" style="text-align: center;" %)
78 +== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
79 +
80 +(% class="box infomessage" %)
77 77  (((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
82 +**GET api/v3/agents/{id}**
79 79  )))
80 80  
85 +Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__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 +
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
124 +(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
127 +(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -91,37 +91,194 @@
91 91  
92 92  (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 93  
94 -(% style="color:#000000" %)Метод запроса: **GET**
135 +(% style="color:#000000" %)Метод запроса: **POST**
95 95  
96 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
137 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
97 97  
98 -(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
139 +(% style="color:#000000" %)Параметр запроса:
99 99  
100 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
141 +(% style="color:#000000" %){
142 + "parentId": "string"
143 +}
101 101  
102 102  (% style="color:#000000" %)Ответ:
103 103  
104 -(% style="color:#000000" %){
105 - "agentId": "", ~/~/ идентификатор клиента
106 - "parentId": "", ~/~/ идентификатор клиента-родителя
107 - "name": "", ~/~/ наименование клиента
108 - "fullName": "", ~/~/ полное наименование клиента
109 - "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
147 +{
148 + "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 + "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 + "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 + "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 + "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 + "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
154 + "isForeign": true/false, ~/~/ Иностранный контрагент
155 + "district": "string", ~/~/ округ
156 + "region": "string", ~/~/ регион
157 + "city": "string", ~/~/ город
158 + "inn": "string", ~/~/ ИНН клиента
159 + "kpp": "string", ~/~/ КПП клиента
160 + "address": "string", ~/~/ юридический адрес
161 + "addressFact": "string", ~/~/ фактический адрес
162 + "email": "string", ~/~/ почта
163 + "director": "string", ~/~/ ФИО руководителя
164 + "bankName": "string", ~/~/ Банк
165 + "bankBIK": "string", ~/~/ БИК
166 + "bankRS": "string", ~/~/ Номер счета
167 + "bankKS": "string" ~/~/ Корр. счет
168 + }
169 +
170 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
171 +
172 +(% class="box successmessage" %)
173 +(((
174 +**POST /api/v3/agents **
175 +)))
176 +
177 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
178 +
179 +Метод запроса: **POST**
180 +
181 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
182 +
183 +В заголовках запроса: X-Auth: Токен авторизации
184 +
185 +Параметры в теле запроса (JSON):
186 +
187 +{
188 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
189 + "name": "string", ~/~/ имя
190 + "fullName": "string", ~/~/ полное наименование
191 + "isForeign": true, ~/~/ иностранный контрагент
192 + "district": "string", ~/~/ округ
193 + "region": "string", ~/~/ регион
194 + "city": "string", ~/~/ город
195 + "inn": "string", ~/~/ ИНН
196 + "kpp": "string", ~/~/ КПП
197 + "address": "string", ~/~/ юридический адрес
198 + "addressFact": "string", ~/~/ фактический адрес
199 + "email": "string", ~/~/ email
200 + "director": "string", ~/~/ ФИО руководителя
201 + "bankName": "string", ~/~/ банк
202 + "bankBIK": "string", ~/~/ БИК
203 + "bankRS": "string", ~/~/ номер счёта
204 + "bankKS": "string" ~/~/ корр. счёт
111 111  }
112 112  
113 113  
114 -(% class="box" style="text-align: center;" %)
208 +Ответ:
209 +
210 +{
211 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
212 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
213 + "name": "string", ~/~/ имя
214 + "fullName": "string", ~/~/ полное наименование
215 + "isForeign": true, ~/~/ иностранный контрагент
216 + "district": "string", ~/~/ округ
217 + "region": "string", ~/~/ регион
218 + "city": "string", ~/~/ город
219 + "inn": "string", ~/~/ ИНН
220 + "kpp": "string", ~/~/ КПП
221 + "address": "string", ~/~/ юридический адрес
222 + "addressFact": "string", ~/~/ фактический адрес
223 + "email": "string", ~/~/ email
224 + "director": "string", ~/~/ ФИО руководителя
225 + "bankName": "string", ~/~/ банк
226 + "bankBIK": "string", ~/~/ БИК
227 + "bankRS": "string", ~/~/ номер счёта
228 + "bankKS": "string" ~/~/ корр. счёт
229 +}
230 +
231 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
232 +
233 +(% class="box warningmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
235 +**PUT /api/v3/agents**
117 117  )))
118 118  
238 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
239 +
240 +Метод запроса: **PUT**
241 +
242 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
243 +
244 +В заголовках запроса: X-Auth: Токен авторизации
245 +
246 +
247 +Параметры в теле запроса (JSON):
248 +
249 +{
250 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
251 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
252 + "name": "string", ~/~/ имя
253 + "fullName": "string", ~/~/ полное наименование
254 + "isForeign": true, ~/~/ иностранный контрагент
255 + "district": "string", ~/~/ округ
256 + "region": "string", ~/~/ регион
257 + "city": "string", ~/~/ город
258 + "inn": "string", ~/~/ ИНН
259 + "kpp": "string", ~/~/ КПП
260 + "address": "string", ~/~/ юридический адрес
261 + "addressFact": "string", ~/~/ фактический адрес
262 + "email": "string", ~/~/ email
263 + "director": "string", ~/~/ ФИО руководителя
264 + "bankName": "string", ~/~/ банк
265 + "bankBIK": "string", ~/~/ БИК
266 + "bankRS": "string", ~/~/ номер счёта
267 + "bankKS": "string" ~/~/ корр. счёт
268 +}
269 +
270 +
271 +Ответ:
272 +
273 +{
274 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
275 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
276 + "name": "string", ~/~/ имя
277 + "fullName": "string", ~/~/ полное наименование
278 + "isForeign": true, ~/~/ иностранный контрагент
279 + "district": "string", ~/~/ округ
280 + "region": "string", ~/~/ регион
281 + "city": "string", ~/~/ город
282 + "inn": "string", ~/~/ ИНН
283 + "kpp": "string", ~/~/ КПП
284 + "address": "string", ~/~/ юридический адрес
285 + "addressFact": "string", ~/~/ фактический адрес
286 + "email": "string", ~/~/ email
287 + "director": "string", ~/~/ ФИО руководителя
288 + "bankName": "string", ~/~/ банк
289 + "bankBIK": "string", ~/~/ БИК
290 + "bankRS": "string", ~/~/ номер счёта
291 + "bankKS": "string" ~/~/ корр. счёт
292 +}
293 +
294 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
295 +
296 +(% class="box errormessage" %)
297 +(((
298 +**DELETE /api/v3/agents/{clientId}**
299 +)))
300 +
301 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
302 +
303 +Метод запроса: **DELETE**
304 +
305 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
306 +
307 +Параметр запроса: **{clientId}** - Guid пользователя
308 +
309 +В заголовках запроса: X-Auth: Токен авторизации
310 +
311 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
312 +
313 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
314 +
315 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
316 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
319 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
322 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
338 + "login": "", ~/~/ логин (обязателен)
339 + "password": "", ~/~/ пароль (обязателен)
340 + "email": "", ~/~/ email (обязателен)
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
349 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,18 +174,19 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
375 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
380 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 -(% class="box successmessage" %)
382 +(% class="box infomessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
384 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
387 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -226,13 +226,63 @@
226 226  
227 227  (% style="color:#000000" %)}
228 228  
428 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
430 +(% class="box infomessage" %)
431 +(((
432 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
433 +)))
434 +
435 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
436 +
437 +(% style="color:#000000" %)Метод запроса: **GET**
438 +
439 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
440 +
441 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
442 +
443 +(% style="color:#000000" %)Ответ:
444 +
445 +(((
446 +(((
447 +{
448 + "id": "", ~/~/ GUID пользователя
449 + "lastName": "", ~/~/ Фамилия 
450 + "firstName": "", ~/~/ Имя
451 + "position": "", ~/~/ Должность
452 + "phone": "", ~/~/ Номер телефона
453 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
454 + "parentName": "", Наименование клиента, которому принадлежит пользователь
455 + "organization": "", ~/~/ Организация
456 + "login": "", ~/~/ Логин пользователя
457 + "email": "", ~/~/ Адрес электронной почты
458 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
459 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
460 + "description": "", ~/~/ Описание
461 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
462 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
463 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
464 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
465 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
466 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
467 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
468 + "groups": [], ~/~/ Список ролей пользователя
469 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
470 + "authDevices": [ ], ~/~/ Список авторизованных устройств
471 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
472 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
473 +}
474 +)))
475 +)))
476 +
477 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
478 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
481 +(% lang="en-US" %)**PUT /api/v3/users**
233 233  )))
234 234  
235 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
484 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **PUT**
238 238  
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
505 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
506 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
507 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
508 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -297,13 +297,14 @@
297 297  (% lang="en-US" style="text-align:left" %)
298 298  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
299 299  
549 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
300 300  
301 301  (% class="box warningmessage" %)
302 302  (((
303 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
553 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
556 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -326,13 +326,73 @@
326 326  (% style="text-align:left" %)
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
579 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
329 329  
581 +(% class="box warningmessage" %)
582 +(((
583 +**POST /api/v3/users/disable**
584 +)))
585 +
586 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
587 +
588 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
589 +
590 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
591 +
592 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
593 +
594 + [ 
595 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
596 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
597 + ]
598 +
599 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
600 +
601 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
602 +
603 +(% class="box warningmessage" %)
604 +(((
605 +**POST /api/v3/users/enable**
606 +)))
607 +
608 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
609 +
610 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
611 +
612 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
613 +
614 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
615 +
616 + [ 
617 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
618 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
619 + ]
620 +
621 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
622 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
623 +
624 +(((
625 +В теле ответа:
626 +{
627 + "errorMessages": [
628 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
629 + ],
630 + "users": [
631 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
632 + ]
633 +}
634 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
635 +"users" - массив id пользователей, которых не удалось включить или отключить.
636 +)))
637 +
638 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
639 +
330 330  (% class="box errormessage" %)
331 331  (((
332 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
642 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
333 333  )))
334 334  
335 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
645 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
336 336  
337 337  (% style="color:#000000" %)Метод запроса: **DELETE**
338 338  
... ... @@ -345,20 +345,18 @@
345 345  (% style="text-align:left" %)
346 346  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
347 347  
658 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
348 348  
349 -(% class="box" style="text-align: center;" %)
350 -(((
351 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
352 -)))
660 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
353 353  
354 354  (% class="box infomessage" %)
355 355  (((
356 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
664 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
357 357  )))
358 358  
359 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
667 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
360 360  
361 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
669 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
362 362  
363 363  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
364 364  
... ... @@ -374,22 +374,44 @@
374 374  
375 375  (% style="color:#000000" %)Ответ:
376 376  
377 -(% style="color:#000000" %){
378 -
379 - "vehicleId": "" , ~/~/ идентификатор объекта
380 - "name": "" , ~/~/ имя объекта
381 - "imei": "" , ~/~/ IMEI объекта
382 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 - "parentId": "" , ~/~/ идентификатор клиента-родителя
385 - "parentName": "" , ~/~/ наименование клиента-родителя,
386 - "modelId": "" , ~/~/ идентификатор модели объекта
387 - "modelName": "" , ~/~/ наименование модели объекта,
388 - "unitId": "" , ~/~/ идентификатор подразделения
389 - "unitName": "" , ~/~/ наименование подразделения
390 - "status": "" , ~/~/ статус объекта
391 -
685 +(((
686 +{
687 + "vehicleId": "", ~/~/ ID объекта
688 + "name": "", ~/~/ Имя объекта
689 + "imei": "", ~/~/ IMEI объекта
690 + "deviceTypeId": , ~/~/ ID типа устройства
691 + "deviceTypeName": "", ~/~/ Название типа устройства
692 + "sim1": "", ~/~/ Номер SIM1
693 + "parentId": "", Номер SIM2
694 + "parentName": "", Наименование клиента-родителя
695 + "modelId": "", ID модели объекта
696 + "modelName": "", Имя модели объекта
697 + "createdAt": "", Дата создания объекта
698 + "mileageCalcMethod": "", Выбранный метод расчета пробега
699 + "counters": { ~/~/ Нормы
700 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
701 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
702 + "mileage": "", ~/~/ Пробег по нормам в метрах
703 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
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 + ]
392 392  }
722 +)))
393 393  
394 394  (% style="text-align:left" %)
395 395  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -397,13 +397,14 @@
397 397  (% style="text-align:left" %)
398 398  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
399 399  
730 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
400 400  
401 401  (% class="box successmessage" %)
402 402  (((
403 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
734 +(% lang="en-US" %)**POST /api/v3/vehicles**
404 404  )))
405 405  
406 -(% 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**__).
407 407  
408 408  (% style="color:#000000" %)Метод запроса: **POST**
409 409  
... ... @@ -425,12 +425,22 @@
425 425   "sim2": "" , ~/~/ Номер SIM2
426 426   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 427   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
428 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 - "counters": {
430 - "mileage": "" , ~/~/ пробег
431 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
432 - "motohours": "" , ~/~/ моточасы
433 - "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 ~/~/ флаг активности счётчика "моточасы"
434 434   },
435 435   "cmsv6Parameters": { ~/~/ параметры CMSv6
436 436   "enabled": true, ~/~/ флаг включения
... ... @@ -501,15 +501,21 @@
501 501  (% style="text-align:left" %)
502 502  (% style="color:#000000" %)}
503 503  
845 +**Валидация:**
846 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
847 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
848 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
504 504  
505 -(% class="box successmessage" %)
850 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
851 +
852 +(% class="box infomessage" %)
506 506  (((
507 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
854 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
508 508  )))
509 509  
510 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
857 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
511 511  
512 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
859 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
513 513  
514 514  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
515 515  
... ... @@ -535,19 +535,19 @@
535 535  
536 536  (% style="color:#000000" %)Параметры в теле запроса (JSON):
537 537  
538 -(% class="western" 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 +}
539 539  
540 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
541 - "name": null, ~/~/ Имя ТС (string, опционально) 
542 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
543 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
544 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
545 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
546 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
547 -(% style="color:#000000" %)}
896 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
548 548  
549 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
550 -
551 551  (% style="color:#000000" %)Ответ:
552 552  
553 553  (% style="color:#000000" %){
... ... @@ -568,18 +568,28 @@
568 568   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
569 569   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
570 570   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
571 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
918 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
919 + "customFields": [ 
920 + {
921 + "id": "", ~/~/ идентификатор произвольного поля
922 + "name": "", ~/~/ имя произвольного поля
923 + "value": "", ~/~/ значение произвольного поля
924 + "forClient": true, ~/~/ право на отображение у клиента
925 + "forTooltip": false, ~/~/ право на отображение в подсказке
926 + "forReport": false ~/~/ право на отображение в отчетах
927 + }(%%)
572 572  (% style="color:#000000" %)}
573 573  
574 574  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
575 575  
932 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
576 576  
577 577  (% class="box successmessage" %)
578 578  (((
579 -(% 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}**
580 580  )))
581 581  
582 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
939 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
583 583  
584 584  (% style="color:#000000" %)Метод запроса: **POST**
585 585  
... ... @@ -618,13 +618,14 @@
618 618  (% style="text-align:left" %)
619 619  (% style="color:#000000" %) }
620 620  
978 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
621 621  
622 622  (% class="box warningmessage" %)
623 623  (((
624 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
982 +(% lang="en-US" %)**PUT /api/v3/vehicles**
625 625  )))
626 626  
627 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
985 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
628 628  
629 629  (% style="color:#000000" %)Метод запроса: **PUT**
630 630  
... ... @@ -636,6 +636,7 @@
636 636  
637 637  (% style="color:#000000" %){    
638 638  
997 +(((
639 639  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
640 640   "parentId": "", ~/~/ ID клиента
641 641   "name": "", ~/~/ имя ТС
... ... @@ -644,15 +644,25 @@
644 644   "modelId": "", ~/~/ , ID модели    
645 645   "unitId": "", ~/~/ подразделения
646 646   "sim1": "", ~/~/ SIM 1
647 - "sim2": "", ~/~/ SIM2
648 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
649 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
650 - "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": 
651 651   {
652 652   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
653 653   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
654 - "mileage": «», пробег
655 - "motohours": «» моточасы
1023 + "mileage": "", ~/~/ пробег, в метрах 
1024 + "motohours": "" ~/~/ моточасы, в секундах
656 656   }
657 657   "cmsv6Parameters": ~/~/ параметры CMSv6
658 658   {       
... ... @@ -676,6 +676,7 @@
676 676   "kind": "", ~/~/ Вид периодичности по времени
677 677   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
678 678   } 
1048 +)))
679 679  
680 680  (% style="color:#000000" %)}
681 681  
... ... @@ -729,13 +729,19 @@
729 729  (% lang="en-US" style="text-align:left" %)
730 730  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
731 731  
1102 +**валидация:**
1103 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1104 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1105 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
732 732  
1107 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1108 +
733 733  (% class="box errormessage" %)
734 734  (((
735 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1111 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
736 736  )))
737 737  
738 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1114 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
739 739  
740 740  (% style="color:#000000" %)Метод запроса: **DELETE**
741 741  
... ... @@ -748,18 +748,16 @@
748 748  (% style="text-align:left" %)
749 749  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
750 750  
1127 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
751 751  
752 -(% class="box" lang="en-US" style="text-align: center;" %)
753 -(((
754 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
755 -)))
1129 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
756 756  
757 757  (% class="box infomessage" %)
758 758  (((
759 -(% 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**
760 760  )))
761 761  
762 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1136 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
763 763  
764 764  (% style="color:#000000" %)Метод запроса: **GET**
765 765  
... ... @@ -777,24 +777,22 @@
777 777  (% style="text-align:left" %)
778 778  (% style="color:#000000" %)}
779 779  
1154 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
780 780  
781 -(% class="box" style="text-align: center;" %)
782 -(((
783 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
784 -)))
1156 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
785 785  
786 786  (% class="box infomessage" %)
787 787  (((
788 -(% 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**
789 789  )))
790 790  
791 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1163 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
792 792  
793 793  (% style="color:#000000" %)Метод запроса: **GET**
794 794  
795 795  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
796 796  
797 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1169 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
798 798  
799 799  (% style="color:#000000" %)Ответ:
800 800  
... ... @@ -807,7 +807,48 @@
807 807  (% style="text-align:left" %)
808 808  (% style="color:#000000" %)}
809 809  
1182 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Статистика**(%%) =
810 810  
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 + "objectIds": [
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 + "id": 0, ~/~/ идентификатор объекта
1219 + "count": 0 ~/~/ количество сообщений за период
1220 + }
1221 +]
1222 +
1223 +
811 811  (% class="box" lang="en-US" style="text-align: center;" %)
812 812  (((
813 813  (% 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 г.