get_supp_obj_fields_m
Summary
| API Name | get_supp_obj_fields_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve details on specified client defined supplemental product 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_no | long | Yes | ||||||||
| 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_no | long | No |
Aria assigned unique number to identify this field |
|||||||||
| field_name | string | No |
Specifies the Supplemental field name |
|||||||||
| description | string | No |
Specifies the field description for the Supplemental field |
|||||||||
| datatype | string | No |
Specifies the datatype of the fields (e.g. date, string, etc.) |
|||||||||
| min_no_sel | int | No |
Indicates Minimum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field |
|||||||||
| max_no_sel | int | No |
Indicates Maximum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field |
|||||||||
| form_input_type | string | No |
Specifies the type of input element this field should be (e.g. input, select, checkbox, etc.) |
|||||||||
| allowed_values | object | No |
The allowed_values associated with this method. |
|||||||||
| associated_objects | object | No |
The associated_objects associated with this method. |
|||||||||
| field_categories | object | No |
The field_categories associated with this method. |
|||||||||
| allow_instance_override | int | No |
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. Allowed values:
|
|||||||||
| supp_obj_field_translations | object | No |
Array that contains all the translated values for a given locale. |
allowed_values fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| value | string | No |
List of allowed values for this field |
field_categories fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_category_no | long | No |
Specifies the field category no |
|
| field_category_name | string | No |
Specifies the field category name |
supp_obj_field_translations.allowed_values_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| value | string | No |
Specifies the allowed value |
supp_obj_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_no | long | No |
Aria assigned unique number to identify this field |
|
| field_name | string | No |
Specifies the Supplemental field name |
|
| description | string | No |
Specifies the field description for the Supplemental field |
|
| allowed_values_t | object | No |
List of allowed values for this field |