Home > Aria6 User Documentation > Aria6 core api > 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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png 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.
  client_acct_id string 50 This is the client-assigned identifier for the account.
  plan_no long 22 The unique plan identifier.
  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.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
brd_arrow.gif queued_ind string Queued Indicator
brd_arrow.gif plan_no long Aria assigned unique plan identifier
brd_arrow.gif client_plan_id string Client defined unique plan identifier
brd_arrow.gif plan_name string The name of the plan assigned
brd_arrow.gif plan_type string Plan type valued as M for Master plan or S for Supplemental plan associated with the plan_no
brd_arrow.gif plan_unit_instance hash This return value is a multidimensional array describing the detail of all available plans unit instances.
brd_arrow.gif plan_unit_inst_no long Assigned plan unit instance number
brd_arrow.gif client_plan_unit_inst_id string Client defined unique client plan unit instance identifier
brd_arrow.gif plan_unit_inst_status string Plan Unit Instance Status, i.e. Active, Inactive, Queued.
brd_arrow.gif plan_unit_inst_services_info hash This return value of array of plan services that are fulfillment based.
brd_arrow.gif service_no long Aria defined unique identifier for service.
brd_arrow.gif client_service_id string Client defined service id.
brd_arrow.gif service_name string Name of the service.
brd_arrow.gif fulfillment_status string Fulfillment status codes. 

Allowable values for fulfillment_status:

brd_arrow.gif 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.
brd_arrow.gif plan_unit_inst_fields hash Array of client-defined plan unit instance fields.
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif plan_unit_inst_directive long This attribute is not in use. It is just a placeholder.
Last modified


This page has no custom tags.


This page has no classifications.