get_supp_fields_m
Summary
| API Name | get_supp_fields_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Retrieve all client defined supplemental fields
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. |
||||||
| 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. |
|
| supp_fields | object | No |
The supp_fields associated with this method. |
supp_fields.supp_field_translation 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_name | string | 100 | No |
Specifies Field Name. |
| field_desc | string | 300 | No |
Specifies Field Description. |
| field_order | int | 2 | Yes |
Field order of supplemental field |
supp_fields fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_name | string | 100 | Yes |
Name of supplemental field |
| field_desc | string | 300 | No |
Description of supplemental field |
| field_order | int | 2 | Yes |
Field order of supplemental field |
| supp_field_translation | object | No |
Array that contains all the translated values for a given locale. |