Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_plan_group_details_m

get_plan_group_details_m

Returns details of specified plan group

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 group_no int 30 Plan group number
  OR      
  client_plan_change_group_id string 100 Client defined identifier for Plan group number
  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.
group_no int Unique identifier for plan group
client_plan_change_group_id string Client defined unique identifier
group_name string Name of plan group
group_desc string Description of plan group
group_usage string Indicate usage of plan group values: - value: '1' description: CSR only - value: '2' description: USS only - value: '3' description: Both CSR and USS
plans hash  
brd_arrow.gif plan_desc string Specifies plan description
brd_arrow.gif plan_no int Plan Number
plan_group_translation_info 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 plans_t hash  
brd_arrow.gif plan_name string Name of plan
brd_arrow.gif plan_desc string Specifies plan description
brd_arrow.gif plan_no int Aria-assigned unique plan identifier
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.