Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_plan_unit_instance_all_m

get_acct_plan_unit_instance_all_m

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.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  plan_instance_no long 22 The Master Plan Instance number from which plan unit instance details should be pulled.
  OR      
  client_plan_instance_id string 100 Client-defined Master Plan Instance ID from which plan unit instance details should be pulled.
  plan_unit_inst_no long 22 Aria-assigned plan unit instance number that filters available plan unit instances for the Master Plan Instance number specified.
  OR      
  client_plan_unit_inst_id string 100 Client-assigned plan unit ID that filters available plan unit instances for the Master Plan Instance number specified.
  status_cd long 1 Filters plan unit instances by fulfillment status code (e.g. All Statuses, No Fulfillment Date, Queued for Invoicing, or Invoiced).  

Allowable values for status_cd

Values Description
0 All Statuses (default)
1 Null i.e. No Fulfillment Date
2 Queued i.e. Queued for Invoicing
3 Invoiced
  plan_unit_inst_status_cd long 1 Filters plan unit instances by plan unit instance status code (e.g. All Statuses, Active, Inactive, or Queued).  

Allowable values for plan_unit_inst_status_cd

Values Description
0 All Statuses (default)
1 Active
2 Inactive
3 Queued
  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

Values Description
0 Default i.e. Output fulfillment based and non-fulfillment based services.
1 output only fulfillment based services.
  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-assigned account identifier. This value is unique across all Aria-managed accounts. DEPRECATED
acct_no_2 long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
all_plan_instances hash This return value is a multidimensional array describing the detail of all available plans.
brd_arrow.gif queued_ind string Queued Indicator  

Allowable values for queued_ind

Values Description
Q Contains Queued Unit Instances
A All Unit Instances are Assigned
brd_arrow.gif plan_instance_no long The Aria-assigned unique identifier for the plan instance.
brd_arrow.gif client_plan_instance_id string The client-defined identifier of the plan instance.
brd_arrow.gif parent_plan_instance_no long Aria-assigned Master Plan Instance number for the supplement plan (if applicable).
brd_arrow.gif plan_name string The name of the plan returned.
brd_arrow.gif plan_type string Plan type associated with the plan returned by this call.  

Allowable values for plan_type

Values Description
M Master
S Supplemental
brd_arrow.gif plan_unit_inst_list 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 Aria-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_service_details hash This return value of array of plan services that are fulfillment based.
brd_arrow.gif service_no long Aria-defined unique identier for the service associated with the returned plan unit instance.
brd_arrow.gif client_service_id string Client-defined service ID associated with the returned plan unit instance.
brd_arrow.gif service_name string Name of the service associated with the returned plan unit instance.
brd_arrow.gif fulfillment_status string Fulfillment status codes.  

Allowable values for fulfillment_status

Values Description
1 Null i.e. No Fulfillment Date
2 Queued i.e. Queued for Invoicing
3 Invoiced
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 name of this plan unit instance field.
brd_arrow.gif field_value string The value stored in this plan unit instance field.
brd_arrow.gif plan_unit_inst_directive long This attribute is not in use. It is just a placeholder.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®