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
-
... ... @@ -682,225 +682,6 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 - 687 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 688 - 689 -(% class="box infomessage" %) 690 -((( 691 -(% lang="en-US" %)**GET /api/v3/models/{Id}** 692 -))) 693 - 694 -Метод возвращает полную информацию о модели объекта. 695 - 696 -(% style="color:#000000" %)Метод запроса: **GET** 697 - 698 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 699 - 700 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 701 - 702 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 703 - 704 -(% style="color:#000000" %)Ответ: 705 - 706 -(% style="color:#000000" %){ 707 - "parentName": "string", 708 - "name": "string", 709 - "picture": "string", 710 - "minspeed": 0, 711 - "maxspeed": 0, 712 - "width": 0, 713 - "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 - "hoppercapacity": 0, 716 - "hopperdischargespeed": 0, 717 - "modelType": 0, 718 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 719 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 720 - "deleted": true 721 -} 722 - 723 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 724 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 725 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 726 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 727 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 728 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 734 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 737 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 738 - 739 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 740 - 741 -(% class="box successmessage" %) 742 -((( 743 -(% lang="en-US" %)**POST /api/v3/models/find** 744 -))) 745 - 746 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 747 - 748 -(% style="color:#000000" %)Метод запроса: **POST** 749 - 750 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 751 - 752 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 - 754 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 755 - 756 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 757 -} 758 - 759 -(% style="color:#000000" %)Ответ: 760 - 761 -(% style="color:#000000" %)[ 762 - { 763 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 764 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 765 - "parentName": "string", 766 - "name": "string", 767 - "modelType": 0 768 - } 769 -] 770 - 771 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 772 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 773 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 774 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 775 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 776 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 777 - 778 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 779 - 780 -(% class="box successmessage" %) 781 -((( 782 -(% lang="en-US" %)**POST /api/v3/models** 783 -))) 784 - 785 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 786 - 787 -(% style="color:#000000" %)Метод запроса: **POST** 788 - 789 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 790 - 791 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 792 - 793 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 794 - 795 -{ 796 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 797 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 798 - "deleted": true, 799 - "extId": "string", 800 - "name": "string", 801 - "picture": "string", 802 - "minspeed": 0, 803 - "maxspeed": 0, 804 - "width": 0, 805 - "imbeddedtrailer": true, 806 - "fueloutlay": 0, 807 - "hoppercapacity": 0, 808 - "hopperdischargespeed": 0, 809 - "modelType": 0 810 -} 811 - 812 -Ответ: 813 - 814 -{ 815 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 816 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 817 - "deleted": true, 818 - "extId": "string", 819 - "name": "string", 820 - "picture": "string", 821 - "minspeed": 0, 822 - "maxspeed": 0, 823 - "width": 0, 824 - "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 - "hoppercapacity": 0, 827 - "hopperdischargespeed": 0, 828 - "modelType": 0 829 -} 830 - 831 - 832 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 - 834 -(% class="box warningmessage" %) 835 -((( 836 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 837 -))) 838 - 839 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 840 - 841 -(% style="color:#000000" %)Метод запроса: **PUT** 842 - 843 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 844 - 845 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 846 - 847 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 848 - 849 -{ 850 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 851 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 852 - "deleted": true, 853 - "extId": "string", 854 - "name": "string", 855 - "picture": "string", 856 - "minspeed": 0, 857 - "maxspeed": 0, 858 - "width": 0, 859 - "imbeddedtrailer": true, 860 - "fueloutlay": 0, 861 - "hoppercapacity": 0, 862 - "hopperdischargespeed": 0, 863 - "modelType": 0 864 -} 865 - 866 -Ответ: 867 - 868 -{ 869 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 871 - "deleted": true, 872 - "extId": "string", 873 - "name": "string", 874 - "picture": "string", 875 - "minspeed": 0, 876 - "maxspeed": 0, 877 - "width": 0, 878 - "imbeddedtrailer": true, 879 - "fueloutlay": 0, 880 - "hoppercapacity": 0, 881 - "hopperdischargespeed": 0, 882 - "modelType": 0 883 -} 884 - 885 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 - 887 -(% class="box errormessage" %) 888 -((( 889 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 890 -))) 891 - 892 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 893 - 894 -(% style="color:#000000" %)Метод запроса: **DELETE** 895 - 896 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 897 - 898 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 899 - 900 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 901 - 902 -Ответ: В случае успеха **Success 200** 903 - 904 904 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1723,191 +1723,22 @@ 1723 1723 (% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1727 1727 1728 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1729 - 1730 -(% class="box infomessage" %) 1731 -((( 1732 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 1733 -))) 1734 - 1735 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 1736 - 1737 -(% style="color:#000000" %)Метод запроса: **GET** 1738 - 1739 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 1740 - 1741 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1742 - 1743 -(% style="color:#000000" %)Ответ: 1744 - 1745 -(% style="color:#000000" %){ 1746 - 1747 - "id": "", ~/~/ ID типа датчика 1748 - "name": "", ~/~/ Название 1749 - "description": "", ~/~/ Описание 1750 - 1751 1751 (% style="text-align:left" %) 1752 -(% style="color:#000000" %) }1509 +(% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов** 1753 1753 1754 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Сообщения**(%%) =1511 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 1755 1755 1756 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 1757 - 1758 -(% class="box infomessage" style="text-align: left;" %) 1759 -((( 1760 -**POST /api/v3/terminalMessages/count** 1761 -))) 1762 - 1763 -(% style="text-align: left;" %) 1764 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 1765 - 1766 -(% style="text-align: left;" %) 1767 -Метод запроса **POST** 1768 - 1769 -(% style="text-align: left;" %) 1770 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 1771 - 1772 -(% style="text-align: left;" %) 1773 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 - 1775 -(% style="text-align: left;" %) 1776 -{ 1777 - "vehicleIds": [ 1778 - id ~/~/ здесь передается список идентификаторов объектов 1779 - ], 1780 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1781 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 1782 -} 1783 - 1784 -(% style="text-align: left;" %) 1785 -Ответ: 1786 - 1787 -(% style="text-align: left;" %) 1788 -[ 1789 - { 1790 - "vehicleId": 0, ~/~/ идентификатор объекта 1791 - "count": 0 ~/~/ количество сообщений за период 1792 - } 1793 -] 1794 - 1795 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 - 1797 1797 (% class="box infomessage" %) 1798 1798 ((( 1799 -**POST /api/v3/ terminalMessages**1515 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 1800 1800 ))) 1801 1801 1802 -Метод возвращает списоксообщенийтерминала объектазавыбранныйпериод.1518 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 1803 1803 1804 -(% style="text-align: left;" %) 1805 -Метод запроса **POST** 1806 - 1807 -(% style="text-align: left;" %) 1808 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 1809 - 1810 -(% style="text-align: left;" %) 1811 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1812 - 1813 -{ 1814 - "vehicleId": 0, ~/~/ id объекта 1815 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1816 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 -} 1818 - 1819 -Ответ: 1820 - 1821 -[ 1822 - { 1823 - "messages": [ 1824 - { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1834 - "additionalProp1": "string", 1835 - "additionalProp2": "string", 1836 - "additionalProp3": "string" 1837 - }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 1839 - } 1840 - ] 1841 - } 1842 -] 1843 - 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1845 - 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 - 1901 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 1902 - 1903 -(% class="box infomessage" %) 1904 -((( 1905 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 1906 -))) 1907 - 1908 1908 (% style="color:#000000" %)Метод запроса: **POST** 1909 1909 1910 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/mileageAndMotohours1522 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find 1911 1911 1912 1912 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1913 1913 ... ... @@ -1914,43 +1914,43 @@ 1914 1914 (% style="text-align:left" %) 1915 1915 Тело запроса: 1916 1916 1529 +(% style="text-align:left" %) 1917 1917 { 1918 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1919 - "vehicleIds": [0], ~/~/ Список ID объектов 1920 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1921 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1922 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1531 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 1923 1923 } 1924 1924 1534 +(% style="text-align:left" %) 1925 1925 Ответ: 1926 1926 1927 1927 [ 1928 1928 { 1929 - " vehicleId": 0, ~/~/IDобъекта1930 - "name": "string", ~/~/ ИмяТС1931 - "pe riods":[~/~/Периоды1932 - {1933 - start": "2023-08-09T14:23:14.574Z", ~/~/Начало1934 - end":"2023-08-09T14:23:14.574Z", ~/~/Окончание1935 - mileageBegin": 0, ~/~/Пробег на началопериода1936 - mileageEnd": 0, ~/~/Пробег на окончаниепериода1937 - motohoursBegin":0, ~/~/Моточасы наачало периода1938 - motohoursEnd": 0 ~/~/Моточасы на окончание периода1939 - }1940 - ]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", ~/~/ Дата создания 1941 1941 } 1942 1942 ] 1943 1943 1944 -== (% style="color:#000000; font-size:16px" %)** Получение данныхо расходетранспортногосредства**(%%) ==1554 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 1945 1945 1946 1946 (% class="box infomessage" %) 1947 1947 ((( 1948 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelConsumption**1558 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 1949 1949 ))) 1950 1950 1561 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1562 + 1951 1951 (% style="color:#000000" %)Метод запроса: **POST** 1952 1952 1953 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelConsumption1565 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1954 1954 1955 1955 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1956 1956 ... ... @@ -1958,42 +1958,40 @@ 1958 1958 Тело запроса: 1959 1959 1960 1960 { 1961 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1962 - "vehicleIds": [0], ~/~/ Список ID объектов 1963 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1964 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 1965 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 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 ~/~/ 1966 1966 } 1967 1967 1968 1968 Ответ: 1969 - 1970 1970 [ 1971 1971 { 1972 - "vehicleId": 0, ~/~/ ID объекта 1973 - "name": "string", ~/~/ Имя ТС 1974 - "periods": [ ~/~/ Периоды 1975 - { 1976 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1977 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1978 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 1979 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1980 - "fuelConsumption": 0, ~/~/ Расход топлива 1981 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 1982 - } 1983 - ] 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" 1984 1984 } 1985 1985 ] 1986 1986 1987 -== (% style="color:#000000; font-size:16px" %)** Получение данныхозаправках исливахтранспортногосредства**(%%) ==1595 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) 1990 1990 ((( 1991 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/ vehicles/fuelInOut**1599 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 1992 1992 ))) 1993 1993 1602 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 1603 + 1994 1994 (% style="color:#000000" %)Метод запроса: **POST** 1995 1995 1996 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ vehicles/fuelInOut1606 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1997 1997 1998 1998 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1999 1999 ... ... @@ -2001,10 +2001,15 @@ 2001 2001 Тело запроса: 2002 2002 2003 2003 { 2004 - "vehicleIds": [0], ~/~/ Список ID объектов 2005 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2006 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2007 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 1614 + "startDate": "2023-08-03T14:20:03.439Z", 1615 + "endDate": "2023-08-03T14:20:03.439Z", 1616 + "ids": [ 1617 + 0 1618 + ], 1619 + "byTime": 0, 1620 + "byDist": 0, 1621 + "filterByTime": 0, 1622 + "filterByHalfPerimeter": true 2008 2008 } 2009 2009 2010 2010 Ответ: ... ... @@ -2011,136 +2011,110 @@ 2011 2011 2012 2012 [ 2013 2013 { 2014 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2015 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2016 - "vehicleId": 0, ~/~/ ID объекта 2017 - "name": "string", ~/~/ Имя объекта 2018 - "model": "string", ~/~/ Модель объекта 2019 - "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 - { 2021 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2022 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 - "valueFuel": 0, ~/~/ Количество 2025 - "fuelStart": 0, ~/~/ Уровень топлива на начало события 2026 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2027 - } 2028 - ] 1629 + "geozoneId": 0, 1630 + "geozoneName": "string", 1631 + "startDate": "2023-08-02T06:13:18.554Z", 1632 + "endDate": "2023-08-02T06:13:18.554Z", 1633 + "duration": 0, 1634 + "vehicleId": 0, 1635 + "vehicleName": "string" 2029 2029 } 2030 2030 ] 2031 2031 2032 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2035 2035 1641 + 1642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = 1643 + 1644 +== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) == 1645 + 2036 2036 (% class="box infomessage" %) 2037 2037 ((( 2038 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)** POST**(%%)**/api/v3/gis/find**1648 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types** 2039 2039 ))) 2040 2040 2041 -(% style="color:#000000" %)Метод позволяет получить список геообъектовклиента.Возвращает массивгеообъектов совсейинформациейоних.1651 +(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе. 2042 2042 2043 -(% style="color:#000000" %)Метод запроса: ** POST**1653 +(% style="color:#000000" %)Метод запроса: **GET** 2044 2044 2045 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ gis/find1655 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]] 2046 2046 2047 2047 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2048 2048 2049 -(% style="text-align:left" %) 2050 -Тело запроса: 1659 +(% style="color:#000000" %)Ответ: 2051 2051 2052 -(% style="text-align:left" %) 2053 -{ 2054 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2055 -} 1661 +(% style="color:#000000" %){ 2056 2056 1663 + "id": "", ~/~/ ID типа датчика 1664 + "name": "", ~/~/ Название 1665 + "description": "", ~/~/ Описание 1666 + 2057 2057 (% style="text-align:left" %) 2058 - Ответ:1668 +(% style="color:#000000" %)} 2059 2059 2060 -[ 2061 - { 2062 - "id": 0, ~/~/ Идентификатор объекта геозоны 2063 - "name": "string", ~/~/ Название объекта геозоны 2064 - "type": 0, ~/~/ Тип объекта геозоны 2065 - "fname": "string", ~/~/ Имя файла 2066 - "parentId": "string", ~/~/ Идентификатор клиента 2067 - "radius": 0, ~/~/ Радиус геообъекта 2068 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2069 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2070 - "description": "string", ~/~/ Описание 2071 - "area": 0, ~/~/ Площадь, м^^2^^ 2072 - "perimetr": 0, ~/~/ Периметр, м 2073 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2074 - } 2075 -] 1670 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = 2076 2076 2077 -== (% style="color:#000000; font-size:16px" %)** Запроспересеченийпообъектам**(%%) ==1672 +== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) == 2078 2078 2079 -(% class="box infomessage" %) 1674 +(% class="box infomessage" style="text-align: left;" %) 2080 2080 ((( 2081 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**1676 +**POST /api/v3/terminalMessages/count** 2082 2082 ))) 2083 2083 2084 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 1679 +(% style="text-align: left;" %) 1680 +Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период. 2085 2085 2086 -(% style="color:#000000" %)Метод запроса: **POST** 1682 +(% style="text-align: left;" %) 1683 +Метод запроса **POST** 2087 2087 2088 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 1685 +(% style="text-align: left;" %) 1686 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count 2089 2089 1688 +(% style="text-align: left;" %) 2090 2090 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2091 2091 2092 -(% style="text-align:left" %) 2093 -Тело запроса: 2094 - 1691 +(% style="text-align: left;" %) 2095 2095 { 2096 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2097 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2098 - "ids": [ ], ~/~/ Массив id объектов 2099 - "byTime": 0, ~/~/ Объединение событий по времени 2100 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2101 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2102 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1693 + "vehicleIds": [ 1694 + id ~/~/ здесь передается список идентификаторов объектов 1695 + ], 1696 + "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос 1697 + "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос 2103 2103 } 2104 2104 1700 +(% style="text-align: left;" %) 2105 2105 Ответ: 1702 + 1703 +(% style="text-align: left;" %) 2106 2106 [ 2107 2107 { 2108 - "geozoneId": 0, ~/~/ ID геообъекта 2109 - "geozoneName": "string", ~/~/ Название геообъекта 2110 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2111 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2112 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2113 - "vehicleId": 0, ~/~/ ID объекта 2114 - "vehicleName": "string" ~/~/ Имя объекта 1706 + "vehicleId": 0, ~/~/ идентификатор объекта 1707 + "count": 0 ~/~/ количество сообщений за период 2115 2115 } 2116 2116 ] 2117 2117 2118 -== (% style="color:#000000; font-size:16px" %)**Запрос пересеченийпогеообъектам**(%%) ==1711 +== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 2119 2119 2120 2120 (% class="box infomessage" %) 2121 2121 ((( 2122 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/geozones**1715 +**POST /api/v3/terminalMessages** 2123 2123 ))) 2124 2124 2125 - (% style="color:#000000" %)Методпозволяетполучитьсписокпересеченийвыбранных геообъектов со всеми объектамиза выбранный период.1718 +Метод возвращает список сообщений терминала объекта за выбранный период. 2126 2126 2127 -(% style="color:#000000" %)Метод запроса: **POST** 1720 +(% style="text-align: left;" %) 1721 +Метод запроса **POST** 2128 2128 2129 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 1723 +(% style="text-align: left;" %) 1724 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages 2130 2130 1726 +(% style="text-align: left;" %) 2131 2131 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2132 2132 2133 -(% style="text-align:left" %) 2134 -Тело запроса: 2135 - 2136 2136 { 2137 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2138 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2139 - "ids": [ ], ~/~/ Массив id геообъектов 2140 - "byTime": 0, ~/~/ Объединение событий по времени 2141 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2142 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2143 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 1730 + "vehicleId": 0, ~/~/ id объекта 1731 + "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса 1732 + "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 2144 2144 } 2145 2145 2146 2146 Ответ: ... ... @@ -2147,13 +2147,24 @@ 2147 2147 2148 2148 [ 2149 2149 { 2150 - "geozoneId": 0, ~/~/ ID геообъекта 2151 - "geozoneName": "string", ~/~/ Название геообъекта 2152 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2153 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2154 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2155 - "vehicleId": 0, ~/~/ ID объекта 2156 - "vehicleName": "string" ~/~/ Имя объекта 1739 + "messages": [ 1740 + { 1741 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1742 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1743 + "speed": 0, ~/~/ Скорость, км/ч 1744 + "altitude": 0, ~/~/ Высота, м 1745 + "latitude": 0, ~/~/ Широта [-90°;90°] 1746 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1747 + "satellites": 0, ~/~/ Кол-во спутников 1748 + "voltage": 0, ~/~/ Напряжение 1749 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1750 + "additionalProp1": "string", 1751 + "additionalProp2": "string", 1752 + "additionalProp3": "string" 1753 + }, 1754 + "photoCount": 0 ~/~/ Кол-во фото 1755 + } 1756 + ] 2157 2157 } 2158 2158 ] 2159 2159 ... ... @@ -2955,6 +2955,7 @@ 2955 2955 } 2956 2956 ] 2957 2957 2558 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -3006,6 +3006,7 @@ 3006 3006 "deleted": true 3007 3007 } 3008 3008 2610 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3035,6 +3035,7 @@ 3035 3035 "deleted": true 3036 3036 } 3037 3037 2640 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3049,310 +3049,6 @@ 3049 3049 Success 3050 3050 3051 3051 3052 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 - 3054 -(% class="wikigeneratedid" %) 3055 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3056 - 3057 -(% class="box infomessage" %) 3058 -((( 3059 -**GET /api/v3/Billing/client/balance/{clientId}** 3060 -))) 3061 - 3062 -Параметр запроса: **clientId **- идентификатор клиента. 3063 - 3064 -Ответ: 3065 - 3066 -{ 3067 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3068 - "Balance": 0 3069 -} 3070 - 3071 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3072 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3073 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3074 - 3075 -(% class="wikigeneratedid" %) 3076 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3077 - 3078 -(% class="box infomessage" %) 3079 -((( 3080 -**GET /api/v3/Billing/client/constraint/{clientId}** 3081 -))) 3082 - 3083 -Параметр запроса: **clientId **- идентификатор клиента. 3084 - 3085 -Ответ: 3086 - 3087 -{ 3088 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3089 - "CalculationType": 0, 3090 - "PermissibleBalance": 0, 3091 - "DefermentDays": 0, 3092 - "SendUiNotifications": true, 3093 - "SendEmailNotifications": true, 3094 - "IsPrivate": true, 3095 -} 3096 - 3097 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3098 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3099 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3100 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3101 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3102 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3103 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3104 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3105 - 3106 -(% class="wikigeneratedid" %) 3107 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3108 - 3109 -(% class="box infomessage" %) 3110 -((( 3111 -**GET /api/v3/Billing/client/plan/{clientId}** 3112 -))) 3113 - 3114 -Параметры запроса: 3115 - 3116 -**clientId **- идентификатор клиента. 3117 - 3118 -**planId **- идентификатор тарифного плана. 3119 - 3120 -Ответ: 3121 - 3122 -{ 3123 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3124 - "Plan": { **~/~/ Описание тарифного плана** 3125 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3126 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3127 - "Name": "string", 3128 - "IsArchived": true, 3129 - "Constraint": { 3130 - "CalculationType": 0, 3131 - "PermissibleBalance": 0, 3132 - "DefermentDays": 0 3133 - }, 3134 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3135 - { 3136 - "Feature": "string", 3137 - "IsFactual": true, 3138 - "Limit": 0, 3139 - "Price": 0, 3140 - "PeriodValue": 0, 3141 - "PeriodType": 0 3142 - } 3143 - ] 3144 - }, 3145 - "DebitDate": "2023-10-18T12:46:24.213Z", 3146 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3147 - { 3148 - "Feature": "string", 3149 - "IsEnabled": true, 3150 - "IsPrivate": true, 3151 - "IsFactual": true, 3152 - "Limit": 0, 3153 - "Price": 0, 3154 - "DebitDate": "2023-10-18T12:46:24.213Z", 3155 - "PeriodValue": 0, 3156 - "PeriodType": 0 3157 - } 3158 - ] 3159 -} 3160 - 3161 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3162 -|ClientId|Идентификатор клиента 3163 -|Id|Идентификатор тарифного плана 3164 -|OwnerId|Идентификатор клиента-владельца 3165 -|Name|Наименование тарифного плана 3166 -|IsArchived|Признак, определяющий архивный тарифный план 3167 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3168 -|PermissibleBalance|Допустимый баланс 3169 -|DefermentDays|Отсрочка, количество дней 3170 -|Feature|Код услуги 3171 -|IsEnabled|Признак, определяющий активирована ли услуга 3172 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3173 -|IsFactual|Признак, определяющий расчёт по факту 3174 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3175 -|Price|Цена за единицу. 3176 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3177 -|PeriodValue|Значение периода. 3178 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3179 - 3180 -(% class="wikigeneratedid" %) 3181 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3182 - 3183 -(% class="box infomessage" %) 3184 -((( 3185 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3186 -))) 3187 - 3188 -Параметр запроса: **clientId **- идентификатор клиента. 3189 - 3190 -Ответ: 3191 - 3192 -[ 3193 - { 3194 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3195 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3196 - "Name": "string", 3197 - "IsArchived": true, 3198 - "Constraint": { 3199 - "CalculationType": 0, 3200 - "PermissibleBalance": 0, 3201 - "DefermentDays": 0 3202 - }, 3203 - "Features": [ 3204 - { 3205 - "Feature": "string", 3206 - "IsFactual": true, 3207 - "Limit": 0, 3208 - "Price": 0, 3209 - "PeriodValue": 0, 3210 - "PeriodType": 0 3211 - } 3212 - ] 3213 - } 3214 -] 3215 - 3216 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3217 -|ClientId|Идентификатор клиента 3218 -|Id|Идентификатор тарифного плана 3219 -|OwnerId|Идентификатор клиента-владельца 3220 -|Name|Наименование тарифного плана 3221 -|IsArchived|Признак, определяющий архивный тарифный план 3222 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3223 -|PermissibleBalance|Допустимый баланс 3224 -|DefermentDays|Отсрочка, количество дней 3225 -|Feature|Код услуги 3226 -|IsFactual|Признак, определяющий расчёт по факту 3227 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3228 -|Price|Цена за единицу. 3229 -|PeriodValue|Значение периода. 3230 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3231 - 3232 -(% class="wikigeneratedid" %) 3233 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3234 - 3235 -(% class="box infomessage" %) 3236 -((( 3237 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3238 -))) 3239 - 3240 -Параметр запроса: **clientId **- идентификатор клиента. 3241 - 3242 -Ответ: 3243 - 3244 -[ 3245 - { 3246 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3247 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3248 - "Name": "string", 3249 - "IsArchived": true, 3250 - "Constraint": { 3251 - "CalculationType": 0, 3252 - "PermissibleBalance": 0, 3253 - "DefermentDays": 0 3254 - }, 3255 - "Features": [ 3256 - { 3257 - "Feature": "string", 3258 - "IsFactual": true, 3259 - "Limit": 0, 3260 - "Price": 0, 3261 - "PeriodValue": 0, 3262 - "PeriodType": 0 3263 - } 3264 - ] 3265 - } 3266 -] 3267 - 3268 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3269 -|ClientId|Идентификатор клиента 3270 -|Id|Идентификатор тарифного плана 3271 -|OwnerId|Идентификатор клиента-владельца 3272 -|Name|Наименование тарифного плана 3273 -|IsArchived|Признак, определяющий архивный тарифный план 3274 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3275 -|PermissibleBalance|Допустимый баланс 3276 -|DefermentDays|Отсрочка, количество дней 3277 -|Feature|Код услуги 3278 -|IsFactual|Признак, определяющий расчёт по факту 3279 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3280 -|Price|Цена за единицу. 3281 -|PeriodValue|Значение периода. 3282 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3283 - 3284 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3285 - 3286 -(% class="box warningmessage" %) 3287 -((( 3288 -**PUT /api/v3/Billing/client/constraint** 3289 -))) 3290 - 3291 -Тело запроса: 3292 - 3293 -{ 3294 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3295 - "CalculationType": 0, 3296 - "PermissibleBalance": 0, 3297 - "DefermentDays": 0, 3298 - "SendUiNotifications": true, 3299 - "SendEmailNotifications": true, 3300 - "IsPrivate": true, 3301 -} 3302 - 3303 -Ответ: Success 3304 - 3305 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3306 -|ClientId|Идентификатор клиента 3307 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3308 -|PermissibleBalance|Допустимый баланс 3309 -|DefermentDays|((( 3310 -Отсрочка, количество дней 3311 -))) 3312 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3313 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3314 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3315 - 3316 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3317 - 3318 -(% class="box warningmessage" %) 3319 -((( 3320 -**PUT /api/v3/Billing/client/plan** 3321 -))) 3322 - 3323 -Тело запроса: 3324 - 3325 -{ 3326 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3327 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3328 - "Features": [ 3329 - { 3330 - "Feature": "string", 3331 - "IsEnabled": true, 3332 - "IsFactual": true, 3333 - "Limit": 0, 3334 - "Price": 0, 3335 - "DebitDate": "2023-10-18T13:26:58.987Z", 3336 - "PeriodValue": 0, 3337 - "PeriodType": 0 3338 - } 3339 - ] 3340 -} 3341 - 3342 -Ответ: Success 3343 - 3344 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3345 -|ClientId|Идентификатор клиента 3346 -|Feature|Код услуги 3347 -|IsEnabled|Признак, определяющий активирована ли услуга 3348 -|IsFactual|Признак, определяющий расчёт по факту 3349 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3350 -|Price|Цена за единицу. 3351 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3352 -|PeriodValue|Значение периода. 3353 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3354 - 3355 - 3356 3356 (% class="box" lang="en-US" style="text-align: center;" %) 3357 3357 ((( 3358 3358 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **