Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 95.1 >
edited by Илья Крайнов
on 2023/06/30 14:47
To version < 112.1 >
edited by Илья Крайнов
on 2023/10/18 17:20
>
Change comment: There is no comment for this version

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" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1823,118 +1823,130 @@
1823 1823  Success
1824 1824  
1825 1825  
1826 -= Раздел: **Водители** =
2361 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
1827 1827  
1828 -Получить список водителей клиента
2363 +== (% 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 -Передается: parentId - ID клиента-родителя
2370 +Передается параметр: parentId - ID клиента-родителя
1833 1833  
1834 1834  Ответ:
1835 1835  
1836 -{{{[
2374 +[
1837 1837   {
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 // Признак удаления
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 ~/~/ Признак удаления
1846 1846   }
1847 -]}}}
2385 +]
1848 1848  
2387 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
1849 1849  
1850 -Получить данные о водителе
2389 +(% class="box infomessage" %)
2390 +(((
2391 +**GET /api/v3/Drivers/{driverGuid}**
2392 +)))
1851 1851  
1852 -GET /api/v3/Drivers/{driverGuid}
2394 +Передается параметр: ID водителя
1853 1853  
1854 -Передается ID водителя
1855 -
1856 1856  Ответ:
1857 1857  
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 // Признак удаления
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 ~/~/ Признак удаления
1867 1867  }
1868 -}}}
1869 1869  
2409 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
1870 1870  
1871 -Добавить водителя
2411 +(% class="box successmessage" %)
2412 +(((
2413 +**POST /api/v3/Drivers**
2414 +)))
1872 1872  
1873 -POST /api/v3/Drivers
2416 +Запрос:
1874 1874  
1875 -Передается:
1876 -
1877 -{{{{
2418 +{
1878 1878   "name": "string",
1879 1879   "description": "string",
1880 - "hiredate": "2023-06-30T09:43:05.949Z",
1881 - "chopdate": "2023-06-30T09:43:05.949Z",
2421 + "hiredate": "2023-06-30T12:50:54.020Z",
2422 + "chopdate": "2023-06-30T12:50:54.020Z",
1882 1882   "exclusive": true,
1883 1883   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1884 1884   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1885 1885   "deleted": true
1886 -}}}}
2427 +}
1887 1887  
1888 1888  Ответ:
1889 1889  
1890 -{{{{
2431 +{
1891 1891   "name": "string",
1892 1892   "description": "string",
1893 - "hiredate": "2023-06-30T09:43:06.014Z",
1894 - "chopdate": "2023-06-30T09:43:06.014Z",
2434 + "hiredate": "2023-06-30T12:50:54.051Z",
2435 + "chopdate": "2023-06-30T12:50:54.051Z",
1895 1895   "exclusive": true,
1896 1896   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1897 1897   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1898 1898   "deleted": true
1899 -}}}}
2440 +}
1900 1900  
1901 1901  
1902 -Редактировать водителя
2443 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
1903 1903  
1904 -PUT /api/v3/Drivers
2445 +(% class="box warningmessage" %)
2446 +(((
2447 +**PUT /api/v3/Drivers**
2448 +)))
1905 1905  
1906 -Передается:
2450 +Запрос:
1907 1907  
1908 -{{{{
2452 +{
1909 1909   "name": "string",
1910 1910   "description": "string",
1911 - "hiredate": "2023-06-30T09:45:41.382Z",
1912 - "chopdate": "2023-06-30T09:45:41.382Z",
2455 + "hiredate": "2023-06-30T12:50:27.910Z",
2456 + "chopdate": "2023-06-30T12:50:27.910Z",
1913 1913   "exclusive": true,
1914 1914   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1915 1915   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1916 1916   "deleted": true
1917 -}}}}
2461 +}
1918 1918  
1919 1919  Ответ:
1920 1920  
1921 -{{{{
2465 +{
1922 1922   "name": "string",
1923 1923   "description": "string",
1924 - "hiredate": "2023-06-30T09:45:41.433Z",
1925 - "chopdate": "2023-06-30T09:45:41.433Z",
2468 + "hiredate": "2023-06-30T12:50:27.929Z",
2469 + "chopdate": "2023-06-30T12:50:27.929Z",
1926 1926   "exclusive": true,
1927 1927   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1928 1928   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1929 1929   "deleted": true
1930 -}}}}
2474 +}
1931 1931  
1932 1932  
1933 -Удалить водителя
2477 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
1934 1934  
1935 -DELETE /api/v3/Drivers/{driverGuid}
2479 +(% class="box errormessage" %)
2480 +(((
2481 +**DELETE /api/v3/Drivers/{driverGuid}**
2482 +)))
1936 1936  
1937 -Передается ID водителя
2484 +Передается параметр: ID водителя
1938 1938  
1939 1939  Ответ:
1940 1940  
... ... @@ -1941,27 +1941,30 @@
1941 1941  Success
1942 1942  
1943 1943  
1944 -= Раздел: **Журнал назначений** =
2491 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
1945 1945  
1946 -**Назначение водителя на объект**
2493 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
1947 1947  
1948 -Получить назначения водителей запросом к водителю
2495 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
1949 1949  
1950 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers
2497 +(% class="box infomessage" %)
2498 +(((
2499 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
2500 +)))
1951 1951  
1952 -Передаем:
2502 +Запрос:
1953 1953  
1954 -{{{{
2504 +{
1955 1955   "Ids": [
1956 1956   "3fa85f64-5717-4562-b3fc-2c963f66afa6"
1957 1957   ],
1958 - "BeginTime": "2023-06-30T09:52:31.196Z",
1959 - "EndTime": "2023-06-30T09:52:31.196Z"
1960 -}}}}
2508 + "BeginTime": "2023-06-30T12:49:04.365Z",
2509 + "EndTime": "2023-06-30T12:49:04.365Z"
2510 +}
1961 1961  
1962 1962  Ответ:
1963 1963  
1964 -{{{[
2514 +[
1965 1965   {
1966 1966   "VehicleId": 0,
1967 1967   "CreateTime": "2023-06-30T09:52:31.240Z",
... ... @@ -1970,26 +1970,29 @@
1970 1970   "BeginTime": "2023-06-30T09:52:31.240Z",
1971 1971   "EndTime": "2023-06-30T09:52:31.240Z"
1972 1972   }
1973 -]}}}
2523 +]
1974 1974  
1975 1975  
1976 -Получить назначения водителей запросом к объекту
2526 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
1977 1977  
1978 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles
2528 +(% class="box infomessage" %)
2529 +(((
2530 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
2531 +)))
1979 1979  
1980 -Передаем:
2533 +Запрос:
1981 1981  
1982 -{{{{
2535 +{
1983 1983   "Ids": [
1984 1984   0
1985 1985   ],
1986 - "BeginTime": "2023-06-30T09:54:01.583Z",
1987 - "EndTime": "2023-06-30T09:54:01.583Z"
1988 -}}}}
2539 + "BeginTime": "2023-06-30T12:48:39.419Z",
2540 + "EndTime": "2023-06-30T12:48:39.419Z"
2541 +}
1989 1989  
1990 1990  Ответ:
1991 1991  
1992 -{{{[
2545 +[
1993 1993   {
1994 1994   "VehicleId": 0,
1995 1995   "CreateTime": "2023-06-30T09:54:01.631Z",
... ... @@ -1998,30 +1998,33 @@
1998 1998   "BeginTime": "2023-06-30T09:54:01.631Z",
1999 1999   "EndTime": "2023-06-30T09:54:01.631Z"
2000 2000   }
2001 -]}}}
2554 +]
2002 2002  
2003 2003  
2004 -Создать назначение водителя на объект
2557 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
2005 2005  
2006 -POST /api/v3/DriversVehiclesAssignments
2559 +(% class="box successmessage" %)
2560 +(((
2561 +**POST /api/v3/DriversVehiclesAssignments**
2562 +)))
2007 2007  
2008 2008  Передается массив назначений
2009 2009  
2010 2010  Запрос:
2011 2011  
2012 -{{{[
2568 +[
2013 2013   {
2014 - "VehicleId": 0, // Идентификатор объекта
2015 - "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения
2016 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2017 - "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения
2018 - "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно.
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" ~/~/ Момент времени окончания назначения. Необязательно.
2019 2019   }
2020 -]}}}
2576 +]
2021 2021  
2022 2022  Ответ:
2023 2023  
2024 -{{{[
2580 +[
2025 2025   {
2026 2026   "VehicleId": 0,
2027 2027   "CreateTime": "2023-06-30T11:04:46.903Z",
... ... @@ -2030,29 +2030,32 @@
2030 2030   "BeginTime": "2023-06-30T11:04:46.903Z",
2031 2031   "EndTime": "2023-06-30T11:04:46.903Z"
2032 2032   }
2033 -]}}}
2589 +]
2034 2034  
2035 2035  
2036 -Изменить назначения водителей на объекты
2592 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
2037 2037  
2038 -PUT /api/v3/DriversVehiclesAssignments
2594 +(% class="box warningmessage" %)
2595 +(((
2596 +**PUT /api/v3/DriversVehiclesAssignments**
2597 +)))
2039 2039  
2040 2040  Запрос:
2041 2041  
2042 -{{{[
2601 +[
2043 2043   {
2044 2044   "VehicleId": 0,
2045 2045   "CreateTime": "2023-06-30T11:14:08.117Z",
2046 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2605 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2047 2047   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2048 2048   "BeginTime": "2023-06-30T11:14:08.117Z",
2049 2049   "EndTime": "2023-06-30T11:14:08.117Z"
2050 2050   }
2051 -]}}}
2610 +]
2052 2052  
2053 2053  Ответ:
2054 2054  
2055 -{{{[
2614 +[
2056 2056   {
2057 2057   "VehicleId": 0,
2058 2058   "CreateTime": "2023-06-30T11:14:53.349Z",
... ... @@ -2061,103 +2061,99 @@
2061 2061   "BeginTime": "2023-06-30T11:14:53.349Z",
2062 2062   "EndTime": "2023-06-30T11:14:53.349Z"
2063 2063   }
2064 -]}}}
2623 +]
2065 2065  
2066 2066  
2067 -Удалить назначения водителей на объекты
2626 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
2068 2068  
2069 -DELETE /api/v3/DriversVehiclesAssignments
2628 +(% class="box errormessage" %)
2629 +(((
2630 +**DELETE /api/v3/DriversVehiclesAssignments**
2631 +)))
2070 2070  
2071 2071  Запрос:
2072 2072  
2073 -{{{[
2074 - {
2075 - "VehicleId": 0,
2076 - "CreateTime": "2023-06-30T11:16:08.341Z",
2077 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2078 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2079 - "BeginTime": "2023-06-30T11:16:08.342Z",
2080 - "EndTime": "2023-06-30T11:16:08.342Z"
2081 - }
2082 -]}}}
2635 +[
2636 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2637 +]
2083 2083  
2084 2084  Ответ:
2085 2085  
2086 -{{{[
2087 - {
2088 - "VehicleId": 0,
2089 - "CreateTime": "2023-06-30T11:16:08.344Z",
2090 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2091 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2092 - "BeginTime": "2023-06-30T11:16:08.344Z",
2093 - "EndTime": "2023-06-30T11:16:08.344Z"
2094 - }
2095 -]}}}
2641 +Success
2096 2096  
2097 2097  
2098 -**Назначение карты-метки водителю**
2644 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
2099 2099  
2100 -Получить назначения меток запросом к водителю
2646 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
2101 2101  
2102 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2648 +(% class="box infomessage" %)
2649 +(((
2650 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
2651 +)))
2103 2103  
2104 2104  Запрос:
2105 2105  
2106 -{{{{
2655 +{
2107 2107   "Ids": [
2108 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы водителей
2657 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2109 2109   ],
2110 - "BeginTime": "2023-06-30T11:19:40.702Z",
2111 - "EndTime": "2023-06-30T11:19:40.702Z"
2112 -}}}}
2659 + "BeginTime": "2023-06-30T12:47:12.162Z",
2660 + "EndTime": "2023-06-30T12:47:12.162Z"
2661 +}
2113 2113  
2114 2114  Ответ:
2115 2115  
2116 -{{{[
2665 +[
2117 2117   {
2118 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2119 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2120 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2667 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2668 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2669 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2121 2121   "BeginTime": "2023-06-30T11:19:40.703Z",
2122 2122   "EndTime": "2023-06-30T11:19:40.703Z"
2123 2123   }
2124 -]}}}
2673 +]
2125 2125  
2126 2126  
2127 -Получить назначения меток запросом к карте-метке
2676 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
2128 2128  
2129 -POST /api/v3/DriversRfidsAssignments/GetByDrivers
2678 +(% class="box infomessage" %)
2679 +(((
2680 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
2681 +)))
2130 2130  
2131 2131  Запрос:
2132 2132  
2133 -{{{{
2685 +{
2134 2134   "Ids": [
2135 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы карт-меток
2687 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2136 2136   ],
2137 - "BeginTime": "2023-06-30T11:19:40.702Z",
2138 - "EndTime": "2023-06-30T11:19:40.702Z"
2139 -}}}}
2689 + "BeginTime": "2023-06-30T12:47:12.162Z",
2690 + "EndTime": "2023-06-30T12:47:12.162Z"
2691 +}
2140 2140  
2141 2141  Ответ:
2142 2142  
2143 -{{{[
2695 +[
2144 2144   {
2145 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки
2146 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения
2147 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя
2697 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
2698 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
2699 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
2148 2148   "BeginTime": "2023-06-30T11:19:40.703Z",
2149 2149   "EndTime": "2023-06-30T11:19:40.703Z"
2150 2150   }
2151 -]}}}
2703 +]
2152 2152  
2153 2153  
2154 -Добавить назначения меток на водителей.
2706 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
2155 2155  
2156 -POST /api/v3/DriversRfidsAssignments
2708 +(% class="box successmessage" %)
2709 +(((
2710 +**POST /api/v3/DriversRfidsAssignments**
2711 +)))
2157 2157  
2158 2158  Запрос:
2159 2159  
2160 -{{{[
2715 +[
2161 2161   {
2162 2162   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2163 2163   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2164,11 +2164,11 @@
2164 2164   "BeginTime": "2023-06-30T11:27:08.635Z",
2165 2165   "EndTime": "2023-06-30T11:27:08.635Z"
2166 2166   }
2167 -]}}}
2722 +]
2168 2168  
2169 2169  Ответ:
2170 2170  
2171 -{{{[
2726 +[
2172 2172   {
2173 2173   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2174 2174   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2176,16 +2176,19 @@
2176 2176   "BeginTime": "2023-06-30T11:27:08.677Z",
2177 2177   "EndTime": "2023-06-30T11:27:08.677Z"
2178 2178   }
2179 -]}}}
2734 +]
2180 2180  
2181 2181  
2182 -Изменить назначения меток на водителей
2737 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
2183 2183  
2184 -PUT /api/v3/DriversRfidsAssignments
2739 +(% class="box warningmessage" %)
2740 +(((
2741 +**PUT /api/v3/DriversRfidsAssignments**
2742 +)))
2185 2185  
2186 2186  Запрос:
2187 2187  
2188 -{{{[
2746 +[
2189 2189   {
2190 2190   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2191 2191   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2193,11 +2193,11 @@
2193 2193   "BeginTime": "2023-06-30T11:28:43.330Z",
2194 2194   "EndTime": "2023-06-30T11:28:43.330Z"
2195 2195   }
2196 -]}}}
2754 +]
2197 2197  
2198 2198  Ответ:
2199 2199  
2200 -{{{[
2758 +[
2201 2201   {
2202 2202   "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2203 2203   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -2205,99 +2205,241 @@
2205 2205   "BeginTime": "2023-06-30T11:28:43.331Z",
2206 2206   "EndTime": "2023-06-30T11:28:43.331Z"
2207 2207   }
2208 -]}}}
2766 +]
2209 2209  
2210 2210  
2211 -Удалить назначения меток на водителей
2769 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
2212 2212  
2213 -DELETE /api/v3/DriversRfidsAssignments
2771 +(% class="box errormessage" %)
2772 +(((
2773 +**DELETE /api/v3/DriversRfidsAssignments**
2774 +)))
2214 2214  
2215 2215  Запрос:
2216 2216  
2217 -{{{[
2778 +[
2779 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2780 +]
2781 +
2782 +Ответ:
2783 +
2784 +Success
2785 +
2786 +
2787 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
2788 +
2789 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
2790 +
2791 +(% class="box infomessage" %)
2792 +(((
2793 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
2794 +)))
2795 +
2796 +Запрос:
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 +}
2805 +
2806 +Ответ:
2807 +
2808 +[
2218 2218   {
2219 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2810 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2220 2220   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2221 2221   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2222 - "BeginTime": "2023-06-30T11:28:43.330Z",
2223 - "EndTime": "2023-06-30T11:28:43.330Z"
2813 + "BeginTime": "2023-06-30T11:58:04.695Z",
2814 + "EndTime": "2023-06-30T11:58:04.695Z"
2224 2224   }
2225 -]}}}
2816 +]
2226 2226  
2818 +
2819 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
2820 +
2821 +(% class="box infomessage" %)
2822 +(((
2823 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
2824 +)))
2825 +
2826 +Запрос:
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 +}
2835 +
2227 2227  Ответ:
2228 2228  
2229 -{{{[
2838 +[
2230 2230   {
2231 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2840 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2232 2232   "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2233 2233   "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2234 - "BeginTime": "2023-06-30T11:28:43.331Z",
2235 - "EndTime": "2023-06-30T11:28:43.331Z"
2843 + "BeginTime": "2023-06-30T11:58:04.695Z",
2844 + "EndTime": "2023-06-30T11:58:04.695Z"
2236 2236   }
2237 -]}}}
2846 +]
2238 2238  
2239 2239  
2240 -= Раздел: **Карты-метки** =
2849 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
2241 2241  
2242 -Получить список карт-меток определенного клиента
2851 +(% class="box successmessage" %)
2852 +(((
2853 +**POST /api/v3/DriversFuelCardsAssignments**
2854 +)))
2243 2243  
2244 -POST /api/v3/Rfids/find
2856 +Запрос:
2245 2245  
2858 +[
2859 + {
2860 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2861 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2862 + "BeginTime": "2023-06-30T12:09:53.175Z",
2863 + "EndTime": "2023-06-30T12:09:53.175Z"
2864 + }
2865 +]
2866 +
2867 +Ответ:
2868 +
2869 +[
2870 + {
2871 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2872 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2873 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2874 + "BeginTime": "2023-06-30T12:09:53.201Z",
2875 + "EndTime": "2023-06-30T12:09:53.201Z"
2876 + }
2877 +]
2878 +
2879 +
2880 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
2881 +
2882 +(% class="box warningmessage" %)
2883 +(((
2884 +**PUT /api/v3/DriversFuelCardsAssignments**
2885 +)))
2886 +
2246 2246  Запрос:
2247 2247  
2248 -{{{{
2889 +[
2890 + {
2891 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2892 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2893 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2894 + "BeginTime": "2023-06-30T12:09:53.201Z",
2895 + "EndTime": "2023-06-30T12:09:53.201Z"
2896 + }
2897 +]
2898 +
2899 +Ответ:
2900 +
2901 +[
2902 + {
2903 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2904 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2905 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2906 + "BeginTime": "2023-06-30T12:09:53.201Z",
2907 + "EndTime": "2023-06-30T12:09:53.201Z"
2908 + }
2909 +]
2910 +
2911 +
2912 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
2913 +
2914 +(% class="box errormessage" %)
2915 +(((
2916 +**DELETE /api/v3/DriversFuelCardsAssignments**
2917 +)))
2918 +
2919 +Запрос:
2920 +
2921 +[
2922 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2923 +]
2924 +
2925 +Ответ:
2926 +
2927 +Success
2928 +
2929 +
2930 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2931 +
2932 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
2933 +
2934 +(% class="box infomessage" %)
2935 +(((
2936 +**POST /api/v3/Rfids/find**
2937 +)))
2938 +
2939 +Запрос:
2940 +
2941 +{
2249 2249   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2250 -}}}}
2943 +}
2251 2251  
2252 2252  Ответ:
2253 2253  
2254 -{{{[
2947 +[
2255 2255   {
2256 2256   "name": "string",
2257 2257   "number": 0,
2258 - "period": 0, // Частота трансляции радиометки
2951 + "period": 0, ~/~/ Частота трансляции радиометки
2259 2259   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2260 2260   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2261 2261   "deleted": true
2262 2262   }
2263 -]}}}
2956 +]
2264 2264  
2958 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2265 2265  
2266 -Получить данные карты-метки
2960 +(% class="box infomessage" %)
2961 +(((
2962 +**GET /api/v3/Rfids/{rfidGuid}**
2963 +)))
2267 2267  
2268 -GET /api/v3/Rfids/{rfidGuid}
2269 -
2270 2270  Передаем параметр rfidGuid - идентификатор карты-метки
2271 2271  
2272 2272  Ответ:
2273 2273  
2274 -{{{{
2275 - "name": "string",
2276 - "number": 0,
2277 - "period": 0,
2278 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2279 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2280 - "deleted": true
2281 -}}}}
2969 +[
2970 + {
2971 + "name": "string",
2972 + "number": 0,
2973 + "period": 0, ~/~/ Частота трансляции радиометки
2974 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2975 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2976 + "deleted": true
2977 + }
2978 +]
2282 2282  
2283 2283  
2284 -Добавить карту-метку
2981 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2285 2285  
2286 -POST /api/v3/Rfids
2983 +(% class="box successmessage" %)
2984 +(((
2985 +**POST /api/v3/Rfids**
2986 +)))
2287 2287  
2288 2288  Запрос:
2289 2289  
2290 -{{{{
2990 +{
2291 2291   "name": "string",
2292 2292   "number": 0,
2293 2293   "period": 0,
2294 2294   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2295 2295   "deleted": true
2296 -}}}}
2996 +}
2297 2297  
2298 2298  Ответ:
2299 2299  
2300 -{{{{
3000 +{
2301 2301   "name": "string",
2302 2302   "number": 0,
2303 2303   "period": 0,
... ... @@ -2304,16 +2304,18 @@
2304 2304   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2305 2305   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2306 2306   "deleted": true
2307 -}}}}
3007 +}
2308 2308  
3009 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2309 2309  
2310 -Редактировать карту-метку
3011 +(% class="box warningmessage" %)
3012 +(((
3013 +**PUT /api/v3/Rfids**
3014 +)))
2311 2311  
2312 -PUT /api/v3/Rfids
2313 -
2314 2314  Запрос:
2315 2315  
2316 -{{{{
3018 +{
2317 2317   "name": "string",
2318 2318   "number": 0,
2319 2319   "period": 0,
... ... @@ -2320,11 +2320,11 @@
2320 2320   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2321 2321   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2322 2322   "deleted": true
2323 -}}}}
3025 +}
2324 2324  
2325 2325  Ответ:
2326 2326  
2327 -{{{{
3029 +{
2328 2328   "name": "string",
2329 2329   "number": 0,
2330 2330   "period": 0,
... ... @@ -2331,13 +2331,15 @@
2331 2331   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2332 2332   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2333 2333   "deleted": true
2334 -}}}}
3036 +}
2335 2335  
3038 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2336 2336  
2337 -Удалить карту-метку
3040 +(% class="box errormessage" %)
3041 +(((
3042 +**DELETE /api/v3/Rfids/{rfidGuid}**
3043 +)))
2338 2338  
2339 -DELETE /api/v3/Rfids/{rfidGuid}
2340 -
2341 2341  Передаем параметр rfidGuid - идентификатор карты-метки
2342 2342  
2343 2343  Ответ:
... ... @@ -2345,8 +2345,325 @@
2345 2345  Success
2346 2346  
2347 2347  
3052 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
2348 2348  
3054 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
2349 2349  
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 +
2350 2350  (% class="box" lang="en-US" style="text-align: center;" %)
2351 2351  (((
2352 2352  (% 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]] **

Меню

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