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" %)**Получение информации об объекте**(%%) == ... ... @@ -1474,7 +1474,7 @@ 1474 1474 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1475 1475 1476 1476 (% style="color:#000000" %){ 1477 - "vehicleId": , ~/~/ ID объекта1258 + 1478 1478 "parentId": "" , ~/~/ ID клиента 1479 1479 "name": "" , ~/~/ имя ТС 1480 1480 "imei": "" , ~/~/ IMEI ... ... @@ -1841,322 +1841,6 @@ 1841 1841 } 1842 1842 ] 1843 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 -(% style="color:#000000" %)Метод запроса: **POST** 1909 - 1910 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 1911 - 1912 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1913 - 1914 -(% style="text-align:left" %) 1915 -Тело запроса: 1916 - 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 1923 -} 1924 - 1925 -Ответ: 1926 - 1927 -[ 1928 - { 1929 - "vehicleId": 0, ~/~/ ID объекта 1930 - "name": "string", ~/~/ Имя ТС 1931 - "periods": [ ~/~/ Периоды 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 - ] 1941 - } 1942 -] 1943 - 1944 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 1945 - 1946 -(% class="box infomessage" %) 1947 -((( 1948 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 1949 -))) 1950 - 1951 -(% style="color:#000000" %)Метод запроса: **POST** 1952 - 1953 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 1954 - 1955 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1956 - 1957 -(% style="text-align:left" %) 1958 -Тело запроса: 1959 - 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 1966 -} 1967 - 1968 -Ответ: 1969 - 1970 -[ 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 - ] 1984 - } 1985 -] 1986 - 1987 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 - 1989 -(% class="box infomessage" %) 1990 -((( 1991 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 1992 -))) 1993 - 1994 -(% style="color:#000000" %)Метод запроса: **POST** 1995 - 1996 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 1997 - 1998 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1999 - 2000 -(% style="text-align:left" %) 2001 -Тело запроса: 2002 - 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 2008 -} 2009 - 2010 -Ответ: 2011 - 2012 -[ 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 - ] 2029 - } 2030 -] 2031 - 2032 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 - 2034 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2035 - 2036 -(% class="box infomessage" %) 2037 -((( 2038 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2039 -))) 2040 - 2041 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2042 - 2043 -(% style="color:#000000" %)Метод запроса: **POST** 2044 - 2045 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2046 - 2047 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2048 - 2049 -(% style="text-align:left" %) 2050 -Тело запроса: 2051 - 2052 -(% style="text-align:left" %) 2053 -{ 2054 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2055 -} 2056 - 2057 -(% style="text-align:left" %) 2058 -Ответ: 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 -] 2076 - 2077 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2078 - 2079 -(% class="box infomessage" %) 2080 -((( 2081 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2082 -))) 2083 - 2084 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2085 - 2086 -(% style="color:#000000" %)Метод запроса: **POST** 2087 - 2088 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2089 - 2090 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2091 - 2092 -(% style="text-align:left" %) 2093 -Тело запроса: 2094 - 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 ~/~/ Фильтрация событий по пробегу половины периметра 2103 -} 2104 - 2105 -Ответ: 2106 -[ 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" ~/~/ Имя объекта 2115 - } 2116 -] 2117 - 2118 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2119 - 2120 -(% class="box infomessage" %) 2121 -((( 2122 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2123 -))) 2124 - 2125 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2126 - 2127 -(% style="color:#000000" %)Метод запроса: **POST** 2128 - 2129 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2130 - 2131 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2132 - 2133 -(% style="text-align:left" %) 2134 -Тело запроса: 2135 - 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 ~/~/ Фильтрация событий по пробегу половины периметра 2144 -} 2145 - 2146 -Ответ: 2147 - 2148 -[ 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" ~/~/ Имя объекта 2157 - } 2158 -] 2159 - 2160 2160 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2161 2161 2162 2162 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2362,126 +2362,78 @@ 2362 2362 2363 2363 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2364 2364 2365 -(% class="box infomessage" %) 2366 -((( 2367 -**POST /api/v3/Drivers/find** 2368 -))) 1830 +POST /api/v3/Drivers/find 2369 2369 2370 -Передается параметр: parentId - ID клиента-родителя1832 +Передается: parentId - ID клиента-родителя 2371 2371 2372 2372 Ответ: 2373 2373 2374 -[ 1836 +{{{[ 2375 2375 { 2376 - "name": "string", ~/~/2377 - "description": "string", ~/~/ Определяет описание2378 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма2379 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения2380 - "exclusive": true, ~/~/ Определяет признак "Исключительный"2381 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя2382 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя2383 - "deleted": true ~/~/ Признак удаления1838 + "name": "string", //Определяет наименование 1839 + "description": "string", // Определяет описание 1840 + "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма 1841 + "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения 1842 + "exclusive": true, // Определяет признак "Исключительный" 1843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1844 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1845 + "deleted": true // Признак удаления 2384 2384 } 2385 -] 1847 +]}}} 2386 2386 1849 + 2387 2387 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 2388 2388 2389 -(% class="box infomessage" %) 2390 -((( 2391 -**GET /api/v3/Drivers/{driverGuid}** 2392 -))) 1852 +GET /api/v3/Drivers/{driverGuid} 2393 2393 2394 -Передается параметр:ID водителя1854 +Передается ID водителя 2395 2395 2396 2396 Ответ: 2397 2397 2398 -{ 2399 - "name": "string", ~/~/ Определяет наименование2400 - "description": "string", ~/~/ Определяет описание2401 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма2402 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения2403 - "exclusive": true, ~/~/ Определяет признак "Исключительный"2404 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя2405 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя2406 - "deleted": true ~/~/ Признак удаления1858 +{{{{ 1859 + "name": "string", // Определяет наименование 1860 + "description": "string", // Определяет описание 1861 + "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма 1862 + "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения 1863 + "exclusive": true, // Определяет признак "Исключительный" 1864 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1866 + "deleted": true // Признак удаления 2407 2407 } 1868 +}}} 2408 2408 1870 + 2409 2409 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 2410 2410 2411 -(% class="box successmessage" %) 2412 -((( 2413 -**POST /api/v3/Drivers** 2414 -))) 1873 +POST /api/v3/Drivers 2415 2415 2416 - Запрос:1875 +Передается: 2417 2417 2418 -{ 2419 - "name": "string", 2420 - "description": "string", 2421 - "hiredate": "2023-06-30T12:50:54.020Z", 2422 - "chopdate": "2023-06-30T12:50:54.020Z", 2423 - "exclusive": true, 2424 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2425 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2426 - "deleted": true 2427 -} 1877 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:05.949Z", "chopdate": "2023-06-30T09:43:05.949Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 2428 2428 2429 2429 Ответ: 2430 2430 2431 -{ 2432 - "name": "string", 2433 - "description": "string", 2434 - "hiredate": "2023-06-30T12:50:54.051Z", 2435 - "chopdate": "2023-06-30T12:50:54.051Z", 2436 - "exclusive": true, 2437 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2438 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2439 - "deleted": true 2440 -} 1881 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:06.014Z", "chopdate": "2023-06-30T09:43:06.014Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 2441 2441 2442 2442 2443 2443 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 2444 2444 2445 -(% class="box warningmessage" %) 2446 -((( 2447 -**PUT /api/v3/Drivers** 2448 -))) 1886 +PUT /api/v3/Drivers 2449 2449 2450 - Запрос:1888 +Передается: 2451 2451 2452 -{ 2453 - "name": "string", 2454 - "description": "string", 2455 - "hiredate": "2023-06-30T12:50:27.910Z", 2456 - "chopdate": "2023-06-30T12:50:27.910Z", 2457 - "exclusive": true, 2458 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2459 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2460 - "deleted": true 2461 -} 1890 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.382Z", "chopdate": "2023-06-30T09:45:41.382Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 2462 2462 2463 2463 Ответ: 2464 2464 2465 -{ 2466 - "name": "string", 2467 - "description": "string", 2468 - "hiredate": "2023-06-30T12:50:27.929Z", 2469 - "chopdate": "2023-06-30T12:50:27.929Z", 2470 - "exclusive": true, 2471 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2472 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2473 - "deleted": true 2474 -} 1894 +{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.433Z", "chopdate": "2023-06-30T09:45:41.433Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 2475 2475 2476 2476 2477 2477 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 2478 2478 2479 -(% class="box errormessage" %) 2480 -((( 2481 -**DELETE /api/v3/Drivers/{driverGuid}** 2482 -))) 1899 +DELETE /api/v3/Drivers/{driverGuid} 2483 2483 2484 -Передается параметр:ID водителя1901 +Передается ID водителя 2485 2485 2486 2486 Ответ: 2487 2487 ... ... @@ -2494,24 +2494,15 @@ 2494 2494 2495 2495 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 2496 2496 2497 -(% class="box infomessage" %) 2498 -((( 2499 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 2500 -))) 1914 +POST /api/v3/DriversVehiclesAssignments/GetByDrivers 2501 2501 2502 - Запрос:1916 +Передаем: 2503 2503 2504 -{ 2505 - "Ids": [ 2506 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2507 - ], 2508 - "BeginTime": "2023-06-30T12:49:04.365Z", 2509 - "EndTime": "2023-06-30T12:49:04.365Z" 2510 -} 1918 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T09:52:31.196Z", "EndTime": "2023-06-30T09:52:31.196Z" }}}} 2511 2511 2512 2512 Ответ: 2513 2513 2514 -[ 1922 +{{{[ 2515 2515 { 2516 2516 "VehicleId": 0, 2517 2517 "CreateTime": "2023-06-30T09:52:31.240Z", ... ... @@ -2520,29 +2520,20 @@ 2520 2520 "BeginTime": "2023-06-30T09:52:31.240Z", 2521 2521 "EndTime": "2023-06-30T09:52:31.240Z" 2522 2522 } 2523 -] 1931 +]}}} 2524 2524 2525 2525 2526 2526 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 2527 2527 2528 -(% class="box infomessage" %) 2529 -((( 2530 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 2531 -))) 1936 +POST /api/v3/DriversVehiclesAssignments/GetByVehicles 2532 2532 2533 - Запрос:1938 +Передаем: 2534 2534 2535 -{ 2536 - "Ids": [ 2537 - 0 2538 - ], 2539 - "BeginTime": "2023-06-30T12:48:39.419Z", 2540 - "EndTime": "2023-06-30T12:48:39.419Z" 2541 -} 1940 +{{{{ "Ids": [ 0 ], "BeginTime": "2023-06-30T09:54:01.583Z", "EndTime": "2023-06-30T09:54:01.583Z" }}}} 2542 2542 2543 2543 Ответ: 2544 2544 2545 -[ 1944 +{{{[ 2546 2546 { 2547 2547 "VehicleId": 0, 2548 2548 "CreateTime": "2023-06-30T09:54:01.631Z", ... ... @@ -2551,33 +2551,30 @@ 2551 2551 "BeginTime": "2023-06-30T09:54:01.631Z", 2552 2552 "EndTime": "2023-06-30T09:54:01.631Z" 2553 2553 } 2554 -] 1953 +]}}} 2555 2555 2556 2556 2557 2557 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2558 2558 2559 -(% class="box successmessage" %) 2560 -((( 2561 -**POST /api/v3/DriversVehiclesAssignments** 2562 -))) 1958 +POST /api/v3/DriversVehiclesAssignments 2563 2563 2564 2564 Передается массив назначений 2565 2565 2566 2566 Запрос: 2567 2567 2568 -[ 1964 +{{{[ 2569 2569 { 2570 - "VehicleId": 0, ~/~/ Идентификатор объекта2571 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения2572 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя2573 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения2574 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.1966 + "VehicleId": 0, // Идентификатор объекта 1967 + "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения 1968 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 1969 + "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения 1970 + "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно. 2575 2575 } 2576 -] 1972 +]}}} 2577 2577 2578 2578 Ответ: 2579 2579 2580 -[ 1976 +{{{[ 2581 2581 { 2582 2582 "VehicleId": 0, 2583 2583 "CreateTime": "2023-06-30T11:04:46.903Z", ... ... @@ -2586,32 +2586,29 @@ 2586 2586 "BeginTime": "2023-06-30T11:04:46.903Z", 2587 2587 "EndTime": "2023-06-30T11:04:46.903Z" 2588 2588 } 2589 -] 1985 +]}}} 2590 2590 2591 2591 2592 2592 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2593 2593 2594 -(% class="box warningmessage" %) 2595 -((( 2596 -**PUT /api/v3/DriversVehiclesAssignments** 2597 -))) 1990 +PUT /api/v3/DriversVehiclesAssignments 2598 2598 2599 2599 Запрос: 2600 2600 2601 -[ 1994 +{{{[ 2602 2602 { 2603 2603 "VehicleId": 0, 2604 2604 "CreateTime": "2023-06-30T11:14:08.117Z", 2605 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения1998 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2606 2606 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2607 2607 "BeginTime": "2023-06-30T11:14:08.117Z", 2608 2608 "EndTime": "2023-06-30T11:14:08.117Z" 2609 2609 } 2610 -] 2003 +]}}} 2611 2611 2612 2612 Ответ: 2613 2613 2614 -[ 2007 +{{{[ 2615 2615 { 2616 2616 "VehicleId": 0, 2617 2617 "CreateTime": "2023-06-30T11:14:53.349Z", ... ... @@ -2620,25 +2620,38 @@ 2620 2620 "BeginTime": "2023-06-30T11:14:53.349Z", 2621 2621 "EndTime": "2023-06-30T11:14:53.349Z" 2622 2622 } 2623 -] 2016 +]}}} 2624 2624 2625 2625 2626 2626 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2627 2627 2628 -(% class="box errormessage" %) 2629 -((( 2630 -**DELETE /api/v3/DriversVehiclesAssignments** 2631 -))) 2021 +DELETE /api/v3/DriversVehiclesAssignments 2632 2632 2633 2633 Запрос: 2634 2634 2635 -[ 2636 - "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2637 -] 2025 +{{{[ 2026 + { 2027 + "VehicleId": 0, 2028 + "CreateTime": "2023-06-30T11:16:08.341Z", 2029 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2030 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2031 + "BeginTime": "2023-06-30T11:16:08.342Z", 2032 + "EndTime": "2023-06-30T11:16:08.342Z" 2033 + } 2034 +]}}} 2638 2638 2639 2639 Ответ: 2640 2640 2641 -Success 2038 +{{{[ 2039 + { 2040 + "VehicleId": 0, 2041 + "CreateTime": "2023-06-30T11:16:08.344Z", 2042 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2043 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2044 + "BeginTime": "2023-06-30T11:16:08.344Z", 2045 + "EndTime": "2023-06-30T11:16:08.344Z" 2046 + } 2047 +]}}} 2642 2642 2643 2643 2644 2644 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == ... ... @@ -2645,74 +2645,53 @@ 2645 2645 2646 2646 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2647 2647 2648 -(% class="box infomessage" %) 2649 -((( 2650 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 2651 -))) 2054 +POST /api/v3/DriversRfidsAssignments/GetByDrivers 2652 2652 2653 2653 Запрос: 2654 2654 2655 -{ 2656 - "Ids": [ 2657 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2658 - ], 2659 - "BeginTime": "2023-06-30T12:47:12.162Z", 2660 - "EndTime": "2023-06-30T12:47:12.162Z" 2661 -} 2058 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы водителей ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}} 2662 2662 2663 2663 Ответ: 2664 2664 2665 -[ 2062 +{{{[ 2666 2666 { 2667 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки2668 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения2669 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя2064 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2065 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2066 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 2670 2670 "BeginTime": "2023-06-30T11:19:40.703Z", 2671 2671 "EndTime": "2023-06-30T11:19:40.703Z" 2672 2672 } 2673 -] 2070 +]}}} 2674 2674 2675 2675 2676 2676 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2677 2677 2678 -(% class="box infomessage" %) 2679 -((( 2680 -**POST /api/v3/DriversRfidsAssignments/GetByRfids** 2681 -))) 2075 +POST /api/v3/DriversRfidsAssignments/GetByDrivers 2682 2682 2683 2683 Запрос: 2684 2684 2685 -{ 2686 - "Ids": [ 2687 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2688 - ], 2689 - "BeginTime": "2023-06-30T12:47:12.162Z", 2690 - "EndTime": "2023-06-30T12:47:12.162Z" 2691 -} 2079 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы карт-меток ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}} 2692 2692 2693 2693 Ответ: 2694 2694 2695 -[ 2083 +{{{[ 2696 2696 { 2697 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки2698 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения2699 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя2085 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2086 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2087 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 2700 2700 "BeginTime": "2023-06-30T11:19:40.703Z", 2701 2701 "EndTime": "2023-06-30T11:19:40.703Z" 2702 2702 } 2703 -] 2091 +]}}} 2704 2704 2705 2705 2706 2706 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2707 2707 2708 -(% class="box successmessage" %) 2709 -((( 2710 -**POST /api/v3/DriversRfidsAssignments** 2711 -))) 2096 +POST /api/v3/DriversRfidsAssignments 2712 2712 2713 2713 Запрос: 2714 2714 2715 -[ 2100 +{{{[ 2716 2716 { 2717 2717 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2718 2718 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2719,11 +2719,11 @@ 2719 2719 "BeginTime": "2023-06-30T11:27:08.635Z", 2720 2720 "EndTime": "2023-06-30T11:27:08.635Z" 2721 2721 } 2722 -] 2107 +]}}} 2723 2723 2724 2724 Ответ: 2725 2725 2726 -[ 2111 +{{{[ 2727 2727 { 2728 2728 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2729 2729 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2731,19 +2731,16 @@ 2731 2731 "BeginTime": "2023-06-30T11:27:08.677Z", 2732 2732 "EndTime": "2023-06-30T11:27:08.677Z" 2733 2733 } 2734 -] 2119 +]}}} 2735 2735 2736 2736 2737 2737 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2738 2738 2739 -(% class="box warningmessage" %) 2740 -((( 2741 -**PUT /api/v3/DriversRfidsAssignments** 2742 -))) 2124 +PUT /api/v3/DriversRfidsAssignments 2743 2743 2744 2744 Запрос: 2745 2745 2746 -[ 2128 +{{{[ 2747 2747 { 2748 2748 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2749 2749 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2751,11 +2751,11 @@ 2751 2751 "BeginTime": "2023-06-30T11:28:43.330Z", 2752 2752 "EndTime": "2023-06-30T11:28:43.330Z" 2753 2753 } 2754 -] 2136 +]}}} 2755 2755 2756 2756 Ответ: 2757 2757 2758 -[ 2140 +{{{[ 2759 2759 { 2760 2760 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2761 2761 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2763,25 +2763,36 @@ 2763 2763 "BeginTime": "2023-06-30T11:28:43.331Z", 2764 2764 "EndTime": "2023-06-30T11:28:43.331Z" 2765 2765 } 2766 -] 2148 +]}}} 2767 2767 2768 2768 2769 2769 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2770 2770 2771 -(% class="box errormessage" %) 2772 -((( 2773 -**DELETE /api/v3/DriversRfidsAssignments** 2774 -))) 2153 +DELETE /api/v3/DriversRfidsAssignments 2775 2775 2776 2776 Запрос: 2777 2777 2778 -[ 2779 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2780 -] 2157 +{{{[ 2158 + { 2159 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2160 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2161 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2162 + "BeginTime": "2023-06-30T11:28:43.330Z", 2163 + "EndTime": "2023-06-30T11:28:43.330Z" 2164 + } 2165 +]}}} 2781 2781 2782 2782 Ответ: 2783 2783 2784 -Success 2169 +{{{[ 2170 + { 2171 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2172 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2173 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2174 + "BeginTime": "2023-06-30T11:28:43.331Z", 2175 + "EndTime": "2023-06-30T11:28:43.331Z" 2176 + } 2177 +]}}} 2785 2785 2786 2786 2787 2787 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == ... ... @@ -2788,24 +2788,15 @@ 2788 2788 2789 2789 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2790 2790 2791 -(% class="box infomessage" %) 2792 -((( 2793 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 2794 -))) 2184 +POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 2795 2795 2796 2796 Запрос: 2797 2797 2798 -{ 2799 - "Ids": [ 2800 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2801 - ], 2802 - "BeginTime": "2023-06-30T12:45:10.852Z", 2803 - "EndTime": "2023-06-30T12:45:10.852Z" 2804 -} 2188 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}} 2805 2805 2806 2806 Ответ: 2807 2807 2808 -[ 2192 +{{{[ 2809 2809 { 2810 2810 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2811 2811 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2813,29 +2813,20 @@ 2813 2813 "BeginTime": "2023-06-30T11:58:04.695Z", 2814 2814 "EndTime": "2023-06-30T11:58:04.695Z" 2815 2815 } 2816 -] 2200 +]}}} 2817 2817 2818 2818 2819 2819 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2820 2820 2821 -(% class="box infomessage" %) 2822 -((( 2823 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 2824 -))) 2205 +POST /api/v3/DriversFuelCardsAssignments/GetByCards 2825 2825 2826 2826 Запрос: 2827 2827 2828 -{ 2829 - "Ids": [ 2830 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2831 - ], 2832 - "BeginTime": "2023-06-30T12:45:10.852Z", 2833 - "EndTime": "2023-06-30T12:45:10.852Z" 2834 -} 2209 +{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}} 2835 2835 2836 2836 Ответ: 2837 2837 2838 -[ 2213 +{{{[ 2839 2839 { 2840 2840 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2841 2841 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2843,19 +2843,16 @@ 2843 2843 "BeginTime": "2023-06-30T11:58:04.695Z", 2844 2844 "EndTime": "2023-06-30T11:58:04.695Z" 2845 2845 } 2846 -] 2221 +]}}} 2847 2847 2848 2848 2849 2849 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2850 2850 2851 -(% class="box successmessage" %) 2852 -((( 2853 -**POST /api/v3/DriversFuelCardsAssignments** 2854 -))) 2226 +POST /api/v3/DriversFuelCardsAssignments 2855 2855 2856 2856 Запрос: 2857 2857 2858 -[ 2230 +{{{[ 2859 2859 { 2860 2860 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2861 2861 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2862,11 +2862,11 @@ 2862 2862 "BeginTime": "2023-06-30T12:09:53.175Z", 2863 2863 "EndTime": "2023-06-30T12:09:53.175Z" 2864 2864 } 2865 -] 2237 +]}}} 2866 2866 2867 2867 Ответ: 2868 2868 2869 -[ 2241 +{{{[ 2870 2870 { 2871 2871 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2872 2872 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2874,31 +2874,27 @@ 2874 2874 "BeginTime": "2023-06-30T12:09:53.201Z", 2875 2875 "EndTime": "2023-06-30T12:09:53.201Z" 2876 2876 } 2877 -] 2249 +]}}} 2878 2878 2879 2879 2880 2880 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2881 2881 2882 -(% class="box warningmessage" %) 2883 -((( 2884 -**PUT /api/v3/DriversFuelCardsAssignments** 2885 -))) 2254 +PUT /api/v3/DriversFuelCardsAssignments 2886 2886 2887 2887 Запрос: 2888 2888 2889 -[ 2258 +{{{[ 2890 2890 { 2891 2891 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2892 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2893 2893 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2894 - "BeginTime": "2023-06-30T12:09:53. 201Z",2895 - "EndTime": "2023-06-30T12:09:53. 201Z"2262 + "BeginTime": "2023-06-30T12:09:53.175Z", 2263 + "EndTime": "2023-06-30T12:09:53.175Z" 2896 2896 } 2897 -] 2265 +]}}} 2898 2898 2899 2899 Ответ: 2900 2900 2901 -[ 2269 +{{{[ 2902 2902 { 2903 2903 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2904 2904 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2906,25 +2906,35 @@ 2906 2906 "BeginTime": "2023-06-30T12:09:53.201Z", 2907 2907 "EndTime": "2023-06-30T12:09:53.201Z" 2908 2908 } 2909 -] 2277 +]}}} 2910 2910 2911 2911 2912 2912 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2913 2913 2914 -(% class="box errormessage" %) 2915 -((( 2916 -**DELETE /api/v3/DriversFuelCardsAssignments** 2917 -))) 2282 +DELETE /api/v3/DriversFuelCardsAssignments 2918 2918 2919 2919 Запрос: 2920 2920 2921 -[ 2922 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2923 -] 2286 +{{{[ 2287 + { 2288 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2289 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2290 + "BeginTime": "2023-06-30T12:09:53.175Z", 2291 + "EndTime": "2023-06-30T12:09:53.175Z" 2292 + } 2293 +]}}} 2924 2924 2925 2925 Ответ: 2926 2926 2927 -Success 2297 +{{{[ 2298 + { 2299 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2300 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2301 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2302 + "BeginTime": "2023-06-30T12:09:53.201Z", 2303 + "EndTime": "2023-06-30T12:09:53.201Z" 2304 + } 2305 +]}}} 2928 2928 2929 2929 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = ... ... @@ -2931,73 +2931,65 @@ 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2933 2933 2934 -(% class="box infomessage" %) 2935 -((( 2936 -**POST /api/v3/Rfids/find** 2937 -))) 2312 +POST /api/v3/Rfids/find 2938 2938 2939 2939 Запрос: 2940 2940 2941 -{ 2316 +{{{{ 2942 2942 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2943 -} 2318 +}}}} 2944 2944 2945 2945 Ответ: 2946 2946 2947 -[ 2322 +{{{[ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки2326 + "period": 0, // Частота трансляции радиометки 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 2954 "deleted": true 2955 2955 } 2956 2956 ] 2332 +}}} 2957 2957 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 -(% class="box infomessage" %) 2961 -((( 2962 -**GET /api/v3/Rfids/{rfidGuid}** 2963 -))) 2336 +GET /api/v3/Rfids/{rfidGuid} 2964 2964 2965 2965 Передаем параметр rfidGuid - идентификатор карты-метки 2966 2966 2967 2967 Ответ: 2968 2968 2969 -[ 2342 +{{{[ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки2346 + "period": 0, // Частота трансляции радиометки 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 2976 "deleted": true 2977 2977 } 2978 2978 ] 2352 +}}} 2979 2979 2980 - 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 2983 -(% class="box successmessage" %) 2984 -((( 2985 -**POST /api/v3/Rfids** 2986 -))) 2356 +POST /api/v3/Rfids 2987 2987 2988 2988 Запрос: 2989 2989 2990 -{ 2360 +{{{{ 2991 2991 "name": "string", 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 2995 "deleted": true 2996 -} 2366 +}}}} 2997 2997 2998 2998 Ответ: 2999 2999 3000 -{ 2370 +{{{{ 3001 3001 "name": "string", 3002 3002 "number": 0, 3003 3003 "period": 0, ... ... @@ -3005,17 +3005,15 @@ 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 3006 "deleted": true 3007 3007 } 2378 +}}} 3008 3008 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 -(% class="box warningmessage" %) 3012 -((( 3013 -**PUT /api/v3/Rfids** 3014 -))) 2382 +PUT /api/v3/Rfids 3015 3015 3016 3016 Запрос: 3017 3017 3018 -{ 2386 +{{{{ 3019 3019 "name": "string", 3020 3020 "number": 0, 3021 3021 "period": 0, ... ... @@ -3022,11 +3022,11 @@ 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 3024 "deleted": true 3025 -} 2393 +}}}} 3026 3026 3027 3027 Ответ: 3028 3028 3029 -{ 2397 +{{{{ 3030 3030 "name": "string", 3031 3031 "number": 0, 3032 3032 "period": 0, ... ... @@ -3034,13 +3034,11 @@ 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 3035 "deleted": true 3036 3036 } 2405 +}}} 3037 3037 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 -(% class="box errormessage" %) 3041 -((( 3042 -**DELETE /api/v3/Rfids/{rfidGuid}** 3043 -))) 2409 +DELETE /api/v3/Rfids/{rfidGuid} 3044 3044 3045 3045 Передаем параметр rfidGuid - идентификатор карты-метки 3046 3046 ... ... @@ -3049,325 +3049,6 @@ 3049 3049 Success 3050 3050 3051 3051 3052 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 - 3054 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3055 - 3056 -(% class="box infomessage" %) 3057 -((( 3058 -**GET /api/v3/Billing/client/balance/{clientId}** 3059 -))) 3060 - 3061 -Параметр запроса: **clientId **- идентификатор клиента. 3062 - 3063 -Ответ: 3064 - 3065 -{ 3066 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3067 - "Balance": 0 3068 -} 3069 - 3070 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3071 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3072 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3073 - 3074 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3075 - 3076 -(% class="box infomessage" %) 3077 -((( 3078 -**GET /api/v3/Billing/client/constraint/{clientId}** 3079 -))) 3080 - 3081 -Параметр запроса: **clientId **- идентификатор клиента. 3082 - 3083 -Ответ: 3084 - 3085 -{ 3086 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3087 - "CalculationType": 0, 3088 - "PermissibleBalance": 0, 3089 - "DefermentDays": 0, 3090 - "SendUiNotifications": true, 3091 - "SendEmailNotifications": true, 3092 - "IsPrivate": true, 3093 -} 3094 - 3095 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3096 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3097 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3098 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3099 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3100 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3101 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3102 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3103 - 3104 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3105 - 3106 -(% class="box infomessage" %) 3107 -((( 3108 -**GET /api/v3/Billing/client/plan/{clientId}** 3109 -))) 3110 - 3111 -Параметры запроса: 3112 - 3113 -**clientId **- идентификатор клиента. 3114 - 3115 -**planId **- идентификатор тарифного плана. 3116 - 3117 -Ответ: 3118 - 3119 -{ 3120 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 - "Plan": { **~/~/ Описание тарифного плана** 3122 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3123 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3124 - "Name": "string", 3125 - "IsArchived": true, 3126 - "Constraint": { 3127 - "CalculationType": 0, 3128 - "PermissibleBalance": 0, 3129 - "DefermentDays": 0 3130 - }, 3131 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3132 - { 3133 - "Feature": "string", 3134 - "IsFactual": true, 3135 - "Limit": 0, 3136 - "Price": 0, 3137 - "PeriodValue": 0, 3138 - "PeriodType": 0 3139 - } 3140 - ] 3141 - }, 3142 - "DebitDate": "2023-10-18T12:46:24.213Z", 3143 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3144 - { 3145 - "Feature": "string", 3146 - "IsEnabled": true, 3147 - "IsPrivate": true, 3148 - "IsFactual": true, 3149 - "Limit": 0, 3150 - "Price": 0, 3151 - "DebitDate": "2023-10-18T12:46:24.213Z", 3152 - "PeriodValue": 0, 3153 - "PeriodType": 0 3154 - } 3155 - ] 3156 -} 3157 - 3158 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3159 -|ClientId|Идентификатор клиента 3160 -|Id|Идентификатор тарифного плана 3161 -|OwnerId|Идентификатор клиента-владельца 3162 -|Name|Наименование тарифного плана 3163 -|IsArchived|Признак, определяющий архивный тарифный план 3164 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3165 -|PermissibleBalance|Допустимый баланс 3166 -|DefermentDays|Отсрочка, количество дней 3167 -|Feature|Код услуги 3168 -|IsEnabled|Признак, определяющий активирована ли услуга 3169 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3170 -|IsFactual|Признак, определяющий расчёт по факту 3171 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3172 -|Price|Цена за единицу. 3173 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3174 -|PeriodValue|Значение периода. 3175 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3176 - 3177 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3178 - 3179 -(% class="box infomessage" %) 3180 -((( 3181 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3182 -))) 3183 - 3184 -Параметр запроса: **clientId **- идентификатор клиента. 3185 - 3186 -Ответ: 3187 - 3188 -[ 3189 - { 3190 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3191 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3192 - "Name": "string", 3193 - "IsArchived": true, 3194 - "Constraint": { 3195 - "CalculationType": 0, 3196 - "PermissibleBalance": 0, 3197 - "DefermentDays": 0 3198 - }, 3199 - "Features": [ 3200 - { 3201 - "Feature": "string", 3202 - "IsFactual": true, 3203 - "Limit": 0, 3204 - "Price": 0, 3205 - "PeriodValue": 0, 3206 - "PeriodType": 0 3207 - } 3208 - ] 3209 - } 3210 -] 3211 - 3212 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3213 -|ClientId|Идентификатор клиента 3214 -|Id|Идентификатор тарифного плана 3215 -|OwnerId|Идентификатор клиента-владельца 3216 -|Name|Наименование тарифного плана 3217 -|IsArchived|Признак, определяющий архивный тарифный план 3218 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3219 -|PermissibleBalance|Допустимый баланс 3220 -|DefermentDays|Отсрочка, количество дней 3221 -|Feature|Код услуги 3222 -|IsFactual|Признак, определяющий расчёт по факту 3223 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3224 -|Price|Цена за единицу. 3225 -|PeriodValue|Значение периода. 3226 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3227 - 3228 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3229 - 3230 -(% class="box infomessage" %) 3231 -((( 3232 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3233 -))) 3234 - 3235 -Параметр запроса: **clientId **- идентификатор клиента. 3236 - 3237 -Ответ: 3238 - 3239 -[ 3240 - { 3241 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3243 - "Name": "string", 3244 - "IsArchived": true, 3245 - "Constraint": { 3246 - "CalculationType": 0, 3247 - "PermissibleBalance": 0, 3248 - "DefermentDays": 0 3249 - }, 3250 - "Features": [ 3251 - { 3252 - "Feature": "string", 3253 - "IsFactual": true, 3254 - "Limit": 0, 3255 - "Price": 0, 3256 - "PeriodValue": 0, 3257 - "PeriodType": 0 3258 - } 3259 - ] 3260 - } 3261 -] 3262 - 3263 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3264 -|ClientId|Идентификатор клиента 3265 -|Id|Идентификатор тарифного плана 3266 -|OwnerId|Идентификатор клиента-владельца 3267 -|Name|Наименование тарифного плана 3268 -|IsArchived|Признак, определяющий архивный тарифный план 3269 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3270 -|PermissibleBalance|Допустимый баланс 3271 -|DefermentDays|Отсрочка, количество дней 3272 -|Feature|Код услуги 3273 -|IsFactual|Признак, определяющий расчёт по факту 3274 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3275 -|Price|Цена за единицу. 3276 -|PeriodValue|Значение периода. 3277 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3278 - 3279 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3280 - 3281 -(% class="box warningmessage" %) 3282 -((( 3283 -**PUT /api/v3/Billing/client/balance** 3284 -))) 3285 - 3286 -Тело запроса: 3287 - 3288 -{ 3289 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3290 - "Balance": 0 3291 -} 3292 - 3293 -Ответ: Success 3294 - 3295 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3296 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 - 3299 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 - 3301 -(% class="box warningmessage" %) 3302 -((( 3303 -**PUT /api/v3/Billing/client/constraint** 3304 -))) 3305 - 3306 -Тело запроса: 3307 - 3308 -{ 3309 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3310 - "CalculationType": 0, 3311 - "PermissibleBalance": 0, 3312 - "DefermentDays": 0, 3313 - "SendUiNotifications": true, 3314 - "SendEmailNotifications": true, 3315 - "IsPrivate": true, 3316 -} 3317 - 3318 -Ответ: Success 3319 - 3320 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3321 -|ClientId|Идентификатор клиента 3322 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3323 -|PermissibleBalance|Допустимый баланс 3324 -|DefermentDays|((( 3325 -Отсрочка, количество дней 3326 -))) 3327 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3328 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3329 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3330 - 3331 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3332 - 3333 -(% class="box warningmessage" %) 3334 -((( 3335 -**PUT /api/v3/Billing/client/plan** 3336 -))) 3337 - 3338 -Тело запроса: 3339 - 3340 -{ 3341 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3342 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3343 - "Features": [ 3344 - { 3345 - "Feature": "string", 3346 - "IsEnabled": true, 3347 - "IsFactual": true, 3348 - "Limit": 0, 3349 - "Price": 0, 3350 - "DebitDate": "2023-10-18T13:26:58.987Z", 3351 - "PeriodValue": 0, 3352 - "PeriodType": 0 3353 - } 3354 - ] 3355 -} 3356 - 3357 -Ответ: Success 3358 - 3359 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 -|ClientId|Идентификатор клиента 3361 -|PlanId|Идентификатор тарифного плана 3362 -|Feature|Код услуги 3363 -|IsEnabled|Признак, определяющий активирована ли услуга 3364 -|IsFactual|Признак, определяющий расчёт по факту 3365 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3366 -|Price|Цена за единицу. 3367 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3368 -|PeriodValue|Значение периода. 3369 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 - 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% 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]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB - Content