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

 

Home > Aria6 admintools api > create_supp_field

create_supp_field

Creates a supplemental field for specified client

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 Specifies the Supplemental field name
field_order int 2 Field Order For The Supplemental Field
presentation_mode string 8 Indicates Presentation Mode i.e. Form input type. Valid values : text, textarea, select, radio, checkbox
  field_desc string 300 Specifies the field description for the Supplemental field
  required_ind int 1 Indicates If The Supplemental Field is required, [can be 0 or 1]; 1 indicates required.
  hidden_ind int 1 Indicates If The Supplemental Field is hidden or displayed, [can be 0 or 1]; 1 indicates hidden
  sel_ind int 1 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.
  min_no_sel int 2 Indicates Minimum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field
  max_no_sel int 2 Indicates Maximum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field
  display_text string 300 Display Text For Selection Option. REST input arrays are "|" separated lists of a single data type. This field cannot be null if presentation_mode is select, radio or checkbox. Number of entries must be at least the value in max_no_sel.
  option_value string 300 Value For Selection Option. REST input arrays are "|" separated lists of a single data type This field cannot be null if presentation_mode is select, radio or checkbox. Number of entries must be at least the value in max_no_sel
  option_value_order int 4 Display Order For Selection Option. REST input arrays are "|" separated lists of a single data type This field cannot be null if presentation_mode is select, radio or checkbox. Number of entries must be at least the value in max_no_sel.

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

You must to post a comment.
Last modified
13:11, 19 May 2016

Tags

This page has no custom tags.

Classifications

This page has no classifications.