update_supp_field_m
Summary
| API Name | update_supp_field_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Update an existing 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 |
Specifies the Supplemental field name |
| field_desc | string | 300 | No |
Specifies the field description for the Supplemental field |
| field_order | int | 2 | No |
Field Order For The Supplemental Field |
| required_ind | int | 1 | No |
Indicates If The Supplemental Field is required, [can be 0 or 1]; 1 indicates required.Any value entered will be ignored if there is at least an account with this supplemental field |
| hidden_ind | int | 1 | No |
Indicates If The Supplemental Field is hidden or displayed, [can be 0 or 1]; 1 indicates hidden. Any value entered will be ignored if there is at least an account with this supplemental field. |
| 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. Any value entered will be ignored if there is at least an account with this supplemental field |
| presentation_mode | string | 8 | No |
Indicates Presentation Mode i.e. Form input type. Valid values : text, textarea, select, radio, checkbox. Any value entered will be ignored if there is at least an account with this supplemental field. |
| min_no_sel | int | 2 | No |
Indicates Minimum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field.Any value entered will be ignored if there is at least an account with this supplemental field |
| max_no_sel | int | 2 | No |
Indicates Maximum Number Of Selections From List Of Valid Values Allowed For The Supplemental Field.Any value entered will be ignored if there is at least an account with this supplemental field |
| display_text | string | 300 | No |
Display Text For Selection Option. Any value entered will be ignored if there is at least an account with this supplemental field. |
| option_value | string | 300 | No |
Value For Selection Option. Any value entered will be ignored if there is at least an account with this supplemental field. |
| option_value_order | int | 4 | No |
Display Order For Selection Option. Any value entered will be ignored if there is at least an account with this supplemental field |
| 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 |
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 |