|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method pulls a list of service template (ST) service parameters for validation and returns full list of ST parameters with validation result. The list of ST parameters differs depending on template type: POA hosting template, domain template, licensed services template. To get the full list of service parameters, invoke method with two parameters passed: service plan ID and ST ID. Note: if some exception occurs when processing submitted values, method returns base64 encoded message instead of standard data packet. This method can be used for validation of subscription provisioning parameters submitted through a third-party online store or for migration purposes. |
2 or more |
9 or more |
Syntax
ListResult BM::PlanParamsGetAndValidate_API(
Int PlanID;
Int ServiceTemplateID;
Str(40) STParameterID_1=ParameterValue;
...
Str(40) STParameterID_N=ParameterValue.
)
returns
Str(40) ParamID - ID of ST service parameter;
Str(40) ParamType - type ST of service parameter;
Str(40) ParamName - name of ST service parameter.
Str(40) Description - description of ST service parameter;
Str(40) DefaultValue - if parameter has default value, returns this value. For example, default value for 'OrderOperationType' parameter of domain ST is '10' (registration);
Int Required - signifies if parameter is required: '1' - required, '0' - not required;
Int Status - parameter validation status:
'0' - parameter is valid;
'1' - parameter value is absent and need to be asked;
'2' - parameter is invalid (see details in Message slot);
'3' - parameter value is not needed for service provisioning;
Str(256) Message - parameter validation result;
Int ST_ParamWeight - service parameter sort order in online store and CP.
Special Notes