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

 

Home > Aria Crescendo core api > get_acct_plan_queued_changes_m

get_acct_plan_queued_changes_m

Retrieves all queued plan changes for a given plan instance including plan assignments, removals, replacements and rollovers, as well as changes to plan units, plan instance status, and rate schedules for both master plans and supplemental plans

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 100 This is the client-assigned identifier for the account.
queued_action_status_cd long   Filters the list of queued plan changes returned based on the status code   Allowable Values
  queue_id long 22 Unique identifier associated with a specific queued plan change
  plan_instance_no long 22 The subscription plan instance number.
  OR      
  client_plan_instance_id string 100 Client-defined plan Subscription plan instance ID.
  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_change_details hash  
queue_id long Unique identifier associated with a specific queued plan change
plan_instance_no long The unique identifier of the plan instance
client_plan_instance_id string The client-defined identifier of the plan instance
parent_plan_instance_no long The unique identifier of the parent plan instance.
client_parent_plan_instance_id string The client-defined identifier of the parent plan instance.
queued_action_status_cd long The current status code associated with a queued plan change   Allowable Values
queued_action_status_label string The current status associated with a queued plan change   Allowable Values
current_plan_no long Unique identifier of the plan currently associated with the plan instance
current_client_plan_id string Client-defined identifier of the plan currently associated with the plan instance
current_plan_name string Name of the plan currently associated with the plan instance
current_plan_units long Number of plan units currently associated with the plan instance.
current_plan_inst_status long Status currently associated with the plan instance.   Allowable Values
current_rate_schedule_no long Unique identifier of the rate schedule currently associated with the plan instance.
current_client_rate_schedule_id string Client-defined identifier of the rate schedule currently associated with the plan instance
effective_date string Date on which the queued plan change will take effect
target_plan_no long Unique identifier of the plan that will be associated with the plan instance after the queued plan change takes effect.
target_client_plan_id string Client-defined identifier of the plan that will be associated with the plan instance after the queued plan change takes effect.
target_plan_name string Name of the plan that will be associated with the plan instance after the queued plan change takes effect
target_plan_units long Number of plan units that will be associated with the plan instance after the queued plan change takes effect
target_plan_inst_status long Status of the plan instance after the queued plan change takes effect.
target_rate_schedule_no long Unique identifier of the rate schedule that will be associated with the plan instance after the queued plan change takes effect
target_client_rate_schedule_id string Client-defined identifier of the rate schedule that will be associated with the plan instance after the queued plan change takes effect
queuing_user_id string User id that created the queued plan change.
queuing_date string Date on which the queued plan change was created
deleting_user_id string User id that deleted the queued plan change
deleting_date string Date on which the queued plan change was deleted
execute_immediately_user_id string User id that immediately executed the queued plan change
execute_immediately_date string Date on which the queued plan change was immediately executed
editing_user_id string User id that most recently edited the queued plan change
editing_date string Date on which the queued plan change was most recently edited

You must to post a comment.
Last modified
14:39, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.