Home > Aria6 User Documentation > Aria6 core api > get_rate_schedules_for_plan
get_rate_schedules_for_plan
get_rate_schedules_for_plan
Returns a list of rate schedules associated with a specified plan. The plan's default rate schedule will always be the first rate schedule returned and the remaining rate schedules will be sorted by schedule number.
Input Arguments
| 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. |
Output Arguments
| 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 | ||||||
 schedule_no |
long | The ID of this rate schedule | ||||||
| schedule_name |
string | The name of this rate schedule | ||||||
| schedule_currency |
string | The currency this rate schedule is linked to | ||||||
| default_ind |
long | If true, this is the default rate schedule for the default currency
Allowable values for default_ind
|
||||||
| display_ind |
long | Whether or not this rate schedule is displayable
Allowable values for display_ind
|
||||||
| default_ind_curr |
long | If true, this is the default rate schedule for the specified currency
Allowable values for default_ind_curr
|
||||||
| client_rate_schedule_id |
string | Client assigned unique rate schedule number | ||||||
| available_from_date |
string | Start date of rate schedule | ||||||
| available_to_date |
string | End date of rate schedule | ||||||
| followup_rs_no |
long | Aria internal id of follow-up default rate schedule | ||||||
| client_followup_rs_id |
string | Client defined id of followup rate schedule |
- © Copyright 2022 Aria Developer Central