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

Summary

Details

Icon Page properties
Content
... ... @@ -1,31 +1,31 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API 3.0 ==
3 -
4 -== ==
5 -
6 -(% class="box" style="text-align: center;" %)
7 7  (((
8 -(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
3 +**Содержание страницы:**
9 9  )))
10 10  
6 +{{toc/}}
7 +
8 +
9 += (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 +
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 13  (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 -
17 17  
18 -(% class="box" style="text-align: center;" %)
19 -(((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 -)))
17 +(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
22 22  
23 -(% class="box successmessage" %)
19 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 +
21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
22 +
23 +(% class="box infomessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
25 +(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
28 +(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 30  (% style="color:#000000" %)Метод запроса: **POST**
31 31  
... ... @@ -38,9 +38,9 @@
38 38  (% style="color:#000000" %){
39 39   "login": "testuser",
40 40   "password": "testuser"
41 -}(%%)
42 -
41 +}
43 43  
43 +
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -55,13 +55,14 @@
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
58 +== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
58 58  
59 59  (% class="box infomessage" %)
60 60  (((
61 -(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 +(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 +(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -72,18 +72,16 @@
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;" %)
77 -(((
78 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 -)))
78 +== (% style="color:#000000; font-size:16px" %)**Получение основных параметров клиента**(%%) ==
80 80  
81 81  (% class="box infomessage" %)
82 82  (((
83 -(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
82 +(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
85 +(% style="color:#000000" %)Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -110,18 +110,159 @@
110 110   "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 111  }
112 112  
112 +== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
113 113  
114 -(% class="box" style="text-align: center;" %)
114 +(% class="box successmessage" %)
115 115  (((
116 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
116 +**POST /api/v3/agents **
117 117  )))
118 118  
119 +Метод позволяет добавить клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
120 +
121 +Метод запроса: **POST**
122 +
123 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
124 +
125 +В заголовках запроса: X-Auth: Токен авторизации
126 +
127 +Параметры в теле запроса (JSON):
128 +
129 +{
130 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
131 + "name": "string", ~/~/ имя
132 + "fullName": "string", ~/~/ полное наименование
133 + "isForeign": true, ~/~/ иностранный контрагент
134 + "district": "string", ~/~/ округ
135 + "region": "string", ~/~/ регион
136 + "city": "string", ~/~/ город
137 + "inn": "string", ~/~/ ИНН
138 + "kpp": "string", ~/~/ КПП
139 + "address": "string", ~/~/ юридический адрес
140 + "addressFact": "string", ~/~/ фактический адрес
141 + "email": "string", ~/~/ email
142 + "director": "string", ~/~/ ФИО руководителя
143 + "bankName": "string", ~/~/ банк
144 + "bankBIK": "string", ~/~/ БИК
145 + "bankRS": "string", ~/~/ номер счёта
146 + "bankKS": "string" ~/~/ корр. счёт
147 +}
148 +
149 +
150 +Ответ:
151 +
152 +{
153 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
154 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
155 + "name": "string", ~/~/ имя
156 + "fullName": "string", ~/~/ полное наименование
157 + "isForeign": true, ~/~/ иностранный контрагент
158 + "district": "string", ~/~/ округ
159 + "region": "string", ~/~/ регион
160 + "city": "string", ~/~/ город
161 + "inn": "string", ~/~/ ИНН
162 + "kpp": "string", ~/~/ КПП
163 + "address": "string", ~/~/ юридический адрес
164 + "addressFact": "string", ~/~/ фактический адрес
165 + "email": "string", ~/~/ email
166 + "director": "string", ~/~/ ФИО руководителя
167 + "bankName": "string", ~/~/ банк
168 + "bankBIK": "string", ~/~/ БИК
169 + "bankRS": "string", ~/~/ номер счёта
170 + "bankKS": "string" ~/~/ корр. счёт
171 +}
172 +
173 +== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
174 +
175 +(% class="box warningmessage" %)
176 +(((
177 +**PUT /api/v3/agents**
178 +)))
179 +
180 +Метод позволяет отредактировать клиента, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
181 +
182 +Метод запроса: **PUT**
183 +
184 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
185 +
186 +В заголовках запроса: X-Auth: Токен авторизации
187 +
188 +
189 +Параметры в теле запроса (JSON):
190 +
191 +{
192 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
193 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
194 + "name": "string", ~/~/ имя
195 + "fullName": "string", ~/~/ полное наименование
196 + "isForeign": true, ~/~/ иностранный контрагент
197 + "district": "string", ~/~/ округ
198 + "region": "string", ~/~/ регион
199 + "city": "string", ~/~/ город
200 + "inn": "string", ~/~/ ИНН
201 + "kpp": "string", ~/~/ КПП
202 + "address": "string", ~/~/ юридический адрес
203 + "addressFact": "string", ~/~/ фактический адрес
204 + "email": "string", ~/~/ email
205 + "director": "string", ~/~/ ФИО руководителя
206 + "bankName": "string", ~/~/ банк
207 + "bankBIK": "string", ~/~/ БИК
208 + "bankRS": "string", ~/~/ номер счёта
209 + "bankKS": "string" ~/~/ корр. счёт
210 +}
211 +
212 +
213 +Ответ:
214 +
215 +{
216 + "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
217 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
218 + "name": "string", ~/~/ имя
219 + "fullName": "string", ~/~/ полное наименование
220 + "isForeign": true, ~/~/ иностранный контрагент
221 + "district": "string", ~/~/ округ
222 + "region": "string", ~/~/ регион
223 + "city": "string", ~/~/ город
224 + "inn": "string", ~/~/ ИНН
225 + "kpp": "string", ~/~/ КПП
226 + "address": "string", ~/~/ юридический адрес
227 + "addressFact": "string", ~/~/ фактический адрес
228 + "email": "string", ~/~/ email
229 + "director": "string", ~/~/ ФИО руководителя
230 + "bankName": "string", ~/~/ банк
231 + "bankBIK": "string", ~/~/ БИК
232 + "bankRS": "string", ~/~/ номер счёта
233 + "bankKS": "string" ~/~/ корр. счёт
234 +}
235 +
236 +== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
237 +
238 +(% class="box errormessage" %)
239 +(((
240 +**DELETE /api/v3/agents/{clientId}**
241 +)))
242 +
243 +Метод позволяет удалить клиента, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «**X-Auth**»).
244 +
245 +Метод запроса: **DELETE**
246 +
247 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
248 +
249 +Параметр запроса: **{clientId}** - Guid пользователя
250 +
251 +В заголовках запроса: X-Auth: Токен авторизации
252 +
253 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
254 +
255 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
256 +
257 +== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
258 +
119 119  (% class="box successmessage" %)
120 120  (((
121 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
261 +(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
264 +(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125 125  
126 126  (% style="color:#000000" %)Метод запроса: **POST**
127 127  
... ... @@ -179,13 +179,14 @@
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
181 181  
322 +== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
182 182  
183 183  (% class="box successmessage" %)
184 184  (((
185 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
326 +(% lang="en-US" %)**POST /api/v3/users/find**
186 186  )))
187 187  
188 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
329 +(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 190  (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 191  
... ... @@ -226,135 +226,63 @@
226 226  
227 227  (% style="color:#000000" %)}
228 228  
370 +== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
229 229  
230 230  (% class="box successmessage" %)
231 231  (((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
374 +(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 233  )))
234 234  
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
377 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236 236  
237 237  (% style="color:#000000" %)Метод запроса: **GET**
238 238  
239 239  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240 240  
383 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
384 +
241 241  (% style="color:#000000" %)Ответ:
242 242  
243 243  (((
244 -{
245 -)))
246 -
247 247  (((
389 +{
248 248   "id": "", ~/~/ GUID пользователя
249 -)))
250 -
251 -(((
252 - "lastName": "", ~/~/ Фамилия
253 -)))
254 -
255 -(((
391 + "lastName": "", ~/~/ Фамилия 
256 256   "firstName": "", ~/~/ Имя
257 -)))
258 -
259 -(((
260 260   "position": "", ~/~/ Должность
261 -)))
262 -
263 -(((
264 264   "phone": "", ~/~/ Номер телефона
265 -)))
266 -
267 -(((
268 268   "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 -)))
270 -
271 -(((
272 272   "parentName": "", Наименование клиента, которому принадлежит пользователь
273 -)))
274 -
275 -(((
276 276   "organization": "", ~/~/ Организация
277 -)))
278 -
279 -(((
280 280   "login": "", ~/~/ Логин пользователя
281 -)))
282 -
283 -(((
284 284   "email": "", ~/~/ Адрес электронной почты
285 -)))
286 -
287 -(((
288 288   "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 -)))
290 -
291 -(((
292 292   "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 -)))
294 -
295 -(((
296 296   "description": "", ~/~/ Описание
297 -)))
298 -
299 -(((
300 300   "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 -)))
302 -
303 -(((
304 304   "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 -)))
306 -
307 -(((
308 308   "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 -)))
310 -
311 -(((
312 312   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 -)))
314 -
315 -(((
316 316   "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 -)))
318 -
319 -(((
320 320   "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 -)))
322 -
323 -(((
324 324   "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 -)))
326 -
327 -(((
328 328   "groups": [], ~/~/ Список ролей пользователя
329 -)))
330 -
331 -(((
332 332   "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 -)))
334 -
335 -(((
336 336   "authDevices": [ ], ~/~/ Список авторизованных устройств
337 -)))
338 -
339 -(((
340 340   "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 -)))
342 -
343 -(((
344 344   "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 -)))
346 -
347 -(((
348 348  }
349 349  )))
417 +)))
350 350  
419 +== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
351 351  
352 352  (% class="box warningmessage" %)
353 353  (((
354 -(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
423 +(% lang="en-US" %)**PUT /api/v3/users**
355 355  )))
356 356  
357 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
426 +(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
358 358  
359 359  (% style="color:#000000" %)Метод запроса: **PUT**
360 360  
... ... @@ -419,13 +419,14 @@
419 419  (% lang="en-US" style="text-align:left" %)
420 420  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
421 421  
491 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
422 422  
423 423  (% class="box warningmessage" %)
424 424  (((
425 -(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
495 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
426 426  )))
427 427  
428 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
498 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -448,10 +448,11 @@
448 448  (% style="text-align:left" %)
449 449  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
450 450  
521 +== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
451 451  
452 452  (% class="box warningmessage" %)
453 453  (((
454 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
525 +**POST /api/v3/users/disable**
455 455  )))
456 456  
457 457  Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -469,10 +469,11 @@
469 469  
470 470  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
471 471  
543 +== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
472 472  
473 473  (% class="box warningmessage" %)
474 474  (((
475 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
547 +**POST /api/v3/users/enable**
476 476  )))
477 477  
478 478  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -503,15 +503,16 @@
503 503  }
504 504  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
505 505  "users" - массив id пользователей, которых не удалось включить или отключить.
506 -
507 507  )))
508 508  
580 +== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
581 +
509 509  (% class="box errormessage" %)
510 510  (((
511 -(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
584 +(% lang="en-US" %)**DELETE /api/v3/users/{id}**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
587 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **DELETE**
517 517  
... ... @@ -524,20 +524,18 @@
524 524  (% style="text-align:left" %)
525 525  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
526 526  
600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
527 527  
528 -(% class="box" style="text-align: center;" %)
529 -(((
530 -(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
531 -)))
602 +== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
532 532  
533 533  (% class="box infomessage" %)
534 534  (((
535 -(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
606 +(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
536 536  )))
537 537  
538 -(% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
609 +(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
539 539  
540 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
611 +(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
541 541  
542 542  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
543 543  
... ... @@ -555,145 +555,40 @@
555 555  
556 556  (((
557 557  {
558 -)))
559 -
560 -(((
561 561   "vehicleId": "", ~/~/ ID объекта
562 -)))
563 -
564 -(((
565 565   "name": "", ~/~/ Имя объекта
566 -)))
567 -
568 -(((
569 569   "imei": "", ~/~/ IMEI объекта
570 -)))
571 -
572 -(((
573 573   "deviceTypeId": , ~/~/ ID типа устройства
574 -)))
575 -
576 -(((
577 577   "deviceTypeName": "", ~/~/ Название типа устройства
578 -)))
579 -
580 -(((
581 581   "sim1": "", ~/~/ Номер SIM1
582 -)))
583 -
584 -(((
585 585   "parentId": "", Номер SIM2
586 -)))
587 -
588 -(((
589 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 -)))
591 -
592 -(((
636 + "parentName": "", Наименование клиента-родителя
593 593   "modelId": "", ID модели объекта
594 -)))
595 -
596 -(((
597 597   "modelName": "", Имя модели объекта
598 -)))
599 -
600 -(((
601 601   "createdAt": "", Дата создания объекта
602 -)))
603 -
604 -(((
605 605   "mileageCalcMethod": "", Выбранный метод расчета пробега
606 -)))
607 -
608 -(((
609 609   "counters": { ~/~/ Нормы
610 -)))
611 -
612 -(((
613 613   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
614 -)))
615 -
616 -(((
617 617   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
618 -)))
619 -
620 -(((
621 621   "mileage": "", ~/~/ Пробег по нормам в метрах
622 -)))
623 -
624 -(((
625 625   "motohours": "" ~/~/ Моточасы по нормам, в секундах
626 -)))
627 -
628 -(((
629 629   },
630 -)))
631 -
632 -(((
633 633   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 -)))
635 -
636 -(((
637 637   {
638 -)))
639 -
640 -(((
641 - "id": "", ~/~/ ID  задания
642 -)))
643 -
644 -(((
649 + "id": "", ~/~/ ID  задания
645 645   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 -)))
647 -
648 -(((
649 649   "name": "", ~/~/ Наименование задания
650 -)))
651 -
652 -(((
653 653   "description": "", ~/~/ Описание задания
654 -)))
655 -
656 -(((
657 657   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 -)))
659 -
660 -(((
661 661   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 -)))
663 -
664 -(((
665 665   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 -)))
667 -
668 -(((
669 669   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 -)))
671 -
672 -(((
673 673   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 -)))
675 -
676 -(((
677 677   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 -)))
679 -
680 -(((
681 681   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
682 -)))
683 -
684 -(((
685 685   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
686 -)))
687 -
688 -(((
689 689   }
690 -)))
691 -
692 -(((
693 693   ]
694 -)))
695 -
696 -(((
697 697  }
698 698  )))
699 699  
... ... @@ -703,13 +703,14 @@
703 703  (% style="text-align:left" %)
704 704  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
705 705  
672 +== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
706 706  
707 707  (% class="box successmessage" %)
708 708  (((
709 -(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
676 +(% lang="en-US" %)**POST /api/v3/vehicles**
710 710  )))
711 711  
712 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
679 +(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
713 713  
714 714  (% style="color:#000000" %)Метод запроса: **POST**
715 715  
... ... @@ -822,15 +822,16 @@
822 822  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
823 823  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
824 824  
792 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
825 825  
826 826  (% class="box successmessage" %)
827 827  (((
828 -(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
796 +(% lang="en-US" %)**POST /api/v3/vehicles/find**
829 829  )))
830 830  
831 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
799 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
832 832  
833 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
801 +(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
834 834  
835 835  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
836 836  
... ... @@ -856,19 +856,19 @@
856 856  
857 857  (% style="color:#000000" %)Параметры в теле запроса (JSON):
858 858  
859 -(% class="western" style="color:#000000" %)##{##
827 +{
828 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
829 + "name": null, ~/~/ Имя ТС (string, опционально)
830 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
831 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
832 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
833 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
834 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
835 + "customFields": null ~/~/ значение любого из произвольных полей ТС
836 +}
860 860  
861 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
862 - "name": null, ~/~/ Имя ТС (string, опционально) 
863 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
864 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
865 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
866 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
867 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
868 -(% style="color:#000000" %)}
838 +(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
869 869  
870 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
871 -
872 872  (% style="color:#000000" %)Ответ:
873 873  
874 874  (% style="color:#000000" %){
... ... @@ -889,18 +889,28 @@
889 889   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
890 890   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
891 891   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
892 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
860 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
861 + "customFields": [ 
862 + {
863 + "id": "", ~/~/ идентификатор произвольного поля
864 + "name": "", ~/~/ имя произвольного поля
865 + "value": "", ~/~/ значение произвольного поля
866 + "forClient": true, ~/~/ право на отображение у клиента
867 + "forTooltip": false, ~/~/ право на отображение в подсказке
868 + "forReport": false ~/~/ право на отображение в отчетах
869 + }(%%)
893 893  (% style="color:#000000" %)}
894 894  
895 895  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
896 896  
874 +== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
897 897  
898 898  (% class="box successmessage" %)
899 899  (((
900 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
878 +(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
901 901  )))
902 902  
903 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
881 +(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
904 904  
905 905  (% style="color:#000000" %)Метод запроса: **POST**
906 906  
... ... @@ -939,13 +939,14 @@
939 939  (% style="text-align:left" %)
940 940  (% style="color:#000000" %) }
941 941  
920 +== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
942 942  
943 943  (% class="box warningmessage" %)
944 944  (((
945 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
924 +(% lang="en-US" %)**PUT /api/v3/vehicles**
946 946  )))
947 947  
948 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
927 +(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
949 949  
950 950  (% style="color:#000000" %)Метод запроса: **PUT**
951 951  
... ... @@ -1067,13 +1067,14 @@
1067 1067  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1068 1068  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1069 1069  
1049 +== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
1070 1070  
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1053 +(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1074 1074  )))
1075 1075  
1076 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1056 +(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1077 1077  
1078 1078  (% style="color:#000000" %)Метод запроса: **DELETE**
1079 1079  
... ... @@ -1086,18 +1086,16 @@
1086 1086  (% style="text-align:left" %)
1087 1087  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1088 1088  
1069 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
1089 1089  
1090 -(% class="box" lang="en-US" style="text-align: center;" %)
1091 -(((
1092 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1093 -)))
1071 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
1094 1094  
1095 1095  (% class="box infomessage" %)
1096 1096  (((
1097 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1075 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
1098 1098  )))
1099 1099  
1100 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1078 +(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1101 1101  
1102 1102  (% style="color:#000000" %)Метод запроса: **GET**
1103 1103  
... ... @@ -1115,18 +1115,16 @@
1115 1115  (% style="text-align:left" %)
1116 1116  (% style="color:#000000" %)}
1117 1117  
1096 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
1118 1118  
1119 -(% class="box" style="text-align: center;" %)
1120 -(((
1121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1122 -)))
1098 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
1123 1123  
1124 1124  (% class="box infomessage" %)
1125 1125  (((
1126 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1102 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
1127 1127  )))
1128 1128  
1129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1105 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1130 1130  
1131 1131  (% style="color:#000000" %)Метод запроса: **GET**
1132 1132  

Меню

ГЛОНАССSoft wiki - 2024 г.