Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
<
>
edited by Андрей Калиновский
on 2024/07/19 15:59
on 2024/07/19 15:59
edited by Андрей Калиновский
on 2024/07/25 10:10
on 2024/07/25 10:10
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -44,12 +44,8 @@ 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - 48 -(% lang="en-US" %) 49 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 50 - "User": "testuser" , ~/~/ имя пользователя 51 - 52 -(% lang="en-US" %) 47 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 + "User": "testuser" , ~/~/ имя пользователя(%%) 53 53 } 54 54 55 55 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. ... ... @@ -229,7 +229,6 @@ 229 229 "bankKS": "string" ~/~/ корр. счёт 230 230 } 231 231 232 - 233 233 Ответ: 234 234 235 235 { ... ... @@ -423,7 +423,6 @@ 423 423 ], 424 424 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 425 425 } 426 - 427 427 { 428 428 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 429 429 "lastName": "string", ... ... @@ -437,12 +437,8 @@ 437 437 438 438 (% style="text-align:left" %) 439 439 (% style="color:#000000; font-weight:normal" %)Ответ: 440 - 441 -(% style="text-align:left" %) 442 -(% style="color:#000000; font-weight:normal" %){ 443 - 444 -(% style="text-align:left" %) 445 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 434 +{ 435 + "id": "" , ~/~/ ID пользователя 446 446 "lastName": "" , ~/~/ Фамилия , 447 447 "firstName": "" , ~/~/ Имя 448 448 "position": "" , ~/~/ Должность ... ... @@ -459,11 +459,9 @@ 459 459 "kind": "" , ~/~/ тип аутентификации 460 460 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 461 461 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 +} 462 462 463 -(% style="text-align:left" %) 464 -(% style="color:#000000; font-weight:normal" %)} 465 465 466 - 467 467 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 468 468 469 469 (% class="box infomessage" %) ... ... @@ -483,19 +483,16 @@ 483 483 484 484 (% style="color:#000000" %)Параметры в теле запроса (JSON): 485 485 486 -(% style="color:#000000" %){ 487 - 474 +(% style="color:#000000" %){(%%) 488 488 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 489 489 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 490 490 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 491 491 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 492 - 493 493 (% style="color:#000000" %)} 494 494 495 495 (% style="color:#000000" %)Ответ: 496 496 497 497 (% style="color:#000000" %){ (%%) 498 - 499 499 "id": "" , ~/~/ идентификатор пользователя 500 500 "lastName": "" , ~/~/ фамилия 501 501 "firstName": "" , ~/~/ имя ... ... @@ -509,7 +509,6 @@ 509 509 "sessionDuration":"", ~/~/ длительность сессии в минутах 510 510 "status": "1", ~/~/ статус пользователя 511 511 "lastLogged": "", ~/~/ дата/время последней авторизации 512 - 513 513 (% style="color:#000000" %)} 514 514 515 515 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -583,10 +583,8 @@ 583 583 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 584 584 585 585 (% lang="en-US" style="text-align:left" %) 586 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 - 588 -(% lang="en-US" style="text-align:left" %) 589 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 570 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 + "id": "" , ~/~/ ID пользователя 590 590 "lastName": "" , ~/~/ фамилия 591 591 "firstName": "" , ~/~/ имя 592 592 "position": "" , ~/~/ должность ... ... @@ -608,9 +608,7 @@ 608 608 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 609 609 }, 610 610 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 611 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 612 - 613 -(% lang="en-US" style="text-align:left" %) 593 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 614 614 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 615 615 616 616 (% lang="en-US" style="text-align:left" %) ... ... @@ -617,10 +617,8 @@ 617 617 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 618 618 619 619 (% lang="en-US" style="text-align:left" %) 620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 621 - 622 -(% lang="en-US" style="text-align:left" %) 623 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 600 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 + "id": "" , ~/~/ идентификатор пользователя 624 624 "lastName": "" , ~/~/ фамилия 625 625 "firstName": "" , ~/~/ имя 626 626 "position": "" , ~/~/ должность ... ... @@ -641,10 +641,8 @@ 641 641 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 642 642 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 643 643 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 +} 644 644 645 -(% lang="en-US" style="text-align:left" %) 646 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 647 - 648 648 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 649 649 650 650 (% class="box warningmessage" %) ... ... @@ -664,12 +664,10 @@ 664 664 665 665 (% style="color:#000000" %)Параметры в теле запроса (JSON): 666 666 667 -(% style="color:#000000" %){ 668 - 643 +(% style="color:#000000" %){(%%) 669 669 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 670 670 "description": "" , ~/~/ описание 671 671 "data": "" , ~/~/ данные, связанные со сменой статуса 672 - 673 673 (% style="color:#000000" %)} 674 674 675 675 (% style="text-align:left" %) ... ... @@ -691,7 +691,7 @@ 691 691 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 692 692 693 693 [ 694 - 668 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 695 695 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 696 696 ] 697 697 ... ... @@ -1033,19 +1033,15 @@ 1033 1033 "deviceTypeName": "", ~/~/ Название типа устройства 1034 1034 "sim1": "", ~/~/ Номер SIM1 1035 1035 "sim2": "", ~/~/ Номер SIM2 1036 - 1037 1037 "parentId": "", ~/~/ ID клиента-родителя 1038 1038 "parentName": "", ~/~/ Наименование клиента-родителя 1039 1039 "modelId": "", ~/~/ ID модели объекта 1040 1040 "modelName": "", ~/~/ Имя модели объекта 1041 - 1042 1042 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1043 1043 "unitName": "string", ~/~/ Наименование подразделения 1044 1044 "status": 0, ~/~/ Статус объекта 1045 - 1046 1046 "createdAt": "", ~/~/ Дата создания объекта 1047 1047 }, 1048 - 1049 1049 "customFields": [ ~/~/ Произвольные поля 1050 1050 { 1051 1051 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1068,8 +1068,7 @@ 1068 1068 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1069 1069 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1070 1070 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1071 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1072 - 1041 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1073 1073 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1074 1074 "mileageCoeff": 0, ~/~/ коэффициент пробега 1075 1075 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1099,7 +1099,6 @@ 1099 1099 "retries": 0 ~/~/ Количество попыток 1100 1100 } 1101 1101 ], 1102 - 1103 1103 "sensors": [ ~/~/ Датчики 1104 1104 { 1105 1105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1161,7 +1161,6 @@ 1161 1161 "isDefault": true ~/~/ По умолчанию 1162 1162 } 1163 1163 ], 1164 - 1165 1165 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1166 1166 { 1167 1167 "id": "", ~/~/ ID задания ... ... @@ -1178,8 +1178,7 @@ 1178 1178 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1179 1179 } 1180 1180 ], 1181 - 1182 - "statusHistory": [ ~/~/ История статусов 1148 +"statusHistory": [ ~/~/ История статусов 1183 1183 { 1184 1184 "status": 0, 1185 1185 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1187,7 +1187,6 @@ 1187 1187 "additionalInfo": "string" 1188 1188 } 1189 1189 ] 1190 - 1191 1191 } 1192 1192 ))) 1193 1193 ... ... @@ -1245,8 +1245,6 @@ 1245 1245 "status": "" ~/~/ Статус отправки 1246 1246 } 1247 1247 ] 1248 - 1249 - 1250 1250 ))) 1251 1251 1252 1252 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == ... ... @@ -1266,8 +1266,7 @@ 1266 1266 1267 1267 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1268 1268 1269 -(% style="color:#000000" %){ 1270 - 1232 +(% style="color:#000000" %){(%%) 1271 1271 "parentId": "" , ~/~/ ID клиента 1272 1272 "name": "" , ~/~/ имя ТС 1273 1273 "imei": "" , ~/~/ IMEI ... ... @@ -1288,7 +1288,6 @@ 1288 1288 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1289 1289 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1290 1290 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1291 - 1292 1292 "mileageCalcMethod": 0, 1293 1293 "mileageCoeff": 0, 1294 1294 "locationByCellId": true, ... ... @@ -1321,7 +1321,6 @@ 1321 1321 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1322 1322 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1323 1323 } 1324 - 1325 1325 "drivers": [ ~/~/ Водители 1326 1326 { 1327 1327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1336,8 +1336,7 @@ 1336 1336 "retries": 0 1337 1337 } 1338 1338 ], 1339 - 1340 - "sensors": [ ~/~/ Датчики 1299 +"sensors": [ ~/~/ Датчики 1341 1341 { 1342 1342 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1343 1343 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1375,29 +1375,17 @@ 1375 1375 "additionalProp2": "string", 1376 1376 "additionalProp3": "string" 1377 1377 }, 1378 - 1379 1379 ~/~/ Характерные для произвольного: 1380 - 1381 1381 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1382 - 1383 1383 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1384 - 1385 1385 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1386 - 1387 1387 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1388 - 1389 1389 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1390 - 1391 1391 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1392 - 1393 1393 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1394 - 1395 1395 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1396 - 1397 1397 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1398 - 1399 1399 ~/~/ "ValueOn": "Вкл.", 1400 - 1401 1401 ~/~/ "ValueOff": "Выкл." 1402 1402 "summaryMaxValue": 0 ~/~/ Макс. значение 1403 1403 } ... ... @@ -1416,8 +1416,7 @@ 1416 1416 1417 1417 (% style="color:#000000" %)Ответ: 1418 1418 1419 -(% style="color:#000000" %){ 1420 - 1366 +(% style="color:#000000" %){(%%) 1421 1421 "vehicleId": "", ~/~/ID ТС 1422 1422 "parentId": "", ~/~/Guid владельца ТС 1423 1423 "name": "", ~/~/Имя объекта ... ... @@ -1455,8 +1455,6 @@ 1455 1455 "kind": "", ~/~/ Вид периодичности по времени 1456 1456 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1457 1457 } 1458 - 1459 -(% style="text-align:left" %) 1460 1460 (% style="color:#000000" %)} 1461 1461 1462 1462 **Валидация:** ... ... @@ -1515,8 +1515,7 @@ 1515 1515 (% style="color:#000000" %)Ответ: 1516 1516 1517 1517 (% style="color:#000000" %){ 1518 - 1519 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1462 + "vehicleId": "" ~/~/ идентификатор объекта 1520 1520 "name": "" ~/~/ наименование объекта 1521 1521 "imei": "" ~/~/ IMEI объекта 1522 1522 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1575,13 +1575,11 @@ 1575 1575 "data": "", ~/~/ Данные 1576 1576 "overwrite": false, ~/~/ Флаг перезаписи 1577 1577 "stage": "", ~/~/ Состояние, может быть null 1578 - 1579 1579 (% style="color:#000000" %)} 1580 1580 1581 1581 (% style="color:#000000" %)Ответ: 1582 1582 1583 -(% style="color:#000000" %){ 1584 - 1525 +(% style="color:#000000" %){(%%) 1585 1585 "status": "", ~/~/ значение статуса 1586 1586 "date": "", ~/~/ Дата смены статуса 1587 1587 "description": "", ~/~/ Описание ... ... @@ -1588,12 +1588,9 @@ 1588 1588 "data": "", ~/~/ Данные 1589 1589 "overwrite": false, ~/~/ Флаг перезаписи 1590 1590 "stage": "", ~/~/ Состояние 1591 - 1592 -(% style="text-align:left" %) 1593 1593 (% style="color:#000000" %) } 1594 1594 1595 -(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %) 1596 -**Отправить команду на терминал** 1534 +== **Отправить команду на терминал** == 1597 1597 1598 1598 (% class="box successmessage" %) 1599 1599 ((( ... ... @@ -1697,8 +1697,7 @@ 1697 1697 "retries": 0 1698 1698 } 1699 1699 ], 1700 - 1701 - "sensors": [ ~/~/ Датчики 1638 +"sensors": [ ~/~/ Датчики 1702 1702 { 1703 1703 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1704 1704 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1736,29 +1736,17 @@ 1736 1736 "additionalProp2": "string", 1737 1737 "additionalProp3": "string" 1738 1738 }, 1739 - 1740 1740 ~/~/ Характерные для произвольного: 1741 - 1742 1742 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1743 - 1744 1744 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1745 - 1746 1746 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1747 - 1748 1748 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1749 - 1750 1750 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1751 - 1752 1752 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1753 - 1754 1754 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1755 - 1756 1756 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1757 - 1758 1758 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1759 - 1760 1760 ~/~/ "ValueOn": "Вкл.", 1761 - 1762 1762 ~/~/ "ValueOff": "Выкл." 1763 1763 "summaryMaxValue": 0 ~/~/ Макс. значение 1764 1764 } ... ... @@ -1778,9 +1778,7 @@ 1778 1778 (% style="color:#000000" %)Ответ: 1779 1779 1780 1780 (% lang="en-US" style="text-align:left" %) 1781 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1782 - 1783 -(% lang="en-US" style="text-align:left" %) 1706 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1784 1784 "vehicleId": "", ~/~/ ID ТС 1785 1785 "parentId": "", ~/~/ ID клиента 1786 1786 "name": "", ~/~/ имя ТС ... ... @@ -1821,8 +1821,6 @@ 1821 1821 "kind": "", ~/~/ Вид периодичности по времени 1822 1822 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1823 1823 } 1824 - 1825 -(% lang="en-US" style="text-align:left" %) 1826 1826 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1827 1827 1828 1828 **Валидация:** ... ... @@ -1869,12 +1869,9 @@ 1869 1869 1870 1870 (% style="color:#000000" %)Ответ: 1871 1871 1872 -(% style="color:#000000" %){ 1873 - 1793 +(% style="color:#000000" %){(%%) 1874 1874 "deviceTypeId" : "", ~/~/ ID типа устройства 1875 1875 "deviceTypeName" : "" ~/~/ Название типа устройства 1876 - 1877 -(% style="text-align:left" %) 1878 1878 (% style="color:#000000" %)} 1879 1879 1880 1880 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -2288,7 +2288,6 @@ 2288 2288 } 2289 2289 2290 2290 2291 - 2292 2292 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2293 2293 2294 2294 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -4274,7 +4274,7 @@ 4274 4274 "parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4275 4275 } 4276 4276 4277 -Ответ 4194 +Ответ: 4278 4278 4279 4279 [ 4280 4280 { ... ... @@ -4290,7 +4290,7 @@ 4290 4290 ] 4291 4291 4292 4292 4293 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =4210 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4294 4294 4295 4295 == **API для отчета по выгрузке комбайнов** == 4296 4296