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. |
amount | double | 38 | New period-to-date threshold amount that triggers account-holder email notices when crossed over or under. | |
usage_unit_thresholds | array | |||
![]() |
long | Unique plan identifier. | ||
![]() |
long | The Aria-assigned usage type number to set the threshold unit amount per specific usage type. | ||
![]() |
string | 22 | Client-assigned identifier for the type to set the threshold unit amount per specific usage type. Either this field OR "usage_type_no" must be passed into the API to denote which usage type to set the threshold unit. | |
![]() |
double | The total number of threshold units | ||
![]() |
long | Indicates the level no of the threshold value | ||
![]() |
double | No units for the threshold level | ||
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. | |
application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |
application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
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. |