<
From version < 99.1 >
edited by Илья Крайнов
on 2023/06/30 15:56
To version < 113.1 >
edited by Илья Крайнов
on 2023/10/20 12:44
>
Change comment: Загрузить новое вложение image-20231020124453-1.png

Summary

Details

Icon Page properties
Content
... ... @@ -682,6 +682,225 @@
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 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
... ... @@ -1255,7 +1255,7 @@
1255 1255  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1256 1256  
1257 1257  (% style="color:#000000" %){
1258 -
1477 + "vehicleId": , ~/~/ ID объекта
1259 1259   "parentId": "" , ~/~/ ID клиента
1260 1260   "name": "" , ~/~/ имя ТС
1261 1261   "imei": "" , ~/~/ IMEI
... ... @@ -1622,6 +1622,322 @@
1622 1622   }
1623 1623  ]
1624 1624  
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 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1827,7 +1827,10 @@
1827 1827  
1828 1828  == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
1829 1829  
1830 -POST /api/v3/Drivers/find
2365 +(% class="box infomessage" %)
2366 +(((
2367 +**POST /api/v3/Drivers/find**
2368 +)))
1831 1831  
1832 1832  Передается параметр: parentId - ID клиента-родителя
1833 1833  
... ... @@ -1848,7 +1848,10 @@
1848 1848  
1849 1849  == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1850 1850  
1851 -GET /api/v3/Drivers/{driverGuid}
2389 +(% class="box infomessage" %)
2390 +(((
2391 +**GET /api/v3/Drivers/{driverGuid}**
2392 +)))
1852 1852  
1853 1853  Передается параметр: ID водителя
1854 1854  
... ... @@ -1867,7 +1867,10 @@
1867 1867  
1868 1868  == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
1869 1869  
1870 -POST /api/v3/Drivers
2411 +(% class="box successmessage" %)
2412 +(((
2413 +**POST /api/v3/Drivers**
2414 +)))
1871 1871  
1872 1872  Запрос:
1873 1873  
... ... @@ -1898,7 +1898,10 @@
1898 1898  
1899 1899  == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1900 1900  
1901 -PUT /api/v3/Drivers
2445 +(% class="box warningmessage" %)
2446 +(((
2447 +**PUT /api/v3/Drivers**
2448 +)))
1902 1902  
1903 1903  Запрос:
1904 1904  
... ... @@ -1929,7 +1929,10 @@
1929 1929  
1930 1930  == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
1931 1931  
1932 -DELETE /api/v3/Drivers/{driverGuid}
2479 +(% class="box errormessage" %)
2480 +(((
2481 +**DELETE /api/v3/Drivers/{driverGuid}**
2482 +)))
1933 1933  
1934 1934  Передается параметр: ID водителя
1935 1935  
... ... @@ -1944,7 +1944,10 @@
1944 1944  
1945 1945  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1946 1946  
1947 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers
2497 +(% class="box infomessage" %)
2498 +(((
2499 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2500 +)))
1948 1948  
1949 1949  Запрос:
1950 1950  
... ... @@ -1972,7 +1972,10 @@
1972 1972  
1973 1973  === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1974 1974  
1975 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles
2528 +(% class="box infomessage" %)
2529 +(((
2530 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2531 +)))
1976 1976  
1977 1977  Запрос:
1978 1978  
... ... @@ -2000,7 +2000,10 @@
2000 2000  
2001 2001  === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2002 2002  
2003 -POST /api/v3/DriversVehiclesAssignments
2559 +(% class="box successmessage" %)
2560 +(((
2561 +**POST /api/v3/DriversVehiclesAssignments**
2562 +)))
2004 2004  
2005 2005  Передается массив назначений
2006 2006  
... ... @@ -2032,7 +2032,10 @@
2032 2032  
2033 2033  === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2034 2034  
2035 -PUT /api/v3/DriversVehiclesAssignments
2594 +(% class="box warningmessage" %)
2595 +(((
2596 +**PUT /api/v3/DriversVehiclesAssignments**
2597 +)))
2036 2036  
2037 2037  Запрос:
2038 2038  
... ... @@ -2063,33 +2063,20 @@
2063 2063  
2064 2064  === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2065 2065  
2066 -DELETE /api/v3/DriversVehiclesAssignments
2628 +(% class="box errormessage" %)
2629 +(((
2630 +**DELETE /api/v3/DriversVehiclesAssignments**
2631 +)))
2067 2067  
2068 2068  Запрос:
2069 2069  
2070 2070  [
2071 - {
2072 - "VehicleId": 0,
2073 - "CreateTime": "2023-06-30T11:16:08.341Z",
2074 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2075 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2076 - "BeginTime": "2023-06-30T11:16:08.342Z",
2077 - "EndTime": "2023-06-30T11:16:08.342Z"
2078 - }
2636 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2079 2079  ]
2080 2080  
2081 2081  Ответ:
2082 2082  
2083 -[
2084 - {
2085 - "VehicleId": 0,
2086 - "CreateTime": "2023-06-30T11:16:08.344Z",
2087 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2088 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2089 - "BeginTime": "2023-06-30T11:16:08.344Z",
2090 - "EndTime": "2023-06-30T11:16:08.344Z"
2091 - }
2092 -]
2641 +Success
2093 2093  
2094 2094  
2095 2095  == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
... ... @@ -2096,7 +2096,10 @@
2096 2096  
2097 2097  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2098 2098  
2099 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2648 +(% class="box infomessage" %)
2649 +(((
2650 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2651 +)))
2100 2100  
2101 2101  Запрос:
2102 2102  
... ... @@ -2123,7 +2123,10 @@
2123 2123  
2124 2124  === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2125 2125  
2126 -POST /api/v3/DriversRfidsAssignments/GetByRfids
2678 +(% class="box infomessage" %)
2679 +(((
2680 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2681 +)))
2127 2127  
2128 2128  Запрос:
2129 2129  
... ... @@ -2150,7 +2150,10 @@
2150 2150  
2151 2151  === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2152 2152  
2153 -POST /api/v3/DriversRfidsAssignments
2708 +(% class="box successmessage" %)
2709 +(((
2710 +**POST /api/v3/DriversRfidsAssignments**
2711 +)))
2154 2154  
2155 2155  Запрос:
2156 2156  
... ... @@ -2178,7 +2178,10 @@
2178 2178  
2179 2179  === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2180 2180  
2181 -PUT /api/v3/DriversRfidsAssignments
2739 +(% class="box warningmessage" %)
2740 +(((
2741 +**PUT /api/v3/DriversRfidsAssignments**
2742 +)))
2182 2182  
2183 2183  Запрос:
2184 2184  
... ... @@ -2207,31 +2207,20 @@
2207 2207  
2208 2208  === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2209 2209  
2210 -DELETE /api/v3/DriversRfidsAssignments
2771 +(% class="box errormessage" %)
2772 +(((
2773 +**DELETE /api/v3/DriversRfidsAssignments**
2774 +)))
2211 2211  
2212 2212  Запрос:
2213 2213  
2214 2214  [
2215 - {
2216 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2217 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2218 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2219 - "BeginTime": "2023-06-30T11:28:43.330Z",
2220 - "EndTime": "2023-06-30T11:28:43.330Z"
2221 - }
2779 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2222 2222  ]
2223 2223  
2224 2224  Ответ:
2225 2225  
2226 -[
2227 - {
2228 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2229 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2230 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2231 - "BeginTime": "2023-06-30T11:28:43.331Z",
2232 - "EndTime": "2023-06-30T11:28:43.331Z"
2233 - }
2234 -]
2784 +Success
2235 2235  
2236 2236  
2237 2237  == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
... ... @@ -2238,7 +2238,10 @@
2238 2238  
2239 2239  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2240 2240  
2241 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers
2791 +(% class="box infomessage" %)
2792 +(((
2793 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2794 +)))
2242 2242  
2243 2243  Запрос:
2244 2244  
... ... @@ -2265,7 +2265,10 @@
2265 2265  
2266 2266  === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2267 2267  
2268 -POST /api/v3/DriversFuelCardsAssignments/GetByCards
2821 +(% class="box infomessage" %)
2822 +(((
2823 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2824 +)))
2269 2269  
2270 2270  Запрос:
2271 2271  
... ... @@ -2292,7 +2292,10 @@
2292 2292  
2293 2293  === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2294 2294  
2295 -POST /api/v3/DriversFuelCardsAssignments
2851 +(% class="box successmessage" %)
2852 +(((
2853 +**POST /api/v3/DriversFuelCardsAssignments**
2854 +)))
2296 2296  
2297 2297  Запрос:
2298 2298  
... ... @@ -2320,7 +2320,10 @@
2320 2320  
2321 2321  === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2322 2322  
2323 -PUT /api/v3/DriversFuelCardsAssignments
2882 +(% class="box warningmessage" %)
2883 +(((
2884 +**PUT /api/v3/DriversFuelCardsAssignments**
2885 +)))
2324 2324  
2325 2325  Запрос:
2326 2326  
... ... @@ -2327,9 +2327,10 @@
2327 2327  [
2328 2328   {
2329 2329   "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2892 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2330 2330   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2331 - "BeginTime": "2023-06-30T12:09:53.175Z",
2332 - "EndTime": "2023-06-30T12:09:53.175Z"
2894 + "BeginTime": "2023-06-30T12:09:53.201Z",
2895 + "EndTime": "2023-06-30T12:09:53.201Z"
2333 2333   }
2334 2334  ]
2335 2335  
... ... @@ -2348,30 +2348,20 @@
2348 2348  
2349 2349  === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2350 2350  
2351 -DELETE /api/v3/DriversFuelCardsAssignments
2914 +(% class="box errormessage" %)
2915 +(((
2916 +**DELETE /api/v3/DriversFuelCardsAssignments**
2917 +)))
2352 2352  
2353 2353  Запрос:
2354 2354  
2355 2355  [
2356 - {
2357 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2358 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2359 - "BeginTime": "2023-06-30T12:09:53.175Z",
2360 - "EndTime": "2023-06-30T12:09:53.175Z"
2361 - }
2922 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2362 2362  ]
2363 2363  
2364 2364  Ответ:
2365 2365  
2366 -[
2367 - {
2368 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2369 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2370 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2371 - "BeginTime": "2023-06-30T12:09:53.201Z",
2372 - "EndTime": "2023-06-30T12:09:53.201Z"
2373 - }
2374 -]
2927 +Success
2375 2375  
2376 2376  
2377 2377  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
... ... @@ -2378,7 +2378,10 @@
2378 2378  
2379 2379  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2380 2380  
2381 -POST /api/v3/Rfids/find
2934 +(% class="box infomessage" %)
2935 +(((
2936 +**POST /api/v3/Rfids/find**
2937 +)))
2382 2382  
2383 2383  Запрос:
2384 2384  
... ... @@ -2399,10 +2399,12 @@
2399 2399   }
2400 2400  ]
2401 2401  
2402 -
2403 2403  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2404 2404  
2405 -GET /api/v3/Rfids/{rfidGuid}
2960 +(% class="box infomessage" %)
2961 +(((
2962 +**GET /api/v3/Rfids/{rfidGuid}**
2963 +)))
2406 2406  
2407 2407  Передаем параметр rfidGuid - идентификатор карты-метки
2408 2408  
... ... @@ -2422,7 +2422,10 @@
2422 2422  
2423 2423  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2424 2424  
2425 -POST /api/v3/Rfids
2983 +(% class="box successmessage" %)
2984 +(((
2985 +**POST /api/v3/Rfids**
2986 +)))
2426 2426  
2427 2427  Запрос:
2428 2428  
... ... @@ -2445,10 +2445,12 @@
2445 2445   "deleted": true
2446 2446  }
2447 2447  
2448 -
2449 2449  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2450 2450  
2451 -PUT /api/v3/Rfids
3011 +(% class="box warningmessage" %)
3012 +(((
3013 +**PUT /api/v3/Rfids**
3014 +)))
2452 2452  
2453 2453  Запрос:
2454 2454  
... ... @@ -2472,10 +2472,12 @@
2472 2472   "deleted": true
2473 2473  }
2474 2474  
2475 -
2476 2476  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2477 2477  
3040 +(% class="box errormessage" %)
3041 +(((
2478 2478  **DELETE /api/v3/Rfids/{rfidGuid}**
3043 +)))
2479 2479  
2480 2480  Передаем параметр rfidGuid - идентификатор карты-метки
2481 2481  
... ... @@ -2484,6 +2484,325 @@
2484 2484  Success
2485 2485  
2486 2486  
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 +
2487 2487  (% class="box" lang="en-US" style="text-align: center;" %)
2488 2488  (((
2489 2489  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.