get_promo_plan_set_details_m
Summary
| API Name | get_promo_plan_set_details_m |
|---|---|
| Class | administration_services_m |
| Update Version |
Description
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| promo_plan_set_no | long | Yes |
Aria assigned number for the promo plan set Alternative required field: client_plan_type_id |
|||||||
| client_plan_type_id | string | 100 | Yes |
Client defined unique identifier Alternative required field: promo_plan_set_no |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| promo_plan_set_no | long | No |
Aria assigned number for the promo plan set |
|
| promo_plan_set_name | string | No |
Specifies the name of a promotional plan set |
|
| promo_plan_set_desc | string | No |
Specifies the description of a promotional plan set |
|
| client_plan_type_id | string | No |
Client defined unique identifier |
|
| plan | object | No |
The plan associated with this method. |
|
| promo_plan_set_translation_info | object | No |
Array that contains all the translated values for a given locale. |
plan fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | Yes |
Aria assigned number for the plan |
|
| plan_name | string | Yes |
Specifies plan name |
|
| plan_desc | string | Yes |
Specifies plan description |
|
| client_plan_id | string | Yes |
Client defined unique identifier |
promo_plan_set_translation_info.plan_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | No |
Aria assigned number for the plan |
|
| plan_name | string | No |
Specifies plan name |
|
| plan_desc | string | No |
Specifies plan description |
promo_plan_set_translation_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| plan_t | object | No |
The plan_t associated with this method. |