get_promotion_details_m
Summary
| API Name | get_promotion_details_m |
|---|---|
| Class | administration_services_m |
| Update Version |
Description
Returns details of promotion
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_cd | string | 30 | Yes |
Unique identifier for promotion |
||||||
| 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_cd | string | 30 | No |
Unique identifier for promotion |
| promo_desc | string | 200 | No |
Description of promotion |
| start_date | string | 10 | No |
Start date of given Promotion. The date format must be yyyy-mm-dd |
| exp_date | string | 10 | No |
Expiry date of given Promotion. The date format must be yyyy-mm-dd |
| no_of_uses | int | 8 | No |
Maximum number of possible usage for this promotion |
| plan_type_name | string | 20 | No |
Plan type name of Plan Type, associated with this Promotion |
| plan_type_desc | string | 2000 | No |
Plan type description of Plan Type, associated with this Promotion |
| promotion_translations | object | No |
Array that contains all the translated values for a given locale. |
promotion_translations 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 |
| promo_cd | string | 30 | No |
Unique identifier for promotion |
| promo_desc | string | 200 | No |
Description of promotion |