Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 106.1 >
edited by Илья Крайнов
on 2023/08/10 09:14
To version < 110.1 >
edited by Илья Крайнов
on 2023/10/18 16:32
>
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" %)**Получение информации об объекте**(%%) ==
... ... @@ -1622,6 +1622,61 @@
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 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1768,7 +1768,7 @@
1768 1768  
1769 1769  (% style="color:#000000" %)Метод запроса: **POST**
1770 1770  
1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
2045 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
1772 1772  
1773 1773  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774 1774  
... ... @@ -2681,7 +2681,6 @@
2681 2681   }
2682 2682  ]
2683 2683  
2684 -
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
2687 2687  (% class="box infomessage" %)
... ... @@ -2733,7 +2733,6 @@
2733 2733   "deleted": true
2734 2734  }
2735 2735  
2736 -
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
2739 2739  (% class="box warningmessage" %)
... ... @@ -2763,7 +2763,6 @@
2763 2763   "deleted": true
2764 2764  }
2765 2765  
2766 -
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
2769 2769  (% class="box errormessage" %)
... ... @@ -2778,6 +2778,310 @@
2778 2778  Success
2779 2779  
2780 2780  
3052 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3053 +
3054 +(% class="wikigeneratedid" %)
3055 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3056 +
3057 +(% class="box infomessage" %)
3058 +(((
3059 +**GET /api/v3/Billing/client/balance/{clientId}**
3060 +)))
3061 +
3062 +Параметр запроса: **clientId **- идентификатор клиента.
3063 +
3064 +Ответ:
3065 +
3066 +{
3067 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3068 + "Balance": 0
3069 +}
3070 +
3071 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3072 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3073 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3074 +
3075 +(% class="wikigeneratedid" %)
3076 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3077 +
3078 +(% class="box infomessage" %)
3079 +(((
3080 +**GET /api/v3/Billing/client/constraint/{clientId}**
3081 +)))
3082 +
3083 +Параметр запроса: **clientId **- идентификатор клиента.
3084 +
3085 +Ответ:
3086 +
3087 +{
3088 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3089 + "CalculationType": 0,
3090 + "PermissibleBalance": 0,
3091 + "DefermentDays": 0,
3092 + "SendUiNotifications": true,
3093 + "SendEmailNotifications": true,
3094 + "IsPrivate": true,
3095 +}
3096 +
3097 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3098 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3099 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3100 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3101 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3102 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3103 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3104 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3105 +
3106 +(% class="wikigeneratedid" %)
3107 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3108 +
3109 +(% class="box infomessage" %)
3110 +(((
3111 +**GET /api/v3/Billing/client/plan/{clientId}**
3112 +)))
3113 +
3114 +Параметры запроса:
3115 +
3116 +**clientId **- идентификатор клиента.
3117 +
3118 +**planId **- идентификатор тарифного плана.
3119 +
3120 +Ответ:
3121 +
3122 +{
3123 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3124 + "Plan": { **~/~/ Описание тарифного плана**
3125 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3126 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3127 + "Name": "string",
3128 + "IsArchived": true,
3129 + "Constraint": {
3130 + "CalculationType": 0,
3131 + "PermissibleBalance": 0,
3132 + "DefermentDays": 0
3133 + },
3134 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3135 + {
3136 + "Feature": "string",
3137 + "IsFactual": true,
3138 + "Limit": 0,
3139 + "Price": 0,
3140 + "PeriodValue": 0,
3141 + "PeriodType": 0
3142 + }
3143 + ]
3144 + },
3145 + "DebitDate": "2023-10-18T12:46:24.213Z",
3146 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3147 + {
3148 + "Feature": "string",
3149 + "IsEnabled": true,
3150 + "IsPrivate": true,
3151 + "IsFactual": true,
3152 + "Limit": 0,
3153 + "Price": 0,
3154 + "DebitDate": "2023-10-18T12:46:24.213Z",
3155 + "PeriodValue": 0,
3156 + "PeriodType": 0
3157 + }
3158 + ]
3159 +}
3160 +
3161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3162 +|ClientId|Идентификатор клиента
3163 +|Id|Идентификатор тарифного плана
3164 +|OwnerId|Идентификатор клиента-владельца
3165 +|Name|Наименование тарифного плана
3166 +|IsArchived|Признак, определяющий архивный тарифный план
3167 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3168 +|PermissibleBalance|Допустимый баланс
3169 +|DefermentDays|Отсрочка, количество дней
3170 +|Feature|Код услуги
3171 +|IsEnabled|Признак, определяющий активирована ли услуга
3172 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3173 +|IsFactual|Признак, определяющий расчёт по факту
3174 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3175 +|Price|Цена за единицу.
3176 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3177 +|PeriodValue|Значение периода.
3178 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3179 +
3180 +(% class="wikigeneratedid" %)
3181 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3182 +
3183 +(% class="box infomessage" %)
3184 +(((
3185 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3186 +)))
3187 +
3188 +Параметр запроса: **clientId **- идентификатор клиента.
3189 +
3190 +Ответ:
3191 +
3192 +[
3193 + {
3194 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3195 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3196 + "Name": "string",
3197 + "IsArchived": true,
3198 + "Constraint": {
3199 + "CalculationType": 0,
3200 + "PermissibleBalance": 0,
3201 + "DefermentDays": 0
3202 + },
3203 + "Features": [
3204 + {
3205 + "Feature": "string",
3206 + "IsFactual": true,
3207 + "Limit": 0,
3208 + "Price": 0,
3209 + "PeriodValue": 0,
3210 + "PeriodType": 0
3211 + }
3212 + ]
3213 + }
3214 +]
3215 +
3216 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3217 +|ClientId|Идентификатор клиента
3218 +|Id|Идентификатор тарифного плана
3219 +|OwnerId|Идентификатор клиента-владельца
3220 +|Name|Наименование тарифного плана
3221 +|IsArchived|Признак, определяющий архивный тарифный план
3222 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3223 +|PermissibleBalance|Допустимый баланс
3224 +|DefermentDays|Отсрочка, количество дней
3225 +|Feature|Код услуги
3226 +|IsFactual|Признак, определяющий расчёт по факту
3227 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3228 +|Price|Цена за единицу.
3229 +|PeriodValue|Значение периода.
3230 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3231 +
3232 +(% class="wikigeneratedid" %)
3233 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3234 +
3235 +(% class="box infomessage" %)
3236 +(((
3237 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3238 +)))
3239 +
3240 +Параметр запроса: **clientId **- идентификатор клиента.
3241 +
3242 +Ответ:
3243 +
3244 +[
3245 + {
3246 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3248 + "Name": "string",
3249 + "IsArchived": true,
3250 + "Constraint": {
3251 + "CalculationType": 0,
3252 + "PermissibleBalance": 0,
3253 + "DefermentDays": 0
3254 + },
3255 + "Features": [
3256 + {
3257 + "Feature": "string",
3258 + "IsFactual": true,
3259 + "Limit": 0,
3260 + "Price": 0,
3261 + "PeriodValue": 0,
3262 + "PeriodType": 0
3263 + }
3264 + ]
3265 + }
3266 +]
3267 +
3268 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3269 +|ClientId|Идентификатор клиента
3270 +|Id|Идентификатор тарифного плана
3271 +|OwnerId|Идентификатор клиента-владельца
3272 +|Name|Наименование тарифного плана
3273 +|IsArchived|Признак, определяющий архивный тарифный план
3274 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3275 +|PermissibleBalance|Допустимый баланс
3276 +|DefermentDays|Отсрочка, количество дней
3277 +|Feature|Код услуги
3278 +|IsFactual|Признак, определяющий расчёт по факту
3279 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3280 +|Price|Цена за единицу.
3281 +|PeriodValue|Значение периода.
3282 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3283 +
3284 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3285 +
3286 +(% class="box warningmessage" %)
3287 +(((
3288 +**PUT /api/v3/Billing/client/constraint**
3289 +)))
3290 +
3291 +Тело запроса:
3292 +
3293 +{
3294 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3295 + "CalculationType": 0,
3296 + "PermissibleBalance": 0,
3297 + "DefermentDays": 0,
3298 + "SendUiNotifications": true,
3299 + "SendEmailNotifications": true,
3300 + "IsPrivate": true,
3301 +}
3302 +
3303 +Ответ: Success
3304 +
3305 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3306 +|ClientId|Идентификатор клиента
3307 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3308 +|PermissibleBalance|Допустимый баланс
3309 +|DefermentDays|(((
3310 +Отсрочка, количество дней
3311 +)))
3312 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3313 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3314 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3315 +
3316 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
3317 +
3318 +(% class="box warningmessage" %)
3319 +(((
3320 +**PUT /api/v3/Billing/client/plan**
3321 +)))
3322 +
3323 +Тело запроса:
3324 +
3325 +{
3326 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3328 + "Features": [
3329 + {
3330 + "Feature": "string",
3331 + "IsEnabled": true,
3332 + "IsFactual": true,
3333 + "Limit": 0,
3334 + "Price": 0,
3335 + "DebitDate": "2023-10-18T13:26:58.987Z",
3336 + "PeriodValue": 0,
3337 + "PeriodType": 0
3338 + }
3339 + ]
3340 +}
3341 +
3342 +Ответ: Success
3343 +
3344 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3345 +|ClientId|Идентификатор клиента
3346 +|Feature|Код услуги
3347 +|IsEnabled|Признак, определяющий активирована ли услуга
3348 +|IsFactual|Признак, определяющий расчёт по факту
3349 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3350 +|Price|Цена за единицу.
3351 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3352 +|PeriodValue|Значение периода.
3353 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3354 +
3355 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% 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 г.