update_plan_group_m
Summary
| API Name | update_plan_group_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Edit an existing plan group
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. |
||||||||
| group_no | long | 22 | Yes |
Unique identifier for plan group Alternative required field: client_plan_change_group_id |
||||||||
| group_name | string | 30 | Yes |
Name of plan group |
||||||||
| group_desc | string | 300 | Yes |
Description of plan group |
||||||||
| group_usage | string | 4 | Yes |
Indicate usage of plan group Allowed values:
|
||||||||
| client_plan_change_group_id | string | 100 | Yes |
Client defined unique identifier Alternative required field: group_no |
||||||||
| group_plans | string | No |
"|" separated 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 Alternative field: group_plan_ids |
|||||||||
| group_plan_ids | string | No |
"|" separated 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 Alternative field: group_plans |
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. |
|
| group_no | long | 22 | No |
Unique identifier for plan group |