get_plan_group_details_m
Summary
| API Name | get_plan_group_details_m |
|---|---|
| Class | administration_services_m |
| Update Version | 5.6 |
Description
Returns details of specified 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 | 30 | Yes |
Plan group number Alternative required field: client_plan_change_group_id |
||||||
| client_plan_change_group_id | string | 100 | Yes |
Client defined identifier for Plan group number Alternative required field: group_no |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
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 |
| client_plan_change_group_id | string | 100 | No |
Client defined unique identifier |
| group_name | string | 30 | No |
Name of plan group |
| group_desc | string | 300 | No |
Description of plan group |
| group_usage | string | 30 | No |
Indicate usage of plan group values: - value: 1 description: CSR only - value: 2 description: USS only - value: 3 description: Both CSR and USS |
| plans | object | No |
The plans associated with this method. |
|
| plan_group_translation_info | object | No |
Array that contains all the translated values for a given locale. |
plans fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_desc | string | 300 | No |
Specifies plan description |
| plan_no | long | 100 | Yes |
Plan Number |
plan_group_translation_info.plans_t fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_name | string | 100 | No |
Name of plan |
| plan_desc | string | 300 | No |
Specifies plan description |
| plan_no | long | 100 | No |
Aria-assigned unique plan identifier |
plan_group_translation_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| plans_t | object | No |
The plans_t associated with this method. |