get_acct_plan_unit_instance_all_m
Summary
| API Name | get_acct_plan_unit_instance_all_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.34 |
Description
Array of all Plan Unit Instances and related Plan Unit Instance fields for all the plans under the account.
Inputs
| Name | Type | Length | Required | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||||
| plan_instance_no | long | 22 | No |
The Master Plan Instance number from which plan unit instance details should be pulled. Alternative field: client_plan_instance_id |
||||||||||
| client_plan_instance_id | string | 100 | No |
Client-defined Master Plan Instance ID from which plan unit instance details should be pulled. Alternative field: plan_instance_no |
||||||||||
| plan_unit_inst_no | long | 22 | No |
Aria-assigned plan unit instance number that filters available plan unit instances for the Master Plan Instance number specified. Alternative field: client_plan_unit_inst_id |
||||||||||
| client_plan_unit_inst_id | string | 100 | No |
Client-assigned plan unit ID that filters available plan unit instances for the Master Plan Instance number specified. Alternative field: plan_unit_inst_no |
||||||||||
| status_cd | long | 1 | No |
Filters plan unit instances by fulfillment status code (e.g. All Statuses, No Fulfillment Date, Queued for Invoicing, or Invoiced). Allowed values:
|
||||||||||
| plan_unit_inst_status_cd | long | 1 | No |
Filters plan unit instances by plan unit instance status code (e.g. All Statuses, Active, Inactive, or Queued). Allowed values:
|
||||||||||
| fulfillment_only | long | 1 | No |
This parameter governs whether only fulfillment based or all services should be outputted as part of plan unit instance details. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| acct_no | long | No |
Note: This field is deprecated. Aria no longer supports acct_no. |
|
| client_acct_id | string | 50 | No |
Client-defined account identifier. |
| all_plan_instances | object | No |
This return value is a multidimensional array describing the detail of all available plans. |
|
| acct_no_2 | long | No |
all_plan_instances.plan_unit_inst_list.plan_unit_inst_service_details fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service_no | long | No |
Aria-defined unique identier for the service associated with the returned plan unit instance. |
|||||||||
| client_service_id | string | No |
Client-defined service ID associated with the returned plan unit instance. |
|||||||||
| service_name | string | No |
Name of the service associated with the returned plan unit instance. |
|||||||||
| fulfillment_status | string | No |
Fulfillment status codes. Allowed values:
|
|||||||||
| fulfillment_date | string | No |
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. |
all_plan_instances.plan_unit_inst_list.plan_unit_inst_fields fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_name | string | No |
The name of this plan unit instance field. |
|
| field_value | string | No |
The value stored in this plan unit instance field. |
|
| plan_unit_inst_directive | long | 8 | No |
This attribute is not in use. It is just a placeholder. |
all_plan_instances.plan_unit_inst_list fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_unit_inst_no | long | No |
Aria-assigned plan unit instance number. |
|
| client_plan_unit_inst_id | string | No |
Client-defined unique client plan unit instance identifier |
|
| plan_unit_inst_status | string | No |
Plan Unit Instance Status, i.e. Active, Inactive, Queued. |
|
| plan_unit_inst_service_details | object | No |
This return value of array of plan services that are fulfillment based. |
|
| plan_unit_inst_fields | object | No |
Array of client-defined plan unit instance fields. |
all_plan_instances fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| queued_ind | string | No |
Queued Indicator Allowed values:
|
|||||||
| plan_instance_no | long | No |
The Aria-assigned unique identifier for the plan instance. |
|||||||
| client_plan_instance_id | string | No |
The client-defined identifier of the plan instance. |
|||||||
| parent_plan_instance_no | long | 22 | No |
Aria-assigned Master Plan Instance number for the supplement plan (if applicable). |
||||||
| plan_name | string | No |
The name of the plan returned. |
|||||||
| plan_type | string | No |
Plan type associated with the plan returned by this call. Allowed values:
|
|||||||
| plan_unit_inst_list | object | No |
This return value is a multidimensional array describing the detail of all available plans unit instances. |