Home > Aria6 User Documentation > Aria6 core api > get_acct_plan_unit_instance_all
get_acct_plan_unit_instance_all
get_acct_plan_unit_instance_all
Array of all Plan Unit Instances and related Plan Unit Instance fields for all the plans under the account.
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. | ||||||||||
| acct_no | long | 22 | Aria assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||||||
| OR | ||||||||||||||
| client_acct_id | string | 50 | This is the client-assigned identifier for the account. | |||||||||||
| plan_no | long | 22 | The unique plan identifier. | |||||||||||
| OR | ||||||||||||||
| client_plan_id | string | 100 | Client defined Plan ID for which to query available child plans | |||||||||||
| plan_unit_inst_no | long | 22 | Assigned plan unit instance number. | |||||||||||
| OR | ||||||||||||||
| client_plan_unit_inst_id | string | 22 | Client-assigned identifier for the plan unit instance. | |||||||||||
| status_cd | long | 1 | Fulfillment status code.
Allowable values for status_cd:
|
|||||||||||
| plan_unit_inst_status_cd | long | 1 | Plan unit instance status code.
Allowable values for plan_unit_inst_status_cd:
|
|||||||||||
| fulfillment_only | long | 1 | This parameter governs whether only fulfillment based or all services should be outputted as part of plan unit instance details.
Allowable values for fulfillment_only:
|
|||||||||||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |||||||||||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. | ||||||||
| error_msg | string | Description of any error that occurred. "OK" if there was no error. | ||||||||
| acct_no | long | Aria generated unique identifier for the account. | ||||||||
| client_acct_id | string | Client-assigned identifier for the account. | ||||||||
| all_plan_unit_instances | hash | This return value is a multidimensional array describing the detail of all available plans. | ||||||||
| queued_ind |
string | Queued Indicator | ||||||||
| plan_no |
long | Aria assigned unique plan identifier | ||||||||
| client_plan_id |
string | Client defined unique plan identifier | ||||||||
| plan_name |
string | The name of the plan assigned | ||||||||
| plan_type |
string | Plan type valued as M for Master plan or S for Supplemental plan associated with the plan_no | ||||||||
| plan_unit_instance |
hash | This return value is a multidimensional array describing the detail of all available plans unit instances. | ||||||||
| plan_unit_inst_no |
long | Assigned plan unit instance number | ||||||||
| client_plan_unit_inst_id |
string | Client defined unique client plan unit instance identifier | ||||||||
| plan_unit_inst_status |
string | Plan Unit Instance Status, i.e. Active, Inactive, Queued. | ||||||||
| plan_unit_inst_services_info |
hash | This return value of array of plan services that are fulfillment based. | ||||||||
| service_no |
long | Aria defined unique identifier for service. | ||||||||
| client_service_id |
string | Client defined service id. | ||||||||
| service_name |
string | Name of the service. | ||||||||
| fulfillment_status |
string | Fulfillment status codes.
Allowable values for fulfillment_status:
|
||||||||
| fulfillment_date |
string | Date on which this service (or service unit) was/will be fulfilled. Only returned in case of fulfillment status code Queued OR fulfillment status Invoiced. | ||||||||
| plan_unit_inst_fields |
hash | Array of client-defined plan unit instance fields. | ||||||||
| field_name |
string | The machine-readable name of this field | ||||||||
| field_value |
string | The value stored in this field | ||||||||
| plan_unit_inst_directive |
long | This attribute is not in use. It is just a placeholder. |
- © Copyright 2023 Aria Developer Central