get_promotions_m
List all promotions
Input Arguments
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. | |||||||
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:
|
Output Arguments
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. |
promotions | hash | |
promo_cd | string | Unique identifier for promotion |
promo_desc | string | Description of promotion |
expires_after | string | Expiry of the promotion in terms of usage or time. The date format must be yyyy-mm-dd |
promotion_translations | hash | Array that contains all the translated values for a given locale. |
locale_name | string | Name of the locale |
locale_no | int | Aria-assigned unique identifier of the locale used for translations. |
promo_cd | string | Unique identifier for promotion |
promo_desc | string | Description of promotion |