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,95 +1504,6 @@ 1504 1504 (% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 - 1508 -(% style="text-align:left" %) 1509 -(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1510 - 1511 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1512 - 1513 -(% class="box infomessage" %) 1514 -((( 1515 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1516 -))) 1517 - 1518 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1519 - 1520 -(% style="color:#000000" %)Метод запроса: **POST** 1521 - 1522 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1523 - 1524 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1525 - 1526 -(% style="text-align:left" %) 1527 -Тело запроса: 1528 - 1529 -(% style="text-align:left" %) 1530 -{ 1531 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1532 -} 1533 - 1534 -(% style="text-align:left" %) 1535 -Ответ: 1536 - 1537 -[ 1538 - { 1539 - "id": 0, ~/~/ Идентификатор объекта геозоны 1540 - "name": "string", ~/~/ Название объекта геозоны 1541 - "type": 0, ~/~/ Тип объекта геозоны 1542 - "fname": "string", ~/~/ Имя файла 1543 - "parentId": "string", ~/~/ Идентификатор клиента 1544 - "radius": 0, ~/~/ Радиус геообъекта 1545 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1546 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1547 - "description": "string", ~/~/ Описание 1548 - "area": 0, ~/~/ Площадь, м^^2^^ 1549 - "perimetr": 0, ~/~/ Периметр, м 1550 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 1551 - } 1552 -] 1553 - 1554 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Запрос пересечений по объектам**(%%) == 1555 - 1556 -(% class="box infomessage" %) 1557 -((( 1558 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1559 -))) 1560 - 1561 -(% style="color:#000000" %)Метод позволяет получить список геообъектов пересеченных выбранными объектами за выбранный период. 1562 - 1563 -(% style="color:#000000" %)Метод запроса: **POST** 1564 - 1565 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]] 1566 - 1567 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1568 - 1569 -(% style="text-align:left" %) 1570 -Тело запроса: 1571 - 1572 -{ 1573 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1574 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1575 - "ids": [ ], ~/~/ Массив id объектов 1576 - "byTime": 0, ~/~/ Настройки фильтрации по времени 1577 - "byDist": 0, ~/~/ 1578 - "filterByTime": 0, ~/~/ 1579 - "filterByHalfPerimeter": true ~/~/ 1580 -} 1581 - 1582 -Ответ: 1583 -[ 1584 - { 1585 - "geozoneId": 0, 1586 - "geozoneName": "string", 1587 - "startDate": "2023-08-02T06:13:18.554Z", 1588 - "endDate": "2023-08-02T06:13:18.554Z", 1589 - "duration": 0, 1590 - "vehicleId": 0, 1591 - "vehicleName": "string" 1592 - } 1593 -] 1594 - 1595 - 1596 1596 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1597 1597 1598 1598 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == ... ... @@ -1711,6 +1711,322 @@ 1711 1711 } 1712 1712 ] 1713 1713 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 + 1815 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1816 + 1817 +(% class="box infomessage" %) 1818 +((( 1819 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1820 +))) 1821 + 1822 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1823 + 1824 +(% style="color:#000000" %)Метод запроса: **POST** 1825 + 1826 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1827 + 1828 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1829 + 1830 +(% style="text-align:left" %) 1831 +Тело запроса: 1832 + 1833 +(% style="text-align:left" %) 1834 +{ 1835 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1836 +} 1837 + 1838 +(% style="text-align:left" %) 1839 +Ответ: 1840 + 1841 +[ 1842 + { 1843 + "id": 0, ~/~/ Идентификатор объекта геозоны 1844 + "name": "string", ~/~/ Название объекта геозоны 1845 + "type": 0, ~/~/ Тип объекта геозоны 1846 + "fname": "string", ~/~/ Имя файла 1847 + "parentId": "string", ~/~/ Идентификатор клиента 1848 + "radius": 0, ~/~/ Радиус геообъекта 1849 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 1850 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 1851 + "description": "string", ~/~/ Описание 1852 + "area": 0, ~/~/ Площадь, м^^2^^ 1853 + "perimetr": 0, ~/~/ Периметр, м 1854 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 1855 + } 1856 +] 1857 + 1858 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1859 + 1860 +(% class="box infomessage" %) 1861 +((( 1862 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1863 +))) 1864 + 1865 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1866 + 1867 +(% style="color:#000000" %)Метод запроса: **POST** 1868 + 1869 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1870 + 1871 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1872 + 1873 +(% style="text-align:left" %) 1874 +Тело запроса: 1875 + 1876 +{ 1877 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1878 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1879 + "ids": [ ], ~/~/ Массив id объектов 1880 + "byTime": 0, ~/~/ Объединение событий по времени 1881 + "byDist": 0, ~/~/ Объединение событий по расстоянию 1882 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1883 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1884 +} 1885 + 1886 +Ответ: 1887 +[ 1888 + { 1889 + "geozoneId": 0, ~/~/ ID геообъекта 1890 + "geozoneName": "string", ~/~/ Название геообъекта 1891 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1892 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1893 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1894 + "vehicleId": 0, ~/~/ ID объекта 1895 + "vehicleName": "string" ~/~/ Имя объекта 1896 + } 1897 +] 1898 + 1899 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 1900 + 1901 +(% class="box infomessage" %) 1902 +((( 1903 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 1904 +))) 1905 + 1906 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1907 + 1908 +(% style="color:#000000" %)Метод запроса: **POST** 1909 + 1910 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1911 + 1912 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1913 + 1914 +(% style="text-align:left" %) 1915 +Тело запроса: 1916 + 1917 +{ 1918 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 1919 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 1920 + "ids": [ ], ~/~/ Массив id геообъектов 1921 + "byTime": 0, ~/~/ Объединение событий по времени 1922 + "byDist": 0, ~/~/ Объединение событий по расстоянию 1923 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 1924 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1925 +} 1926 + 1927 +Ответ: 1928 + 1929 +[ 1930 + { 1931 + "geozoneId": 0, ~/~/ ID геообъекта 1932 + "geozoneName": "string", ~/~/ Название геообъекта 1933 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 1934 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 1935 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 1936 + "vehicleId": 0, ~/~/ ID объекта 1937 + "vehicleName": "string" ~/~/ Имя объекта 1938 + } 1939 +] 1940 + 1714 1714 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1715 1715 1716 1716 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==