update_supp_obj_field_m
Summary
| API Name | update_supp_obj_field_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Update an existing 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 |
Aria assigned unique number to identify this field |
|||||||||
| field_name | string | 300 | Yes |
Name of the product field. Translatable |
||||||||
| description | string | 3000 | No |
Description of the product field. Translatable |
||||||||
| min_no_sel | string | No |
Minimum number of selections |
|||||||||
| max_no_sel | int | No |
Maximum number of selections allowed |
|||||||||
| datatype | string | 30 | No |
Date, Number, String |
||||||||
| form_input_type | string | 10 | No |
Checkbox, Radio, Select, Text, Textarea |
||||||||
| use_allowed_vals_ind | string | 1 | No |
Allowed values for specific datatype. Eg Yes/No for Radio form_input_type |
||||||||
| option_value | string | 1000 | No |
Values that are passed as options. |
||||||||
| option_value_order | int | No |
The order in which the values should be set. |
|||||||||
| 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:
|
|||||||||
| assign_field_categories | object | Yes |
The assign_field_categories associated with this method. |
|||||||||
| object_type | object | No |
The object_type associated with this method. |
|||||||||
| 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 |
assign_field_categories fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_category_no | long | 100 | No |
Specifies the field category no Alternative field: field_category_name |
| field_category_name | string | 100 | No |
Specifies the field category name Alternative field: field_category_no |
| field_category_directive | int | 100 | No |
Specifies the field category directive. 1 to add and 2 to remove an field category Alternative field: field_category_no |
object_type fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| object_type | string | No |
Object Types - Plan, Inventory Item, Service Code, Usage Type |
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 |
field no |