Last modified by Андрей Калиновский on 2025/03/17 16:44
<
From version < 41.1 >
edited by Илья Крайнов
on 2022/11/18 17:34
To version < 22.8 >
edited by Артем Шемяков
on 2022/09/02 10:12
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Artem
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять **X-Auth** (токен авторизации, получаемый методом **auth/login**).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -20,27 +20,20 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box successmessage" %)
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 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **POST**
30 +(% style="color:#000000" %)Метод запроса: **GET**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 -
38 -(% style="color:#000000" %){
39 - "login": "testuser",
40 - "password": "testuser"
41 -}(%%)
42 -
43 -
36 +(% lang="en-US" %)
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
... ... @@ -47,8 +47,8 @@
47 47  (% style="color:#000000" %){
48 48  
49 49  (% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
52 52  
53 53  (% lang="en-US" %)
54 54  }
... ... @@ -61,7 +61,7 @@
61 61  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 62  )))
63 63  
64 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
57 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
65 65  
66 66  (% style="color:#000000" %)Метод запроса: **GET**
67 67  
... ... @@ -83,7 +83,7 @@
83 83  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 84  )))
85 85  
86 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
79 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
87 87  
88 88  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 89  
... ... @@ -107,7 +107,7 @@
107 107   "name": "", ~/~/ наименование клиента
108 108   "fullName": "", ~/~/ полное наименование клиента
109 109   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
103 + "status": "", ~/~/ статус клиента
111 111  }
112 112  
113 113  
... ... @@ -121,7 +121,7 @@
121 121  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 122  )))
123 123  
124 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
117 +(% 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": "", ~/~/ пароль (обязателен)
142 - "email": "", ~/~/ email (обязателен)
133 + "login": "", ~/~/ логин
134 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 + "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": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
144 + "groups": "" , ~/~/ группы пользователя, названия групп
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
170 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -187,7 +187,7 @@
187 187  
188 188  (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189 189  
190 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
183 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
191 191  
192 192  (% style="color:#000000" %)Метод запроса: **POST**
193 193  
... ... @@ -227,134 +227,12 @@
227 227  (% style="color:#000000" %)}
228 228  
229 229  
230 -(% class="box successmessage" %)
231 -(((
232 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 -)))
234 -
235 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
236 -
237 -(% style="color:#000000" %)Метод запроса: **GET**
238 -
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 -
241 -(% style="color:#000000" %)Ответ:
242 -
243 -(((
244 -{
245 -)))
246 -
247 -(((
248 - "id": "", ~/~/ GUID пользователя
249 -)))
250 -
251 -(((
252 - "lastName": "", ~/~/ Фамилия
253 -)))
254 -
255 -(((
256 - "firstName": "", ~/~/ Имя
257 -)))
258 -
259 -(((
260 - "position": "", ~/~/ Должность
261 -)))
262 -
263 -(((
264 - "phone": "", ~/~/ Номер телефона
265 -)))
266 -
267 -(((
268 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 -)))
270 -
271 -(((
272 - "parentName": "", Наименование клиента, которому принадлежит пользователь
273 -)))
274 -
275 -(((
276 - "organization": "", ~/~/ Организация
277 -)))
278 -
279 -(((
280 - "login": "", ~/~/ Логин пользователя
281 -)))
282 -
283 -(((
284 - "email": "", ~/~/ Адрес электронной почты
285 -)))
286 -
287 -(((
288 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 -)))
290 -
291 -(((
292 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 -)))
294 -
295 -(((
296 - "description": "", ~/~/ Описание
297 -)))
298 -
299 -(((
300 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 -)))
302 -
303 -(((
304 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 -)))
306 -
307 -(((
308 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 -)))
310 -
311 -(((
312 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 -)))
314 -
315 -(((
316 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 -)))
318 -
319 -(((
320 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 -)))
322 -
323 -(((
324 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 -)))
326 -
327 -(((
328 - "groups": [], ~/~/ Список ролей пользователя
329 -)))
330 -
331 -(((
332 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 -)))
334 -
335 -(((
336 - "authDevices": [ ], ~/~/ Список авторизованных устройств
337 -)))
338 -
339 -(((
340 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 -)))
342 -
343 -(((
344 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 -)))
346 -
347 -(((
348 -}
349 -)))
350 -
351 -
352 352  (% class="box warningmessage" %)
353 353  (((
354 354  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
355 355  )))
356 356  
357 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
228 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
358 358  
359 359  (% style="color:#000000" %)Метод запроса: **PUT**
360 360  
... ... @@ -375,10 +375,10 @@
375 375   "position": "" , ~/~/ должность
376 376   "phone": "" , ~/~/ телефон
377 377   "organization": "" , ~/~/ организация
378 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
379 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
380 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
381 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
249 + "login": "" , ~/~/ логин
250 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 + "email": "" , ~/~/ email
252 + "description": "" , ~/~/ описание
382 382   "isEnabled": "" , ~/~/ признак включения
383 383   "parentId": "" , ~/~/ Guid родительского агента
384 384   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -425,7 +425,7 @@
425 425  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
426 426  )))
427 427  
428 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
299 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
429 429  
430 430  (% style="color:#000000" %)Метод запроса: **PUT**
431 431  
... ... @@ -449,69 +449,12 @@
449 449  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
450 450  
451 451  
452 -(% class="box warningmessage" %)
453 -(((
454 -**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
455 -)))
456 -
457 -Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
458 -
459 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
460 -
461 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
462 -
463 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
464 -
465 - [ 
466 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
467 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
468 - ]
469 -
470 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
471 -
472 -
473 -(% class="box warningmessage" %)
474 -(((
475 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
476 -)))
477 -
478 -Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
479 -
480 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
481 -
482 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
483 -
484 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
485 -
486 - [ 
487 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
488 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
489 - ]
490 -
491 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
492 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
493 -
494 -(((
495 -В теле ответа:
496 -{
497 - "errorMessages": [
498 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
499 - ],
500 - "users": [
501 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
502 - ]
503 -}
504 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
505 -"users" - массив id пользователей, которых не удалось включить или отключить.
506 -
507 -)))
508 -
509 509  (% class="box errormessage" %)
510 510  (((
511 511  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
512 512  )))
513 513  
514 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
328 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
515 515  
516 516  (% style="color:#000000" %)Метод запроса: **DELETE**
517 517  
... ... @@ -537,7 +537,7 @@
537 537  
538 538  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
539 539  
540 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
354 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
541 541  
542 542  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
543 543  
... ... @@ -553,149 +553,22 @@
553 553  
554 554  (% style="color:#000000" %)Ответ:
555 555  
556 -(((
557 -{
558 -)))
370 +(% style="color:#000000" %){
559 559  
560 -(((
561 - "vehicleId": "", ~/~/ ID объекта
562 -)))
372 + "vehicleId": "" , ~/~/ идентификатор объекта
373 + "name": "" , ~/~/ имя объекта
374 + "imei": "" , ~/~/ IMEI объекта
375 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
376 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
377 + "parentId": "" , ~/~/ идентификатор клиента-родителя
378 + "parentName": "" , ~/~/ наименование клиента-родителя,
379 + "modelId": "" , ~/~/ идентификатор модели объекта
380 + "modelName": "" , ~/~/ наименование модели объекта,
381 + "unitId": "" , ~/~/ идентификатор подразделения
382 + "unitName": "" , ~/~/ наименование подразделения
383 + "status": "" , ~/~/ статус объекта
563 563  
564 -(((
565 - "name": "", ~/~/ Имя объекта
566 -)))
567 -
568 -(((
569 - "imei": "", ~/~/ IMEI объекта
570 -)))
571 -
572 -(((
573 - "deviceTypeId": , ~/~/ ID типа устройства
574 -)))
575 -
576 -(((
577 - "deviceTypeName": "", ~/~/ Название типа устройства
578 -)))
579 -
580 -(((
581 - "sim1": "", ~/~/ Номер SIM1
582 -)))
583 -
584 -(((
585 - "parentId": "", Номер SIM2
586 -)))
587 -
588 -(((
589 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 -)))
591 -
592 -(((
593 - "modelId": "", ID модели объекта
594 -)))
595 -
596 -(((
597 - "modelName": "", Имя модели объекта
598 -)))
599 -
600 -(((
601 - "createdAt": "", Дата создания объекта
602 -)))
603 -
604 -(((
605 - "mileageCalcMethod": "", Выбранный метод расчета пробега
606 -)))
607 -
608 -(((
609 - "counters": { ~/~/ Нормы
610 -)))
611 -
612 -(((
613 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
614 -)))
615 -
616 -(((
617 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
618 -)))
619 -
620 -(((
621 - "mileage": "", ~/~/ Пробег по нормам в метрах
622 -)))
623 -
624 -(((
625 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
626 -)))
627 -
628 -(((
629 - },
630 -)))
631 -
632 -(((
633 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 -)))
635 -
636 -(((
637 - {
638 -)))
639 -
640 -(((
641 - "id": "", ~/~/ ID  задания
642 -)))
643 -
644 -(((
645 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 -)))
647 -
648 -(((
649 - "name": "", ~/~/ Наименование задания
650 -)))
651 -
652 -(((
653 - "description": "", ~/~/ Описание задания
654 -)))
655 -
656 -(((
657 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 -)))
659 -
660 -(((
661 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 -)))
663 -
664 -(((
665 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 -)))
667 -
668 -(((
669 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 -)))
671 -
672 -(((
673 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 -)))
675 -
676 -(((
677 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 -)))
679 -
680 -(((
681 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
682 -)))
683 -
684 -(((
685 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
686 -)))
687 -
688 -(((
689 - }
690 -)))
691 -
692 -(((
693 - ]
694 -)))
695 -
696 -(((
697 697  }
698 -)))
699 699  
700 700  (% style="text-align:left" %)
701 701  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -709,7 +709,7 @@
709 709  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
710 710  )))
711 711  
712 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
399 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
713 713  
714 714  (% style="color:#000000" %)Метод запроса: **POST**
715 715  
... ... @@ -731,22 +731,12 @@
731 731   "sim2": "" , ~/~/ Номер SIM2
732 732   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
733 733   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
734 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
735 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
736 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
737 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
738 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
739 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
740 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
741 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
742 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
743 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
744 - "counters": ~/~/ счетчики
745 - {
746 - "mileage": "" , ~/~/ пробег
747 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
748 - "motohours": "" , ~/~/ моточасы
749 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
421 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 + "counters": {
423 + "mileage": "" , ~/~/ пробег
424 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 + "motohours": "" , ~/~/ моточасы
426 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
750 750   },
751 751   "cmsv6Parameters": { ~/~/ параметры CMSv6
752 752   "enabled": true, ~/~/ флаг включения
... ... @@ -817,12 +817,7 @@
817 817  (% style="text-align:left" %)
818 818  (% style="color:#000000" %)}
819 819  
820 -**Валидация:**
821 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
822 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
823 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
824 824  
825 -
826 826  (% class="box successmessage" %)
827 827  (((
828 828  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -830,7 +830,7 @@
830 830  
831 831  (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
832 832  
833 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
505 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
834 834  
835 835  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
836 836  
... ... @@ -858,13 +858,13 @@
858 858  
859 859  (% class="western" style="color:#000000" %)##{##
860 860  
861 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
533 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
862 862   "name": null, ~/~/ Имя ТС (string, опционально) 
863 863   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
864 864   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
865 865   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
866 866   "parentId": null, ~/~/ ID клиента (Guid, опционально) 
867 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
539 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
868 868  (% style="color:#000000" %)}
869 869  
870 870  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -886,21 +886,23 @@
886 886   "modelName": "" ~/~/ наименование модели объекта
887 887   "unitId": "" ~/~/ идентификатор подразделения
888 888   "unitName": "" ~/~/ наименование подразделения
889 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
890 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
891 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
892 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
561 + "status": "" ~/~/ статус объекта         
562 + "createdAt": "" ~/~/ дата создания объектов  (%%)
893 893  (% style="color:#000000" %)}
894 894  
895 895  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
896 896  
567 +(% style="color:#000000" %)Параметр «__**status**__» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
897 897  
569 +0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
570 +
571 +
898 898  (% class="box successmessage" %)
899 899  (((
900 900  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
901 901  )))
902 902  
903 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
577 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
904 904  
905 905  (% style="color:#000000" %)Метод запроса: **POST**
906 906  
... ... @@ -945,7 +945,7 @@
945 945  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
946 946  )))
947 947  
948 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
622 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
949 949  
950 950  (% style="color:#000000" %)Метод запроса: **PUT**
951 951  
... ... @@ -957,7 +957,6 @@
957 957  
958 958  (% style="color:#000000" %){    
959 959  
960 -(((
961 961  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
962 962   "parentId": "", ~/~/ ID клиента
963 963   "name": "", ~/~/ имя ТС
... ... @@ -966,25 +966,15 @@
966 966   "modelId": "", ~/~/ , ID модели    
967 967   "unitId": "", ~/~/ подразделения
968 968   "sim1": "", ~/~/ SIM 1
969 - "sim2": "", ~/~/ SIM2     (%%)
970 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
971 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
972 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
973 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
974 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
975 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
976 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
977 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
978 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
979 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
980 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
981 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
982 -(% style="color:#000000" %) "counters": 
642 + "sim2": "", ~/~/ SIM2
643 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
644 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
645 + "counters": 
983 983   {
984 984   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
985 985   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
986 - "mileage": "", ~/~/ пробег, в метрах 
987 - "motohours": "" ~/~/ моточасы, в секундах
649 + "mileage": «», пробег
650 + "motohours": «» моточасы
988 988   }
989 989   "cmsv6Parameters": ~/~/ параметры CMSv6
990 990   {       
... ... @@ -1008,7 +1008,6 @@
1008 1008   "kind": "", ~/~/ Вид периодичности по времени
1009 1009   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1010 1010   } 
1011 -)))
1012 1012  
1013 1013  (% style="color:#000000" %)}
1014 1014  
... ... @@ -1062,18 +1062,13 @@
1062 1062  (% lang="en-US" style="text-align:left" %)
1063 1063  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1064 1064  
1065 -**валидация:**
1066 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1067 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1068 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1069 1069  
1070 -
1071 1071  (% class="box errormessage" %)
1072 1072  (((
1073 1073  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1074 1074  )))
1075 1075  
1076 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
733 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1077 1077  
1078 1078  (% style="color:#000000" %)Метод запроса: **DELETE**
1079 1079  
... ... @@ -1097,7 +1097,7 @@
1097 1097  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1098 1098  )))
1099 1099  
1100 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
757 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1101 1101  
1102 1102  (% style="color:#000000" %)Метод запроса: **GET**
1103 1103  
... ... @@ -1126,7 +1126,7 @@
1126 1126  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1127 1127  )))
1128 1128  
1129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
786 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
1130 1130  
1131 1131  (% style="color:#000000" %)Метод запроса: **GET**
1132 1132  

Меню

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