get_supp_field_details_m
Summary
| API Name | get_supp_field_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve details on specified client defined supplemental account field.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| field_name | string | 100 | Yes |
Supplemental field name |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| field_name | string | 100 | No |
Specifies the Supplemental field |
| field_desc | string | 300 | No |
Specifies the field description for the Supplemental field |
| field_order | int | 2 | No |
Field Order For The Supplemental Field |
| hidden_ind | int | 1 | No |
Indicates If The Supplemental Field is hidden or displayed, [can be 0 or 1]; 1 indicates hidden |
| required_ind | int | 1 | No |
Indicates If The Supplemental Field is required, [can be 0 or 1]; 1 indicates required. |
| sel_ind | int | 1 | No |
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 | 8 | No |
Indicates Presentation Mode i.e. Form input type. Valid values : text, textarea, select, radio, checkbox |
| min_no_sel | int | 2 | No |
Indicates Minimum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field |
| max_no_sel | int | 2 | No |
Indicates Maximum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field |
| sel_options | object | No |
The sel_options associated with this method. |
|
| supp_field_translations | object | No |
Array that contains all the translated values for a given locale. |
sel_options fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| display_text | string | 300 | Yes |
Display Text For Selection Option |
| option_value | string | 300 | No |
Value For Selection Option |
| option_value_order | int | 4 | Yes |
Display Order For Selection Option |
supp_field_translations.sel_options fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| display_text | string | 300 | Yes |
Display Text For Selection Option |
| option_value | string | 300 | No |
Value For Selection Option |
| option_value_order | int | 4 | Yes |
Display Order For Selection Option |
supp_field_translations fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| field_name | string | No |
Specifies the Account field name |
|
| field_desc | string | No |
Specifies the field description for the Account field |
|
| field_order | int | 2 | Yes |
Field order of supplemental field |
| sel_options | object | No |
List of allowed values for this field |