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. | ||||||||||
![]() |
contract_no | long | 22 | Aria-assigned unique contract identifier | ||||||||||
type_no | long | 8 | Type of contract end action enforced by this contract.
Allowable values for type_no
|
|||||||||||
length_months | long | 8 | The number of months from start_date that the given contract will be in effect. | |||||||||||
OR | ||||||||||||||
end_date | string | End date of the date range covered by this line item in yyyy-mm-dd format. | ||||||||||||
start_date | string | 14 | Contract start date in yyyy-mm-dd format. This field is required for a plan or contract with a future start date. | |||||||||||
update_comments | string | 3000 | Comments provided at time of last contract update. | |||||||||||
modify_directive | long | 1 | Whether to add or remove the contract
|
|||||||||||
![]() |
long array | Aria-assigned plan identifier. This value is unique across all Aria-managed accounts. | ||||||||||||
![]() |
string array | 100 | Array of unique client-defined Plan Identifier | |||||||||||
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. |