get_catalog_hierarchy_m
This API Gets the hierarchy of plans for a given client. It Provides the ability to filter the results to return the catalog hierarchy by promo code, parent plan number, client parent plan ID. Each filter can be used independently or in combination to provide control on reading the catalog. The intent of this API is to give a developer more control on reading the plan hierarchy. Example: you can use this API to display specific plans in your registration or user self-service application.
For information on error messages generated by this API, see get_catalog_hierarchy_m Error Messages.
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. | ||||||
| promo_code | string | 30 | Filter the results based on an Aria promo code. Return all master plans for a specified promo_code (promo_code). If no promo code is specified it will return all master plans. | |||||||
| include_plan_hierarchy | string | 5 | If the include_plan_hierarchy parameter is set to true, then all of the child plans down to the bottom level of the plan hierarchy will be returned. If no value specified return the entire hierarchy.
Allowable values for include_plan_hierarchy:
|
|||||||
| parent_plan_no | long | 22 | Aria-assigned unique plan identifier for the parent plan. If provided this returns all the plans one level below the parent_plan_no. | |||||||
| OR | ||||||||||
| client_parent_plan_id | string | 100 | Client-defined Plan ID to query for available child plans | |||||||
| locale_no | long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | |||||||
| OR | ||||||||||
| locale_name | string | 100 | Name of the locale. | |||||||
| include_parent_plan_list | string | 5 | Indicates whether to include the list of parent plans in the all_plans_basic_details array.If no value specified,the list of parent plans is returned.
Allowable values for include_parent_plan_list:
|
|||||||
| include_child_plans_list | string | 5 | Indicates whether to include the list of child plans in the all_plans_basic_details array.If no value is specified, the list of child plans is returned.
Allowable values for include_child_plans_list:
|
|||||||
| include_total_count | string | 5 | Indicates whether to include the total count of plans.If set to true it will return the total count of plan
Allowable values for include_total_count:
|
|||||||
| limit | long | 3 |
Limits the number of records returned in the all_plan_basic_details array. Min of 1 and Max 999. If no value specified, the default is 100. Example: If you have 100 plans and you pass 50 into this field, Aria will return your first 50 plans ordered by <plan_no>. You can also identify which specific plans to return by passing a value into the <offset> field as described below. |
|||||||
| offset | long | 3 |
The number of records to skip in the <all_plan_basic_details array>. Minimum of 0 and no maximum. If no value specified the default is 0. Example: If you have 100 plans and you pass 30 into the <limit> field and 50 into the <offset> field, Aria will return 30 plans - plans 51 to 80, ordered by <plan_no>.
Note: If you want to retrieve more than 999 plans, you will need to call this API more than once, with a different <offset> value each time (to skip previously-returned plans). |
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. | ||||||
| plans_count | long | Returns a total count of the number of Plans in the Client. | ||||||
| all_plan_basic_details | hash | Multidimensional array of returned plans and plan structure. | ||||||
 plan_no |
long | Aria-assigned unique plan identifier | ||||||
| plan_name |
string | Plan Name | ||||||
| supp_plan_ind |
long | Indicates whether or not this plan is a supplemental plan.
Allowable values for supp_plan_ind:
|
||||||
| client_plan_id |
string | Client assigned unique plan identifier | ||||||
| parent_plan_list |
hash | Array of plans which are mapped as parents of this plan | ||||||
| parent_plan_no |
long | ID of the parent plan | ||||||
| parent_plan_name |
string | Name of the parent plan | ||||||
| client_parent_plan_id |
string | Client-defined unique parent Plan ID | ||||||
| child_plan_list |
hash | Array of the plans mapped as children of this plan | ||||||
| plan_no |
long | Aria generated unique ID of the plan | ||||||
| client_plan_id |
string | Client-defined unique ID for the plan |
- © Copyright 2023 Aria Developer Central