get_client_plan_services_m Sample Call and Response
This example shows a call to get_client_plan_services_m that retrieves information for all services attached to a specified plan, based on the plsql_m_r73.yml definition file for release 73.
This example includes the required plan identifier and shows two representative services on the plan, rather than every service and characteristic a real plan configuration could include.
Sample call
{
"rest_call": "get_client_plan_services_m",
"output_format": "json",
"client_no": "10021",
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"plan_no": 3301
}
The plan is identified by one of two alternative fields, plan_no or client_plan_id; this example uses plan_no, the Aria-assigned numeric identifier for the Premium Streaming plan. Both plan_no and client_plan_id are required fields in this method, so the caller must supply one of the two. The example omits do_logging_ind, locale_no, locale_name, and do_translations, since the yml file marks each of these nonpublic and internal.
Sample response
{
"plan_services_list": [
{
"service_no": 5510,
"client_service_id": "svc-hardware-electronics",
"service_desc": "Consumer Electronics Hardware",
"is_recurring_ind": 1,
"is_usage_based_ind": 0,
"usage_type": null,
"taxable_ind": 0,
"is_arrears_ind": 0,
"is_setup_ind": 0,
"is_misc_ind": 0,
"coa_id": "COA-4400",
"client_coa_code": "ELEC-HW",
"display_ind": 1,
"tiered_pricing_rule": 1,
"fulfillment_based_ind": 1,
"svc_location_no": 210,
"usage_type_name": null,
"usage_unit_label": null,
"apply_usage_rates_daily": null
},
{
"service_no": 5601,
"client_service_id": "svc-streaming-usage",
"service_desc": "Streaming Data Usage",
"is_recurring_ind": 0,
"is_usage_based_ind": 1,
"usage_type": 14,
"taxable_ind": 1,
"is_arrears_ind": 1,
"is_setup_ind": 0,
"is_misc_ind": 0,
"coa_id": "COA-4520",
"client_coa_code": "STREAM-USG",
"display_ind": 1,
"tiered_pricing_rule": 2,
"fulfillment_based_ind": 0,
"svc_location_no": null,
"usage_type_name": "Streaming Gigabytes",
"usage_unit_label": "GB",
"apply_usage_rates_daily": 0
}
],
"error_code": 0,
"error_msg": "OK",
"error_details": null
}
An error_code of 0 with an error_msg of OK indicates that Aria found the plan and returned the services attached to it successfully. The plan_services_list array holds one entry per service; this example shows a recurring hardware service billed in arrears and a usage-based streaming service with a volume-discount tiered_pricing_rule of 2, but a real plan could carry additional services, and the array is not exhaustive. The tiered_pricing_rule value of 1 on the first service means standard pricing applies, while the value of 2 on the second means a volume discount rule applies; a value of 3 would mean a flat rate per tier. This example excludes ledger_code, since the yml file marks it deprecated in favor of coa_id, and it excludes the older plan_services return value entirely, since that field carries its own deprecate_version and is marked unused in this release; plan_services_list is the current replacement. It also excludes the internal api_not_returned and translation_support sections, since the yml file marks both nonpublic.