|
|
|
|
check_app_compat
The function checks applications compatibility in Plesk and Virtuozzo Container hosting plans.
Parameters:
|
Hosting plan series key |
|
The list of application templates IDs. |
Returns: result => 1 on success or Fault
SOAP Faults codes:
|
Hosting plan passed as an argument does not support an application. |
|
Application(s) passed are incompatible with each other. |
check_license_compat
The function checks licenses compatibility in hosting plans.
Parameters:
|
Hosting plan series key |
|
The list of licenses IDs |
Returns: result => 1 on success or Fault
SOAP Faults codes:
|
Hosting plan does not support at least one license |
|
Base licenses specified are incompatible. |
|
No base license has been specified for an add-on license. |
get_extended_plan_info
The function returns extended information about a hosting plan. Extended information is all the data not shown in hosting plans listing.
Parameters:
hp_sid |
Optional parameter: Hosting plan series key. If not specified, the information about default domain hosting plan will be returned. |
promo_id |
Optional parameter: The ID of promotion to be applied to hosting plan prices. |
account_id |
Optional parameter: ID of account the prices are to be calculated for. |
period |
Optional parameter: Subscription period the discounts are to be calculated for. |
for_trial |
Optional parameter: If this parameter is specified then zero prices for add-ons (custom attributes, applications, etc.) will be returned. |
Returns: EXTENDED_HP_INFO
SOAP Faults codes:
HPNoTrial |
The for_trial parameter has been specified, but a hosting plan does not support trial periods. |
HPNotFound |
The hosting plan specified is not found. |
HPNoDefaultDMPlan |
Hosting plan series key is not specified and default domain hosting plan does exist. |
HPProviderNotAllowed |
Provider account ID is used to get hosting plan details. Only customer or reseller account ID is allowed as parameter. |
get_plan_promotion_list
The function returns the list of promotions applicable to a hosting plan.
Parameters:
hp_sid |
Hosting plan series key. |
Returns: PROMOTION list
SOAP Faults codes:
HPNoPromoFound |
No promotions are applied to a hosting plan. |
get_promotion
The function returns information about a promotion by a promotion ID.
Parameters:
promo_id |
Promotion ID. |
Returns: PROMOTION:
SOAP Faults codes:
HPNoPromoSeriesFound |
No promotion with ID specified exists. |
get_sellable_plan_list
The function returns the list of hosting plans sold. The base information only is returned.
Parameters:
type_id |
Optional parameter: The ID of hosting plan type. Only hosting plans of the type specified will be returned. |
promo_id |
Optional parameter: ID of promotion to be applied to hosting plans prices. |
account_id |
Optional parameter: ID of account the prices are to be calculated for. |
sb_sid |
Optional parameter: |
sb_node |
Optional parameter: |
Returns: plan_list => HP list
SOAP Faults codes:
HPProviderNotAllowed |
Provider account ID is used to get hosting plan details. Only customer or reseller account ID is allowed as parameter. |
validate_plesk_login
The function checks Plesk Administrator login, password, and forward URL.
Parameters:
login |
Optional parameter: Plesk Administrator login. |
password |
Optional parameter: Plesk Administrator password. |
forward_url |
Optional parameter: Plesk forwarding URL. |
Returns: result => 1 on success, Fault otherwise
SOAP Faults codes:
PleskLoginInvalid |
Plesk Administrator login invalid. |
PleskPasswordInvalid |
Plesk Administrator password invalid. |
UserPleskForwardURLInvalid |
Plesk forwarding URL invalid. |