get_promotions_m
Summary
| API Name | get_promotions_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
List all promotions
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. |
||||||
| 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. |
|
| Start of promotions object | ||||
| promotions | object | No |
The promotions associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶promo_cd | string | 30 | Yes |
Unique identifier for promotion |
| ▶promo_desc | string | 200 | Yes |
Description of promotion |
| ▶expires_after | string | Yes |
Expiry of the promotion in terms of usage or time. The date format must be yyyy-mm-dd |
|
| Start of promotion_translations object | ||||
| ▶promotion_translations | object | No |
Array that contains all the translated values for a given locale. |
|
| 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 |
| End of promotion_translations object | ||||
| End of promotions object | ||||