get_supp_obj_fields_m
Retrieve details on specified client defined supplemental product 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_no | int | ||||||||
| 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. | ||||||||
| field_no | int | Aria assigned unique number to identify this field | ||||||||
| field_name | string | Specifies the Supplemental field name | ||||||||
| description | string | Specifies the field description for the Supplemental field | ||||||||
| datatype | string | Specifies the datatype of the fields (e.g. date, string, etc.) | ||||||||
| min_no_sel | string | 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 | ||||||||
| form_input_type | string | Specifies the type of input element this field should be (e.g. input, select, checkbox, etc.) | ||||||||
| allowed_values | hash | |||||||||
 value |
string | List of allowed values for this field | ||||||||
| associated_objects | hash | |||||||||
| associated_object |
string | |||||||||
| field_categories | hash | |||||||||
| field_category_no |
int | |||||||||
| field_category_name |
string | |||||||||
| allow_instance_override | int | Specifies whether the product field should be saved on the product catalog or plan instance or the plan unit instance. Currently only be honored for "Plan" type fields.
Allowable values for allow_instance_override
|
||||||||
| supp_obj_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_no |
int | Aria assigned unique number to identify this field | ||||||||
| field_name |
string | Specifies the Supplemental field name | ||||||||
| description |
string | Specifies the field description for the Supplemental field | ||||||||
| allowed_values_t |
hash | List of allowed values for this field | ||||||||
| value |
string | Specifies the allowed value |