Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 25.6 >
edited by Артем Шемяков
on 2022/09/05 11:13
To version < 46.1 >
edited by Илья Крайнов
on 2022/11/21 10:27
>
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
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -20,20 +20,27 @@
20 20  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 - (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 28  (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)Метод запроса: **GET**
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% lang="en-US" %)
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
43 +
37 37  (% style="color:#000000" %)**Ответ:**
38 38  
39 39  (% lang="en-US" %)
... ... @@ -40,8 +40,8 @@
40 40  (% style="color:#000000" %){
41 41  
42 42  (% lang="en-US" %)
43 -(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 - "User": "" , ~/~/ имя пользователя
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 46  (% lang="en-US" %)
47 47  }
... ... @@ -100,7 +100,7 @@
100 100   "name": "", ~/~/ наименование клиента
101 101   "fullName": "", ~/~/ полное наименование клиента
102 102   "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
103 - "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформление, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
104 104  }
105 105  
106 106  
... ... @@ -130,9 +130,9 @@
130 130   "position": "", ~/~/ должность
131 131   "phone": "", ~/~/ телефон
132 132   "organization": "", ~/~/ организация
133 - "login": "", ~/~/ логин
134 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
135 - "email": "", ~/~/ email
140 + "login": "", ~/~/ логин (обязателен)
141 + "password": "", ~/~/ пароль (обязателен)
142 + "email": "", ~/~/ email (обязателен)
136 136   "description": "", ~/~/ описание
137 137   "isEnabled": "", ~/~/ признак включения
138 138   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -141,7 +141,7 @@
141 141   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
142 142   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
143 143   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
144 - "groups": "" , ~/~/ группы пользователя, названия групп
151 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
145 145  }
146 146  
147 147  (% style="text-align:left" %)
... ... @@ -167,7 +167,7 @@
167 167   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
168 168   "kind": "" , ~/~/ тип аутентификации
169 169   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
170 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
177 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
171 171  
172 172  (% style="text-align:left" %)
173 173  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -220,6 +220,184 @@
220 220  (% style="color:#000000" %)}
221 221  
222 222  
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" %)В заголовках запроса: X-Auth: Токен авторизации
242 +
243 +(% style="color:#000000" %)Ответ:
244 +
245 +(((
246 +(((
247 +{
248 +)))
249 +)))
250 +
251 +(((
252 +(((
253 + "id": "", ~/~/ GUID пользователя
254 +)))
255 +)))
256 +
257 +(((
258 +(((
259 + "lastName": "", ~/~/ Фамилия
260 +)))
261 +)))
262 +
263 +(((
264 +(((
265 + "firstName": "", ~/~/ Имя
266 +)))
267 +)))
268 +
269 +(((
270 +(((
271 + "position": "", ~/~/ Должность
272 +)))
273 +)))
274 +
275 +(((
276 +(((
277 + "phone": "", ~/~/ Номер телефона
278 +)))
279 +)))
280 +
281 +(((
282 +(((
283 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 +)))
285 +)))
286 +
287 +(((
288 +(((
289 + "parentName": "", Наименование клиента, которому принадлежит пользователь
290 +)))
291 +)))
292 +
293 +(((
294 +(((
295 + "organization": "", ~/~/ Организация
296 +)))
297 +)))
298 +
299 +(((
300 +(((
301 + "login": "", ~/~/ Логин пользователя
302 +)))
303 +)))
304 +
305 +(((
306 +(((
307 + "email": "", ~/~/ Адрес электронной почты
308 +)))
309 +)))
310 +
311 +(((
312 +(((
313 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 +)))
315 +)))
316 +
317 +(((
318 +(((
319 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 +)))
321 +)))
322 +
323 +(((
324 +(((
325 + "description": "", ~/~/ Описание
326 +)))
327 +)))
328 +
329 +(((
330 +(((
331 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 +)))
333 +)))
334 +
335 +(((
336 +(((
337 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 +)))
339 +)))
340 +
341 +(((
342 +(((
343 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 +)))
345 +)))
346 +
347 +(((
348 +(((
349 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 +)))
351 +)))
352 +
353 +(((
354 +(((
355 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 +)))
357 +)))
358 +
359 +(((
360 +(((
361 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 +)))
363 +)))
364 +
365 +(((
366 +(((
367 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 +)))
369 +)))
370 +
371 +(((
372 +(((
373 + "groups": [], ~/~/ Список ролей пользователя
374 +)))
375 +)))
376 +
377 +(((
378 +(((
379 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 +)))
381 +)))
382 +
383 +(((
384 +(((
385 + "authDevices": [ ], ~/~/ Список авторизованных устройств
386 +)))
387 +)))
388 +
389 +(((
390 +(((
391 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 +)))
393 +)))
394 +
395 +(((
396 +(((
397 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 +)))
399 +)))
400 +
401 +(((
402 +(((
403 +}
404 +)))
405 +)))
406 +
407 +
223 223  (% class="box warningmessage" %)
224 224  (((
225 225  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -233,6 +233,8 @@
233 233  
234 234  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
235 235  
421 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
422 +
236 236  (% lang="en-US" style="text-align:left" %)
237 237  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
238 238  
... ... @@ -246,10 +246,10 @@
246 246   "position": "" , ~/~/ должность
247 247   "phone": "" , ~/~/ телефон
248 248   "organization": "" , ~/~/ организация
249 - "login": "" , ~/~/ логин
250 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
251 - "email": "" , ~/~/ email
252 - "description": "" , ~/~/ описание
436 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
253 253   "isEnabled": "" , ~/~/ признак включения
254 254   "parentId": "" , ~/~/ Guid родительского агента
255 255   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -296,7 +296,7 @@
296 296  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
297 297  )))
298 298  
299 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
486 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
300 300  
301 301  (% style="color:#000000" %)Метод запроса: **PUT**
302 302  
... ... @@ -320,6 +320,63 @@
320 320  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
321 321  
322 322  
510 +(% class="box warningmessage" %)
511 +(((
512 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
513 +)))
514 +
515 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
516 +
517 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
518 +
519 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
520 +
521 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
522 +
523 + [ 
524 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
525 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
526 + ]
527 +
528 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
529 +
530 +
531 +(% class="box warningmessage" %)
532 +(((
533 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
534 +)))
535 +
536 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
537 +
538 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539 +
540 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
541 +
542 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543 +
544 + [ 
545 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 + ]
548 +
549 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
550 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
551 +
552 +(((
553 +В теле ответа:
554 +{
555 + "errorMessages": [
556 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
557 + ],
558 + "users": [
559 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 + ]
561 +}
562 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
563 +"users" - массив id пользователей, которых не удалось включить или отключить.
564 +
565 +)))
566 +
323 323  (% class="box errormessage" %)
324 324  (((
325 325  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -367,22 +367,149 @@
367 367  
368 368  (% style="color:#000000" %)Ответ:
369 369  
370 -(% style="color:#000000" %){
614 +(((
615 +{
616 +)))
371 371  
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": "" , ~/~/ статус объекта
618 +(((
619 + "vehicleId": "", ~/~/ ID объекта
620 +)))
384 384  
622 +(((
623 + "name": "", ~/~/ Имя объекта
624 +)))
625 +
626 +(((
627 + "imei": "", ~/~/ IMEI объекта
628 +)))
629 +
630 +(((
631 + "deviceTypeId": , ~/~/ ID типа устройства
632 +)))
633 +
634 +(((
635 + "deviceTypeName": "", ~/~/ Название типа устройства
636 +)))
637 +
638 +(((
639 + "sim1": "", ~/~/ Номер SIM1
640 +)))
641 +
642 +(((
643 + "parentId": "", Номер SIM2
644 +)))
645 +
646 +(((
647 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 +)))
649 +
650 +(((
651 + "modelId": "", ID модели объекта
652 +)))
653 +
654 +(((
655 + "modelName": "", Имя модели объекта
656 +)))
657 +
658 +(((
659 + "createdAt": "", Дата создания объекта
660 +)))
661 +
662 +(((
663 + "mileageCalcMethod": "", Выбранный метод расчета пробега
664 +)))
665 +
666 +(((
667 + "counters": { ~/~/ Нормы
668 +)))
669 +
670 +(((
671 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 +)))
673 +
674 +(((
675 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 +)))
677 +
678 +(((
679 + "mileage": "", ~/~/ Пробег по нормам в метрах
680 +)))
681 +
682 +(((
683 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 +)))
685 +
686 +(((
687 + },
688 +)))
689 +
690 +(((
691 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 +)))
693 +
694 +(((
695 + {
696 +)))
697 +
698 +(((
699 + "id": "", ~/~/ ID  задания
700 +)))
701 +
702 +(((
703 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 +)))
705 +
706 +(((
707 + "name": "", ~/~/ Наименование задания
708 +)))
709 +
710 +(((
711 + "description": "", ~/~/ Описание задания
712 +)))
713 +
714 +(((
715 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 +)))
717 +
718 +(((
719 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 +)))
721 +
722 +(((
723 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 +)))
725 +
726 +(((
727 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 +)))
729 +
730 +(((
731 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 +)))
733 +
734 +(((
735 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 +)))
737 +
738 +(((
739 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 +)))
741 +
742 +(((
743 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 +)))
745 +
746 +(((
747 + }
748 +)))
749 +
750 +(((
751 + ]
752 +)))
753 +
754 +(((
385 385  }
756 +)))
386 386  
387 387  (% style="text-align:left" %)
388 388  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -418,12 +418,22 @@
418 418   "sim2": "" , ~/~/ Номер SIM2
419 419   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
420 420   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
421 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
422 - "counters": {
423 - "mileage": "" , ~/~/ пробег
424 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
425 - "motohours": "" , ~/~/ моточасы
426 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
792 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
793 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
794 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
795 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
796 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
797 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
798 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
799 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
800 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
801 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
802 + "counters": ~/~/ счетчики
803 + {
804 + "mileage": "" , ~/~/ пробег
805 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
806 + "motohours": "" , ~/~/ моточасы
807 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
427 427   },
428 428   "cmsv6Parameters": { ~/~/ параметры CMSv6
429 429   "enabled": true, ~/~/ флаг включения
... ... @@ -494,7 +494,12 @@
494 494  (% style="text-align:left" %)
495 495  (% style="color:#000000" %)}
496 496  
878 +**Валидация:**
879 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
880 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
881 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
497 497  
883 +
498 498  (% class="box successmessage" %)
499 499  (((
500 500  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
... ... @@ -528,17 +528,19 @@
528 528  
529 529  (% style="color:#000000" %)Параметры в теле запроса (JSON):
530 530  
531 -(% class="western" style="color:#000000" %)##{##
532 532  
533 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
534 - "name": null, ~/~/ Имя ТС (string, опционально) 
535 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
536 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
537 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
538 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
539 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
540 -(% style="color:#000000" %)}
918 +{
919 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
920 + "name": null, ~/~/ Имя ТС (string, опционально)
921 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
922 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
923 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
924 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
925 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
926 + "customFields": null ~/~/ значение любого из произвольных полей ТС
927 +}
541 541  
929 +
542 542  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
543 543  
544 544  (% style="color:#000000" %)Ответ:
... ... @@ -629,6 +629,7 @@
629 629  
630 630  (% style="color:#000000" %){    
631 631  
1020 +(((
632 632  (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
633 633   "parentId": "", ~/~/ ID клиента
634 634   "name": "", ~/~/ имя ТС
... ... @@ -637,15 +637,25 @@
637 637   "modelId": "", ~/~/ , ID модели    
638 638   "unitId": "", ~/~/ подразделения
639 639   "sim1": "", ~/~/ SIM 1
640 - "sim2": "", ~/~/ SIM2
641 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
642 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
643 - "counters": 
1029 + "sim2": "", ~/~/ SIM2     (%%)
1030 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1031 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1032 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1033 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1034 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1035 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1036 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1037 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1038 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1039 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1040 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1042 +(% style="color:#000000" %) "counters": 
644 644   {
645 645   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
646 646   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
647 - "mileage": «», пробег
648 - "motohours": «» моточасы
1046 + "mileage": "", ~/~/ пробег, в метрах 
1047 + "motohours": "" ~/~/ моточасы, в секундах
649 649   }
650 650   "cmsv6Parameters": ~/~/ параметры CMSv6
651 651   {       
... ... @@ -669,6 +669,7 @@
669 669   "kind": "", ~/~/ Вид периодичности по времени
670 670   "maxQuantity": "", ~/~/ Сколько раз выполнить задание
671 671   } 
1071 +)))
672 672  
673 673  (% style="color:#000000" %)}
674 674  
... ... @@ -722,7 +722,12 @@
722 722  (% lang="en-US" style="text-align:left" %)
723 723  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
724 724  
1125 +**валидация:**
1126 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1127 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1128 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
725 725  
1130 +
726 726  (% class="box errormessage" %)
727 727  (((
728 728  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

Меню

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