Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1504,10 +1504,314 @@ 1504 1504 (% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1507 1507 1509 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1510 + 1511 +(% class="box infomessage" %) 1512 +((( 1513 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1514 +))) 1515 + 1516 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1517 + 1518 +(% style="color:#000000" %)Метод запроса: **GET** 1519 + 1520 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1521 + 1522 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1523 + 1524 +(% style="color:#000000" %)Ответ: 1525 + 1526 +(% style="color:#000000" %){ 1527 + 1528 + "id": "", ~/~/ ID типа датчика 1529 + "name": "", ~/~/ Название 1530 + "description": "", ~/~/ Описание 1531 + 1508 1508 (% style="text-align:left" %) 1509 -(% style="color:#000000 ; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**1533 +(% style="color:#000000" %)} 1510 1510 1535 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1536 + 1537 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1538 + 1539 +(% class="box infomessage" style="text-align: left;" %) 1540 +((( 1541 +**POST /api/v3/terminalMessages/count** 1542 +))) 1543 + 1544 +(% style="text-align: left;" %) 1545 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1546 + 1547 +(% style="text-align: left;" %) 1548 +Метод запроса **POST** 1549 + 1550 +(% style="text-align: left;" %) 1551 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1552 + 1553 +(% style="text-align: left;" %) 1554 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1555 + 1556 +(% style="text-align: left;" %) 1557 +{ 1558 + "vehicleIds": [ 1559 + id ~/~/ здесь передается список идентификаторов объектов 1560 + ], 1561 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1562 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1563 +} 1564 + 1565 +(% style="text-align: left;" %) 1566 +Ответ: 1567 + 1568 +(% style="text-align: left;" %) 1569 +[ 1570 + { 1571 + "vehicleId": 0, ~/~/ идентификатор объекта 1572 + "count": 0 ~/~/ количество сообщений за период 1573 + } 1574 +] 1575 + 1576 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 + 1578 +(% class="box infomessage" %) 1579 +((( 1580 +**POST /api/v3/terminalMessages** 1581 +))) 1582 + 1583 +Метод возвращает список сообщений терминала объекта за выбранный период. 1584 + 1585 +(% style="text-align: left;" %) 1586 +Метод запроса **POST** 1587 + 1588 +(% style="text-align: left;" %) 1589 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1590 + 1591 +(% style="text-align: left;" %) 1592 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1593 + 1594 +{ 1595 + "vehicleId": 0, ~/~/ id объекта 1596 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1597 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 +} 1599 + 1600 +Ответ: 1601 + 1602 +[ 1603 + { 1604 + "messages": [ 1605 + { 1606 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 + "speed": 0, ~/~/ Скорость, км/ч 1609 + "altitude": 0, ~/~/ Высота, м 1610 + "latitude": 0, ~/~/ Широта [-90°;90°] 1611 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 + "satellites": 0, ~/~/ Кол-во спутников 1613 + "voltage": 0, ~/~/ Напряжение 1614 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1615 + "additionalProp1": "string", 1616 + "additionalProp2": "string", 1617 + "additionalProp3": "string" 1618 + }, 1619 + "photoCount": 0 ~/~/ Кол-во фото 1620 + } 1621 + ] 1622 + } 1623 +] 1624 + 1625 +== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) == 1626 + 1627 +(% class="box infomessage" %) 1628 +((( 1629 +**POST /api/v3/vehicles/export/history** 1630 +))) 1631 + 1632 +Метод возвращает список сообщений терминала объекта за выбранный период. 1633 + 1634 +(% style="text-align: left;" %) 1635 +Метод запроса **POST** 1636 + 1637 +(% style="text-align: left;" %) 1638 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1639 + 1640 +(% style="text-align: left;" %) 1641 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1642 + 1643 +{ 1644 + "vehicleId": 0, ~/~/ ID объекта 1645 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1646 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1647 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1648 +} 1649 + 1650 +Ответ: 1651 + 1652 +Получаете файл. Сообщение: Code 200/Success 1653 + 1654 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1655 + 1656 +(% class="box infomessage" %) 1657 +((( 1658 +**GET /api/v3/vehicles/export/history/status** 1659 +))) 1660 + 1661 +Метод возвращает список сообщений терминала объекта за выбранный период. 1662 + 1663 +(% style="text-align: left;" %) 1664 +Метод запроса **GET** 1665 + 1666 +(% style="text-align: left;" %) 1667 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1668 + 1669 +(% style="text-align: left;" %) 1670 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1671 + 1672 +Ответ: 1673 + 1674 +{ 1675 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1676 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1677 + "message": "string" ~/~/ текст описывающий статус. 1678 +} 1679 + 1680 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1681 + 1682 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1683 + 1684 +(% class="box infomessage" %) 1685 +((( 1686 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1687 +))) 1688 + 1689 +(% style="color:#000000" %)Метод запроса: **POST** 1690 + 1691 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1692 + 1693 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1694 + 1695 +(% style="text-align:left" %) 1696 +Тело запроса: 1697 + 1698 +{ 1699 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1700 + "vehicleIds": [0], ~/~/ Список ID объектов 1701 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1702 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1703 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1704 +} 1705 + 1706 +Ответ: 1707 + 1708 +[ 1709 + { 1710 + "vehicleId": 0, ~/~/ ID объекта 1711 + "name": "string", ~/~/ Имя ТС 1712 + "periods": [ ~/~/ Периоды 1713 + { 1714 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1715 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1716 + "mileageBegin": 0, ~/~/ Пробег на начало периода 1717 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 1718 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1719 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 1720 + } 1721 + ] 1722 + } 1723 +] 1724 + 1725 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1726 + 1727 +(% class="box infomessage" %) 1728 +((( 1729 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1730 +))) 1731 + 1732 +(% style="color:#000000" %)Метод запроса: **POST** 1733 + 1734 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1735 + 1736 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1737 + 1738 +(% style="text-align:left" %) 1739 +Тело запроса: 1740 + 1741 +{ 1742 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1743 + "vehicleIds": [0], ~/~/ Список ID объектов 1744 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1745 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1746 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1747 +} 1748 + 1749 +Ответ: 1750 + 1751 +[ 1752 + { 1753 + "vehicleId": 0, ~/~/ ID объекта 1754 + "name": "string", ~/~/ Имя ТС 1755 + "periods": [ ~/~/ Периоды 1756 + { 1757 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1758 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1759 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 1760 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1761 + "fuelConsumption": 0, ~/~/ Расход топлива 1762 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 1763 + } 1764 + ] 1765 + } 1766 +] 1767 + 1768 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1769 + 1770 +(% class="box infomessage" %) 1771 +((( 1772 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 1773 +))) 1774 + 1775 +(% style="color:#000000" %)Метод запроса: **POST** 1776 + 1777 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 1778 + 1779 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1780 + 1781 +(% style="text-align:left" %) 1782 +Тело запроса: 1783 + 1784 +{ 1785 + "vehicleIds": [0], ~/~/ Список ID объектов 1786 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 1787 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 1788 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1789 +} 1790 + 1791 +Ответ: 1792 + 1793 +[ 1794 + { 1795 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 1796 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 1797 + "vehicleId": 0, ~/~/ ID объекта 1798 + "name": "string", ~/~/ Имя объекта 1799 + "model": "string", ~/~/ Модель объекта 1800 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 1801 + { 1802 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 1803 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 1804 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 1805 + "valueFuel": 0, ~/~/ Количество 1806 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 1807 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 1808 + } 1809 + ] 1810 + } 1811 +] 1812 + 1813 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1814 + 1511 1511 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1512 1512 1513 1513 (% class="box infomessage" %) ... ... @@ -1519,7 +1519,7 @@ 1519 1519 1520 1520 (% style="color:#000000" %)Метод запроса: **POST** 1521 1521 1522 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find1826 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1523 1523 1524 1524 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1525 1525 ... ... @@ -1634,124 +1634,6 @@ 1634 1634 } 1635 1635 ] 1636 1636 1637 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1638 - 1639 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1640 - 1641 -(% class="box infomessage" %) 1642 -((( 1643 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1644 -))) 1645 - 1646 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1647 - 1648 -(% style="color:#000000" %)Метод запроса: **GET** 1649 - 1650 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1651 - 1652 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1653 - 1654 -(% style="color:#000000" %)Ответ: 1655 - 1656 -(% style="color:#000000" %){ 1657 - 1658 - "id": "", ~/~/ ID типа датчика 1659 - "name": "", ~/~/ Название 1660 - "description": "", ~/~/ Описание 1661 - 1662 -(% style="text-align:left" %) 1663 -(% style="color:#000000" %)} 1664 - 1665 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 1666 - 1667 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1668 - 1669 -(% class="box infomessage" style="text-align: left;" %) 1670 -((( 1671 -**POST /api/v3/terminalMessages/count** 1672 -))) 1673 - 1674 -(% style="text-align: left;" %) 1675 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1676 - 1677 -(% style="text-align: left;" %) 1678 -Метод запроса **POST** 1679 - 1680 -(% style="text-align: left;" %) 1681 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1682 - 1683 -(% style="text-align: left;" %) 1684 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1685 - 1686 -(% style="text-align: left;" %) 1687 -{ 1688 - "vehicleIds": [ 1689 - id ~/~/ здесь передается список идентификаторов объектов 1690 - ], 1691 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1692 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1693 -} 1694 - 1695 -(% style="text-align: left;" %) 1696 -Ответ: 1697 - 1698 -(% style="text-align: left;" %) 1699 -[ 1700 - { 1701 - "vehicleId": 0, ~/~/ идентификатор объекта 1702 - "count": 0 ~/~/ количество сообщений за период 1703 - } 1704 -] 1705 - 1706 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1707 - 1708 -(% class="box infomessage" %) 1709 -((( 1710 -**POST /api/v3/terminalMessages** 1711 -))) 1712 - 1713 -Метод возвращает список сообщений терминала объекта за выбранный период. 1714 - 1715 -(% style="text-align: left;" %) 1716 -Метод запроса **POST** 1717 - 1718 -(% style="text-align: left;" %) 1719 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1720 - 1721 -(% style="text-align: left;" %) 1722 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1723 - 1724 -{ 1725 - "vehicleId": 0, ~/~/ id объекта 1726 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1727 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1728 -} 1729 - 1730 -Ответ: 1731 - 1732 -[ 1733 - { 1734 - "messages": [ 1735 - { 1736 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1737 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1738 - "speed": 0, ~/~/ Скорость, км/ч 1739 - "altitude": 0, ~/~/ Высота, м 1740 - "latitude": 0, ~/~/ Широта [-90°;90°] 1741 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1742 - "satellites": 0, ~/~/ Кол-во спутников 1743 - "voltage": 0, ~/~/ Напряжение 1744 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1745 - "additionalProp1": "string", 1746 - "additionalProp2": "string", 1747 - "additionalProp3": "string" 1748 - }, 1749 - "photoCount": 0 ~/~/ Кол-во фото 1750 - } 1751 - ] 1752 - } 1753 -] 1754 - 1755 1755 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1756 1756 1757 1757 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==