get_acct_plan_queued_changes_m Guide
- Last updated
-
-
Save as PDF
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.
Additional Guidance
Input Fields
| Field Name: |
Notes: |
| <client_acct_id> |
Client-defined account identifier.
To obtain the custom rate details, pass values into these fields:
- Required: <acct_no> or <client_acct_id>
- Optional: <plan_instance_no> or <client_plan_instance_id>, or <queue_id>
The custom rate details will be provided in the <queued_plan_custom_rates> output array.
|
| <queued_action_status_cd> |
Allowable values:
| Values |
Description |
| 0 |
Deleted |
| 1 |
Queued |
| 2 |
Executed successfully |
| 3 |
Failed to execute |
| 4 |
All (default if no value is provided) |
|
Output Fields
| Field Name: |
Notes: |
| <queued_action_status_cd> |
Allowable values
| Values |
Description |
| 0 |
Deleted |
| 1 |
Queued |
| 2 |
Executed successfully |
| 3 |
Failed to execute |
|
| <queued_action_status_label> |
Allowable values
| Values |
Description |
| 0 |
Deleted |
| 1 |
Queued |
| 2 |
Executed successfully |
| 3 |
Failed to execute |
|
| <current_plan_inst_status> |
Allowable values
| Values |
Description |
| 1 |
ACTIVE |
| 2 |
PENDING CANCELLATION |
| 3 |
PENDING TERMINATION |
| 31 |
PENDING INSTALLATION |
| 32 |
PENDING ACTIVATION |
| 41 |
TRIAL |
| 61 |
ACTIVE NON-BILLABLE |
| -1 |
SUSPENDED |
| -2 |
CANCELLED |
| -3 |
TERMINATED |
| 0 |
INACTIVE |
|
| <current_plan_inst_status_2> |
Allowable values
| Values |
Description |
| 1 |
ACTIVE |
| 2 |
PENDING CANCELLATION |
| 3 |
PENDING TERMINATION |
| 31 |
PENDING INSTALLATION |
| 32 |
PENDING ACTIVATION |
| 41 |
TRIAL |
| 61 |
ACTIVE NON-BILLABLE |
| -1 |
SUSPENDED |
| -2 |
CANCELLED |
| -3 |
TERMINATED |
| 0 |
INACTIVE |
|
| <queue_type> |
Indicates the queue action.
| Value |
Description |
| 1 |
Plan Assignment |
| 2 |
Mandatory Child Plan Assignment |
| 3 |
Plan Replacement |
| 4 |
Plan Rollover |
| 5 |
Plan Cancellation |
| 6 |
Plan Update (units, rate schedule, status, etc) |
| 7 |
Plan Status Change |
|
Error Codes
| Error Code/Description |
Associated inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<plan_instance_no>, <client_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<client_plan_instance_id> |
14114: Invalid queued action status
|
|
14115: Invalid Plan instance specified for the queue_id provided.
|
|
14116: Invalid Queue ID specified for this account
|
|
14117: Invalid queued action status specified for the queue_id provided
|
|
14118: Invalid queued action status specified for the Plan instance provided
|
|
14119: Invalid queued action status specified for the account provided
|
|
