Home > Aria6 User Documentation > Aria6 admintools api > get_promotion_details

get_promotion_details

Returns details of promotion

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png promo_cd string 30 Unique identifier for promotion
  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.
client_no int Aria-assigned unique identifier indicating the Aria client providing service to this account.
promo_cd string Unique identifier for promotion
promo_desc string Description of promotion
start_date string Start date of given Promotion. The date format must be yyyy-mm-dd
exp_date string Expiry date of given Promotion. The date format must be yyyy-mm-dd
no_of_uses int Maximum number of possible usage for this promotion
plan_type_name string Plan type name of Plan Type, associated with this Promotion
plan_type_desc string Plan type description of Plan Type, associated with this Promotion
promotion_translations hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif promo_cd string Unique identifier for promotion
brd_arrow.gif promo_desc string Description of promotion
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.