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

 

Home > Aria Crescendo admintools api > update_supp_field_m

update_supp_field_m

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

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

Tags

This page has no custom tags.

Classifications

This page has no classifications.