get_plan_groups_m
Summary
| API Name | get_plan_groups_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Lists all plan groups
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
Outputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|||||||||
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|||||||||
| Start of plan_groups object | ||||||||||||
| plan_groups | object | No |
The plan_groups associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶group_no | long | 22 | Yes |
Unique identifier for plan group |
||||||||
| ▶client_plan_change_group_id | string | 100 | No |
Client defined unique identifier |
||||||||
| ▶group_name | string | 30 | Yes |
Name of plan group |
||||||||
| ▶group_desc | string | 300 | Yes |
Description of plan group |
||||||||
| ▶group_usage | string | 30 | Yes |
Indicate usage of plan group Allowed values:
|
||||||||
| ▶group_plans_count | int | No |
Total number of plans assigned to plan group |
|||||||||
| End of plan_groups object | ||||||||||||