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,6 +2955,7 @@ 2955 2955 } 2956 2956 ] 2957 2957 2958 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -3006,6 +3006,7 @@ 3006 3006 "deleted": true 3007 3007 } 3008 3008 3010 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3035,6 +3035,7 @@ 3035 3035 "deleted": true 3036 3036 } 3037 3037 3040 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3049,325 +3049,6 @@ 3049 3049 Success 3050 3050 3051 3051 3052 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 - 3054 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3055 - 3056 -(% class="box infomessage" %) 3057 -((( 3058 -**GET /api/v3/Billing/client/balance/{clientId}** 3059 -))) 3060 - 3061 -Параметр запроса: **clientId **- идентификатор клиента. 3062 - 3063 -Ответ: 3064 - 3065 -{ 3066 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3067 - "Balance": 0 3068 -} 3069 - 3070 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3071 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3072 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3073 - 3074 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3075 - 3076 -(% class="box infomessage" %) 3077 -((( 3078 -**GET /api/v3/Billing/client/constraint/{clientId}** 3079 -))) 3080 - 3081 -Параметр запроса: **clientId **- идентификатор клиента. 3082 - 3083 -Ответ: 3084 - 3085 -{ 3086 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3087 - "CalculationType": 0, 3088 - "PermissibleBalance": 0, 3089 - "DefermentDays": 0, 3090 - "SendUiNotifications": true, 3091 - "SendEmailNotifications": true, 3092 - "IsPrivate": true, 3093 -} 3094 - 3095 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3096 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3097 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3098 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3099 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3100 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3101 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3102 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3103 - 3104 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3105 - 3106 -(% class="box infomessage" %) 3107 -((( 3108 -**GET /api/v3/Billing/client/plan/{clientId}** 3109 -))) 3110 - 3111 -Параметры запроса: 3112 - 3113 -**clientId **- идентификатор клиента. 3114 - 3115 -**planId **- идентификатор тарифного плана. 3116 - 3117 -Ответ: 3118 - 3119 -{ 3120 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3121 - "Plan": { **~/~/ Описание тарифного плана** 3122 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3123 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3124 - "Name": "string", 3125 - "IsArchived": true, 3126 - "Constraint": { 3127 - "CalculationType": 0, 3128 - "PermissibleBalance": 0, 3129 - "DefermentDays": 0 3130 - }, 3131 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3132 - { 3133 - "Feature": "string", 3134 - "IsFactual": true, 3135 - "Limit": 0, 3136 - "Price": 0, 3137 - "PeriodValue": 0, 3138 - "PeriodType": 0 3139 - } 3140 - ] 3141 - }, 3142 - "DebitDate": "2023-10-18T12:46:24.213Z", 3143 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3144 - { 3145 - "Feature": "string", 3146 - "IsEnabled": true, 3147 - "IsPrivate": true, 3148 - "IsFactual": true, 3149 - "Limit": 0, 3150 - "Price": 0, 3151 - "DebitDate": "2023-10-18T12:46:24.213Z", 3152 - "PeriodValue": 0, 3153 - "PeriodType": 0 3154 - } 3155 - ] 3156 -} 3157 - 3158 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3159 -|ClientId|Идентификатор клиента 3160 -|Id|Идентификатор тарифного плана 3161 -|OwnerId|Идентификатор клиента-владельца 3162 -|Name|Наименование тарифного плана 3163 -|IsArchived|Признак, определяющий архивный тарифный план 3164 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3165 -|PermissibleBalance|Допустимый баланс 3166 -|DefermentDays|Отсрочка, количество дней 3167 -|Feature|Код услуги 3168 -|IsEnabled|Признак, определяющий активирована ли услуга 3169 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3170 -|IsFactual|Признак, определяющий расчёт по факту 3171 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3172 -|Price|Цена за единицу. 3173 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3174 -|PeriodValue|Значение периода. 3175 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3176 - 3177 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3178 - 3179 -(% class="box infomessage" %) 3180 -((( 3181 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3182 -))) 3183 - 3184 -Параметр запроса: **clientId **- идентификатор клиента. 3185 - 3186 -Ответ: 3187 - 3188 -[ 3189 - { 3190 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3191 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3192 - "Name": "string", 3193 - "IsArchived": true, 3194 - "Constraint": { 3195 - "CalculationType": 0, 3196 - "PermissibleBalance": 0, 3197 - "DefermentDays": 0 3198 - }, 3199 - "Features": [ 3200 - { 3201 - "Feature": "string", 3202 - "IsFactual": true, 3203 - "Limit": 0, 3204 - "Price": 0, 3205 - "PeriodValue": 0, 3206 - "PeriodType": 0 3207 - } 3208 - ] 3209 - } 3210 -] 3211 - 3212 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3213 -|ClientId|Идентификатор клиента 3214 -|Id|Идентификатор тарифного плана 3215 -|OwnerId|Идентификатор клиента-владельца 3216 -|Name|Наименование тарифного плана 3217 -|IsArchived|Признак, определяющий архивный тарифный план 3218 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3219 -|PermissibleBalance|Допустимый баланс 3220 -|DefermentDays|Отсрочка, количество дней 3221 -|Feature|Код услуги 3222 -|IsFactual|Признак, определяющий расчёт по факту 3223 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3224 -|Price|Цена за единицу. 3225 -|PeriodValue|Значение периода. 3226 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3227 - 3228 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3229 - 3230 -(% class="box infomessage" %) 3231 -((( 3232 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3233 -))) 3234 - 3235 -Параметр запроса: **clientId **- идентификатор клиента. 3236 - 3237 -Ответ: 3238 - 3239 -[ 3240 - { 3241 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3243 - "Name": "string", 3244 - "IsArchived": true, 3245 - "Constraint": { 3246 - "CalculationType": 0, 3247 - "PermissibleBalance": 0, 3248 - "DefermentDays": 0 3249 - }, 3250 - "Features": [ 3251 - { 3252 - "Feature": "string", 3253 - "IsFactual": true, 3254 - "Limit": 0, 3255 - "Price": 0, 3256 - "PeriodValue": 0, 3257 - "PeriodType": 0 3258 - } 3259 - ] 3260 - } 3261 -] 3262 - 3263 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3264 -|ClientId|Идентификатор клиента 3265 -|Id|Идентификатор тарифного плана 3266 -|OwnerId|Идентификатор клиента-владельца 3267 -|Name|Наименование тарифного плана 3268 -|IsArchived|Признак, определяющий архивный тарифный план 3269 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3270 -|PermissibleBalance|Допустимый баланс 3271 -|DefermentDays|Отсрочка, количество дней 3272 -|Feature|Код услуги 3273 -|IsFactual|Признак, определяющий расчёт по факту 3274 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3275 -|Price|Цена за единицу. 3276 -|PeriodValue|Значение периода. 3277 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3278 - 3279 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3280 - 3281 -(% class="box warningmessage" %) 3282 -((( 3283 -**PUT /api/v3/Billing/client/balance** 3284 -))) 3285 - 3286 -Тело запроса: 3287 - 3288 -{ 3289 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3290 - "Balance": 0 3291 -} 3292 - 3293 -Ответ: Success 3294 - 3295 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3296 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 - 3299 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 - 3301 -(% class="box warningmessage" %) 3302 -((( 3303 -**PUT /api/v3/Billing/client/constraint** 3304 -))) 3305 - 3306 -Тело запроса: 3307 - 3308 -{ 3309 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3310 - "CalculationType": 0, 3311 - "PermissibleBalance": 0, 3312 - "DefermentDays": 0, 3313 - "SendUiNotifications": true, 3314 - "SendEmailNotifications": true, 3315 - "IsPrivate": true, 3316 -} 3317 - 3318 -Ответ: Success 3319 - 3320 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3321 -|ClientId|Идентификатор клиента 3322 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3323 -|PermissibleBalance|Допустимый баланс 3324 -|DefermentDays|((( 3325 -Отсрочка, количество дней 3326 -))) 3327 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3328 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3329 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3330 - 3331 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3332 - 3333 -(% class="box warningmessage" %) 3334 -((( 3335 -**PUT /api/v3/Billing/client/plan** 3336 -))) 3337 - 3338 -Тело запроса: 3339 - 3340 -{ 3341 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3342 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3343 - "Features": [ 3344 - { 3345 - "Feature": "string", 3346 - "IsEnabled": true, 3347 - "IsFactual": true, 3348 - "Limit": 0, 3349 - "Price": 0, 3350 - "DebitDate": "2023-10-18T13:26:58.987Z", 3351 - "PeriodValue": 0, 3352 - "PeriodType": 0 3353 - } 3354 - ] 3355 -} 3356 - 3357 -Ответ: Success 3358 - 3359 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 -|ClientId|Идентификатор клиента 3361 -|PlanId|Идентификатор тарифного плана 3362 -|Feature|Код услуги 3363 -|IsEnabled|Признак, определяющий активирована ли услуга 3364 -|IsFactual|Признак, определяющий расчёт по факту 3365 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3366 -|Price|Цена за единицу. 3367 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3368 -|PeriodValue|Значение периода. 3369 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 - 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **