get_catalog_hierarchy_m
Summary
| API Name | get_catalog_hierarchy_m |
|---|---|
| Class | system_services_m |
| Update Version | 6.49 |
Description
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.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| promo_code | string | 30 | No |
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 | No |
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. Allowed values:
|
||||||
| parent_plan_no | long | 22 | No |
Aria-assigned unique plan identifier for the parent plan. If provided this returns all the plans one level below the parent_plan_no. Alternative field: client_parent_plan_id |
||||||
| client_parent_plan_id | string | 100 | No |
Client-defined Plan ID to query for available child plans Alternative field: parent_plan_no |
||||||
| locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. Alternative field: locale_name |
||||||
| locale_name | string | 100 | No |
Name of the locale. Alternative field: locale_no |
||||||
| include_parent_plan_list | string | 5 | No |
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. Allowed values:
|
||||||
| include_child_plans_list | string | 5 | No |
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. Allowed values:
|
||||||
| include_total_count | string | 5 | No |
Indicates whether to include the total count of plans.If set to true it will return the total count of plan Allowed values:
|
||||||
| limit | long | 3 | No |
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. |
||||||
| offset | long | 9 | No |
The number of records to skip in the all_plan_basic_details array. Min of 0 with no maximum value. If no value specified the default is 0. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| plans_count | long | No |
Returns a total count of the number of Plans in the Client. |
|
| all_plan_basic_details | object | No |
Multidimensional array of returned plans and plan structure. |
all_plan_basic_details.parent_plan_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| parent_plan_no | long | 30 | No |
ID of the parent plan |
| parent_plan_name | string | 100 | No |
Name of the parent plan |
| client_parent_plan_id | string | 100 | No |
Client-defined unique parent Plan ID |
all_plan_basic_details.child_plan_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | 30 | No |
Aria generated unique ID of the plan |
| client_plan_id | string | 100 | No |
Client-defined unique ID for the plan |
all_plan_basic_details fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| plan_no | long | 22 | No |
Aria-assigned unique plan identifier |
||||||
| plan_name | string | No |
Plan Name |
|||||||
| supp_plan_ind | long | No |
Indicates whether or not this plan is a supplemental plan. Allowed values:
|
|||||||
| client_plan_id | string | 100 | No |
Client assigned unique plan identifier |
||||||
| parent_plan_list | object | No |
Array of plans which are mapped as parents of this plan |
|||||||
| child_plan_list | object | No |
Array of the plans mapped as children of this plan |