Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo admintools api > get_supp_field_details_m

get_supp_field_details_m

Retrieve details on specified client defined supplemental account field.

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.
field_name string 100 Supplemental field name
  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

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.
field_name string Specifies the Supplemental field
field_desc string Specifies the field description for the Supplemental field
field_order int Field Order For The Supplemental Field
hidden_ind int Indicates If The Supplemental Field is hidden or displayed, [can be 0 or 1]; 1 indicates hidden
required_ind int Indicates If The Supplemental Field is required, [can be 0 or 1]; 1 indicates required.
sel_ind int Indicates If The Supplemental Field has selection options i.e. if field contains one or more values from a list of valid values. [can be 0 or 1]; 1 indicates has selection options.
presentation_mode string Indicates Presentation Mode i.e. Form input type. Valid values : text, textarea, select, radio, checkbox
min_no_sel int Indicates Minimum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field
max_no_sel int Indicates Maximum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field
additional_html string  
extra_validation_methods string  
sel_options hash  
display_text string Display Text For Selection Option
option_value string Value For Selection Option
option_value_order int Display Order For Selection Option
supp_field_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.
field_name string Specifies the Account field name
field_desc string Specifies the field description for the Account field
field_order int Field order of supplemental field
sel_options hash List of allowed values for this field
display_text string Display Text For Selection Option
option_value string Value For Selection Option
option_value_order int Display Order For Selection Option

You must to post a comment.
Last modified
10:16, 14 Jun 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.