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_details |
hash |
List of fields |
field_no |
int |
The system defined ID of the field |
field_name |
string |
The client defined ID of the field |
description |
string |
The description provided for the field |
datatype |
int |
The type of data that this field will store |
min_no_sel |
int |
The minimum number of values that can be entered for this field |
max_no_sel |
int |
The maximum number of values that can be entered for this field |
form_input_type |
string |
The type of input to present for this field |
allowed_values |
hash |
|
value |
string |
A hash array of values that are allowed to be input for this field |
associated_types |
string |
A string array of object types that can be associated |
field_categories |
hash |
The same array as above, except both fields will be populated |
field_category_no |
int |
|
field_category_name |
string |
|
object_values |
hash |
|
object_type |
string |
The type of object |
object_id |
long |
The system defined ID of the object (e.g. plan_no) |
value_text |
string |
The value associated with this object |
primacy |
long |
The field value definition order |
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:
Values |
Description |
0 |
For a plan in the product catalog |
1 |
For a specific instance of a plan assigned to an account |
2 |
For a specific unit of a plan assigned to an account |
|
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 |
The system defined ID of the field |
field_name |
string |
The client defined ID of the field |
description |
string |
The description provided for the field |
allowed_values_t |
hash |
List of allowed values for this field |
value |
string |
Specifies the allowed value |