Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() |
field_selection | array | ||
![]() |
int | 100 | Specifies the field no | |
OR | ||||
![]() |
string | 100 | Specifies the field name | |
![]() |
field_categories | array | ||
![]() |
int | 100 | Specifies the field category no | |
OR | ||||
![]() |
string | 100 | Specifies the field category name | |
locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |
OR | ||||
locale_name | string | 32 | Name of the locale to which the translations belong. | |
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values |
Field Name | Field Type | Description |
---|---|---|
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 |
![]() |
int | The system defined ID of the field |
![]() |
string | The client defined ID of the field |
![]() |
string | The description provided for the field |
![]() |
int | The type of data that this field will store |
![]() |
int | The minimum number of values that can be entered for this field |
![]() |
int | The maximum number of values that can be entered for this field |
![]() |
string | The type of input to present for this field |
![]() |
hash | |
![]() |
string | A hash array of values that are allowed to be input for this field |
![]() |
string | A string array of object types that can be associated |
![]() |
hash | The same array as above, except both fields will be populated |
![]() |
int | |
![]() |
string | |
![]() |
hash | |
![]() |
string | The type of object |
![]() |
long | The system defined ID of the object (e.g. plan_no) |
![]() |
string | The value associated with this object |
![]() |
long | The field value definition order |
![]() |
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 |
![]() |
hash | Array that contains all the translated values for a given locale |
![]() |
string | Name of the locale |
![]() |
int | Aria-assigned unique identifier of the locale used for translations. |
![]() |
int | The system defined ID of the field |
![]() |
string | The client defined ID of the field |
![]() |
string | The description provided for the field |
![]() |
hash | List of allowed values for this field |
![]() |
string | Specifies the allowed value |