Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_account_plan_history_m
get_account_plan_history_m
get_account_plan_history_m
Table of contents
Gets account plan history for all accounts matching specified query
Output Arguments
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. |
|
query_string | string | 1000 | The criteria which all returned objects must match. Different objects have a different set of searchable criteria.Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC". |
| username | string | 30 | DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool. | |
| password | string | 1000 | DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool. | |
| limit | long | 12 | The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records. | |
| offset | long | 12 | The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
Querystring Keys
| Key Name | Description |
|---|---|
| plan_instance_no | Aria-assigned identifier for a plan |
| client_plan_instance_id | Client-defined identifier for a plan |
| master_plan_instance_no | Aria-assigned identifier for a master plan instance |
| mp_client_plan_instance_id | Client-defined identifier for a master plan instance |
| old_plan_no | Aria-assigned identifier for a plan subscribed to before a plan change event (example events: status or unit change for the same plan or new plan assignment) |
| new_plan_no | Aria-assigned identifier for a plan subscribed to after a plan change event |
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| starting_record | long | This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records | long | This is the total number of objects that matched the provided criteria. |
| account_plan_history_m | hash | Detailed plan history for any accounts matching the query |
 plan_instance_no |
long | Aria-assigned identifier for a plan |
| client_plan_instance_id |
long | (DEPRECATED) |
| master_plan_instance_no |
long | Aria-assigned identifier for a master plan instance |
| mp_client_plan_instance_id |
long | (DEPRECATED) |
| old_plan_name |
string | Name of a plan subscribed to before a plan change event (example events: status or unit change for the same plan or new plan assignment) |
| old_plan_no |
long | Aria-assigned identifier for a plan subscribed to before a plan change event |
| old_client_plan_id |
string | Client-defined identifier for a plan subscribed to before a plan change event |
| old_client_plan_instance_id |
long | Client-defined identifier for a master plan instance subscribed to before a plan change event |
| old_promo_cd |
string | Promotion code used for a plan subscribed to before a plan change event |
| old_status_cd |
string | Previous status code for a plan subscribed to before a plan change event |
| old_plan_units |
long | Number of units of a plan subscribed to before a plan change event |
| old_rate_schedule_no |
long | Aria-assigned rate schedule identifier for a plan subscribed to before a plan change event |
| old_client_rate_schedule_id |
string | Client-defined rate schedule identifier for a plan subscribed to before a plan change event |
| new_plan_name |
string | Name of a plan subscribed to after a plan change event |
| new_plan_no |
long | Aria-assigned identifier for a plan subscribed to after a plan change event |
| new_client_plan_id |
string | Client-defined identifier for a plan subscribed to after a plan change event |
| new_client_plan_instance_id |
long | Client-defined identifier for a plan subscribed to after a plan change event |
| new_promo_cd |
string | Promotion code used for a plan subscribed to after a plan change event |
| new_status_cd |
string | Status code for a plan subscribed to after a plan change event |
| new_plan_units |
long | Number of purchased units of a plan subscribed to after a plan change event |
| new_rate_schedule_no |
long | Aria-assigned rate schedule identifier for a plan subscribed to after a plan change event |
| new_client_rate_schedule_id |
string | Client-defined rate schedule identifier for a plan subscribed to after a plan change event |
| old_dunning_state |
long | Dunning state of a plan subscribed to before a plan change event |
| new_dunning_state |
long |
Dunning state of a plan subscribed to after a plan change event |
- © Copyright 2023 Aria Developer Central