Home > Aria6 User Documentation > Aria6 core api > cancel_queued_service_plan
cancel_queued_service_plan
cancel_queued_service_plan
Table of contents
Cancels all 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 | 8 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| plan_no_to_remove | array | |||
 queued_plan_no |
long | Master and/or supplemental plan numbers used to cancel plans that were queued | ||
| OR | ||||
| queued_client_plan_id |
string | 100 | Client-defined Master and/or supplemental plan ID used to cancel plans that were queued | |
| remove_all_queued_plan_no | string | Boolean 'true' or 'false' indicator informing user whether or not to actually perform all plans cancellation at the account level. If 'false' is passed in this field, the queued_plan_no should be populated with Aria plan number(s). | ||
| remove_terminate_pending | string | 5 | Determines whether or not queued plan terminations (those supplemental plans with status of Terminate Pending) will be immediately removed from the account. Note that this parameter takes precedence over the reactivate_terminate_pending parameter, and applies to all plans with status Terminate Pending that are covered by the API call . either those specified in the plan_no_to_remove array, or all queued plan changes if remove_all_queued_plan_no = .true.. When remove_terminate_pending = .true., all relevant supplemental plans will be immediately removed from the account and the status of those plans will become Terminated. When remove_terminate_pending = .false. or null, the reactivate_terminate_pending parameter will be evaluated. | |
| reactivate_terminate_pending | string | 5 | Determines whether or not queued plan terminations (those supplemental plans with status of Terminate Pending) will be cancelled (immediately changing the status to Active). Note that the remove_terminate_pending parameter takes precedence over the reactivate_terminate_pending parameter, and the behavior described below will only take effect when remove_terminate_pending = .false. or null. The reactivate_terminate_pending parameter applies to all plans with status Terminate Pending that are covered by the API call . either those specified in the plan_no_to_remove array, or all queued plan changes if remove_all_queued_plan_no = .true.. When reactivate_terminate_pending = .true., the status of all relevant supplemental plans will be immediately changed to Active. When reactivate_terminate_pending = .false. or null, the relevant plans will remain in Terminate Pending status and will be terminated according to the original schedule. | |
| 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. | |
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
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. |
- © Copyright 2023 Aria Developer Central