Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -2955,7 +2955,6 @@ 2955 2955 } 2956 2956 ] 2957 2957 2958 - 2959 2959 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2960 2960 2961 2961 (% class="box infomessage" %) ... ... @@ -3007,7 +3007,6 @@ 3007 3007 "deleted": true 3008 3008 } 3009 3009 3010 - 3011 3011 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3012 3012 3013 3013 (% class="box warningmessage" %) ... ... @@ -3037,7 +3037,6 @@ 3037 3037 "deleted": true 3038 3038 } 3039 3039 3040 - 3041 3041 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3042 3042 3043 3043 (% class="box errormessage" %) ... ... @@ -3052,6 +3052,310 @@ 3052 3052 Success 3053 3053 3054 3054 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 + 3055 3055 (% class="box" lang="en-US" style="text-align: center;" %) 3056 3056 ((( 3057 3057 (% 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]] **