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. | ||||||||||||||||||||||||||||||||||||||||||||||
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||||||||||
acct_user_id | string | 32 | Client (or user)-assigned unique account identifier. If either acct_no or client_acct_id is valued, this field must be blank. | |||||||||||||||||||||||||||||||||||||||||||||||
OR | ||||||||||||||||||||||||||||||||||||||||||||||||||
client_acct_id | string | 50 | Client-assigned identifier for the account. If either acct_no or acct_user_id is valued, this field must be blank. | |||||||||||||||||||||||||||||||||||||||||||||||
![]() |
template_class | string | 8 |
Aria-assigned unique identification code for message template class. Allowable values for template_class:
|
||||||||||||||||||||||||||||||||||||||||||||||
override_template_no | long | 8 | Aria-assigned unique template identifier for the message template. | |||||||||||||||||||||||||||||||||||||||||||||||
behavioral_option | long | 8 |
Specifies the distillation behavioral option that is to be used for this template class. Allowable values for behavioral_option:
|
|||||||||||||||||||||||||||||||||||||||||||||||
override_template_option | long | 8 |
Template override options. Allowable values for override_template_options:
|
|||||||||||||||||||||||||||||||||||||||||||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||||||||||||||||||||||||||||||||||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||||||||||||||||||||||||||||||||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||||||||||||||||||||||||||||||||||||||||||
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |