Home > Aria Crescendo Documentation > Aria Crescendo admintools api > create_plan_group_m
create_plan_group_m
create_plan_group_m
Table of contents
Creates a new plan group
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. | ||||||||
|
group_name | string | 30 | Name of plan group | ||||||||
|
group_desc | string | 300 | Description of plan group | ||||||||
|
group_usage | string | 4 | Indicate usage of plan group.
Allowable values for group_usage:
|
||||||||
| client_plan_change_group_id | string | 100 | Client defined unique identifier | |||||||||
| group_plans | string | List of plans to be associated to this plan group. Please note that this list must contain valid plan numbers for that particular client number or the API will error | ||||||||||
| OR | ||||||||||||
| group_plan_ids | string | List of client plan ids to be associated to this plan group. Please note that this list must contain valid plan numbers for that particular client number or the API will error |
Output Arguments
| 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. |
| group_no | int | Unique identifier for plan group |
- © Copyright 2023 Aria Developer Central