get_catalog_hierarchy_m Guide

Last updated
Save as PDF

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.

API Specification:	get_catalog_hierarchy_m
Required Fields:	<client_no> <auth_key>

Error Codes:

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<auth_key>, <client_id>, <client_no>
1033: a parameter that represents a true or false value contains invalid input Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write	<alt_collect_on_approve>, <alt_send_statement_on_approve>, <cancel_orders_on_discard>, <cascade_action>, <do_auto_discard>, <do_collect>, <change_status_after_coll>, <reset_dates_after_status>, <disable_existing_on_update>, <do_write>, <exclude_terminated_plan_inst>, <include_all_rate_schedules>, <include_plan_hierarchy>, <retrieve_bundled_nso, retrieve_included_nso>, <include_translations>, <include_inactive_items>, <include_invoice_activity_eligibility>, <include_rs_summary, <include_translations>, <include_service_supp_fields>/<include_product_fields>/, <include_plan_instance_fields>/<include_plan_services>/, <include_surcharges>, <include_void_transactions>, <include_voided>, <invoice_unbilled_usage>, <is_unlinked_refund>, <record_cc_on_auth_failure>, <retrieve_excluded_usage>, <send_email>, <usage_pooling>, <do_write>
1066: Locale name does not exist in the system. Associated Inputs: locale_name	<locale_name>
1067: Locale no does not exist in the system. Associated Inputs: locale_no, master_plan_instance_no	<locale_name>, <master_plan_instance_no>
5067: limit must be between 1 and 999. Associated Input: limit, record_limit, contract_limit	<limit>, <record_limit>, <contract_limit>
5068: offset must be greater than or equal to zero. Associated Input: offset, contract_offset	<offset>, <contract_offset>

Additional Guidance:

Input Fields

Field Name:

Notes:

<limit>

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.

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).

<include_plan_hierarchy>

Allowable values

Values	Description
true	true
false (Default)

<include_parent_plan_list>

Allowable values

Values	Description
true (Default)	true (Default)
false	false

<include_child_plans_list>

Allowable values

Values	Description
true (Default)	true (Default)
false	false

<include_total_count>

Allowable values

Values	Description
true	true
false (Default)	false (Default)

Output Fields

Field Name

Notes

<supp_plan_ind>

Allowable values

Values	Description
0	Plan is NOT a Supplemental Plan
1	Plan is a Supplemental Plan