Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > get_queued_service_plans

get_queued_service_plans

Returns a list of all master plan and supplemental plan changes scheduled to go into effect for a specified account.

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.
account_number long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts..
alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

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.
queued_plans hash An array of plans queued for the specified account number
original_plan string The "from" plan name, which will be removed when this change takes effect
original_plan_no long The "from" plan number, which will be removed when this change takes effect
new_plan string The "to" plan name, which will be added when this change takes effect
new_plan_no long The "to" plan number, which will be added when this change takes effect
change_date string The date on which this change will happen
new_rate_schedule_no long The new rate schedule which will be assigned
client_receipt_id string Client-defined unique identifier used to track related system actions
new_plan_units double An array of new plan units associated with the list of master or supplemental plans array returned in new_plan_no
new_plan_type string An array of plan type valued as M for Master plan or S for Supplemental plan associated with the list of new_plan_no
client_original_plan_id string The "from" client-defined plan ID, which will be removed when this change takes effect
client_new_plan_id string The "to" client-defined plan ID, which will be added when this change takes effect
client_new_rate_schedule_id string The client-defined new rate schedule which will be assigned
custom_rate hash An array of custom rates for the specified account number
custom_rate_service_no long 'The service number for the new custom rate'
custom_rate_seq_no long 'The sequence number for this line of the rate schedule'
custom_rate_from_unit long 'Tiered pricing, "FROM" unit'
custom_rate_to_unit long 'Tiered pricing, "TO" unit'
custom_rate_per_unit double 'The rate to charge per unit on this tier'
client_custom_rate_service_id string The client-defined service ID for the new custom rate.
current_rate_schedule_no long The current rate schedule number for the plan used by the specified account number
client_current_rate_schedule_id string The current client-defined rate schedule ID for the plan used by the specified account number.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.