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. | ||||||
![]() |
usage_type | long | 38 | The type of usage being consumed by the account holder | ||||||
OR | ||||||||||
usage_type_code | string | 30 | The ID of the usage type associated with this line | |||||||
usage_units | double | 12 | The volume of usage consumed by the account holder. | |||||||
next_usage_date | string | 14 | The next date usage will be recorded | |||||||
alt_desc | string | 300 | Alternate description of the usage being recorded | |||||||
plan_no | long | 22 | The unique plan identifier | |||||||
OR | ||||||||||
client_plan_id | string | 100 | The unique Client-defined Plan identifier. | |||||||
first_usage_date | string | 14 | The date of the first usage to record | |||||||
recurring_ind | string | 5 | Indicates whether or not this service is a recurring service
|
|||||||
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. |