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. |
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 | |
currency_cd | string | 3 | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
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. | ||||||
rate_sched | hash | An array of the rate schedules for the requested plan | ||||||
![]() |
long | The ID of this rate schedule | ||||||
![]() |
string | The name of this rate schedule | ||||||
![]() |
string | The currency this rate schedule is linked to | ||||||
![]() |
long | If true, this is the default rate schedule for the default currency
Allowable values for default_ind
|
||||||
![]() |
long | Whether or not this rate schedule is displayable
Allowable values for display_ind
|
||||||
![]() |
long | If true, this is the default rate schedule for the specified currency
Allowable values for default_ind_curr
|
||||||
![]() |
string | Client assigned unique rate schedule number | ||||||
![]() |
string | Start date of rate schedule | ||||||
![]() |
string | End date of rate schedule | ||||||
![]() |
long | Aria internal id of follow-up default rate schedule | ||||||
![]() |
string | Client defined id of followup rate schedule |