Req | Field Name | Field Type | Max Length | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||
![]() |
promo_plan_set_no | long | Aria assigned number for the promo plan set | |||||||
OR | ||||||||||
client_plan_type_id | string | 100 | Client defined unique identifier | |||||||
locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |||||||
OR | ||||||||||
locale_name | string | 32 | Name of the locale to which the translations belong. | |||||||
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.
Allowable values for include_translations:
|
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error |
error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
promo_plan_set_no | long | Aria assigned number for the promo plan set |
promo_plan_set_name | string | Specifies the name of a promotional plan set |
promo_plan_set_desc | string | Specifies the description of a promotional plan set |
client_plan_type_id | string | Client defined unique identifier |
plan | hash | |
![]() |
string | Aria assigned number for the plan |
![]() |
string | Specifies plan name |
![]() |
string | Specifies plan description |
![]() |
string | Client defined unique identifier |
promo_plan_set_translation_info | hash | Array that contains all the translated values for a given locale. |
![]() |
string | Name of the locale |
![]() |
int | Aria-assigned unique identifier of the locale used for translations. |
![]() |
hash | |
![]() |
long | Aria assigned number for the plan |
![]() |
string | Specifies plan name |
![]() |
string | Specifies plan description |