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. |
plan_no | long | 22 | The unique plan identifier. | |
OR | ||||
client_plan_id | string | 100 | Client-defined Plan ID for which to query available child plans | |
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. | ||||||||||||||||||
supp_plan_hist | hash | |||||||||||||||||||
![]() |
long | A string array of supp_plan_no | ||||||||||||||||||
![]() |
long | A string array of old account status codes corresponding to the supplemental plans listed in the supp_plan_no string array above
Allowable values for old_status_cd
|
||||||||||||||||||
![]() |
long | A string array of new status codes associateed with the supplemental plans listed in supp_plan_no
Allowable values for new_status_cd
|
||||||||||||||||||
![]() |
double | A string array of olf plan unit values assigned to to the supplemental plans listed in supp_pllan no | ||||||||||||||||||
![]() |
double | A string array of new plan units associated with the list of supplemental plans provided by supp_plna_no | ||||||||||||||||||
![]() |
long | A string array of old rate schedules associated with the plans listed in supp_plan_no | ||||||||||||||||||
![]() |
long | A string arrray of new rate schedules associated with the supplemental plans listed in supp_plan_no | ||||||||||||||||||
![]() |
string | A string array of comments for the supplemental plans listed in supp_plan_no | ||||||||||||||||||
![]() |
string | A string array of dates representing the last update to the supplemental plans corresponding to the list provided in supp_plan_no. | ||||||||||||||||||
![]() |
string | Client-defined supplemental plan ID. | ||||||||||||||||||
![]() |
string | A string array of client-defined old rate schedules ID associated with the plans listed in client_plan_id. | ||||||||||||||||||
![]() |
string | A string array of client-defined old rate schedules ID associated with the supplemental plans listed in client_plan_id. |