Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > 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
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 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
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
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
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-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.
queued_ind string Queued Indicator   Allowable Values
plan_instance_no long The Aria-assigned unique identifier for the plan instance.
client_plan_instance_id string The client-defined identifier of the plan instance.
parent_plan_instance_no long Aria-assigned Master Plan Instance number for the supplement plan (if applicable).
plan_name string The name of the plan returned.
plan_type string Plan type associated with the plan returned by this call.   Allowable Values
plan_unit_inst_list hash This return value is a multidimensional array describing the detail of all available plans unit instances.
plan_unit_inst_no long Aria-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_service_details hash This return value of array of plan services that are fulfillment based.
service_no long Aria-defined unique identier for the service associated with the returned plan unit instance.
client_service_id string Client-defined service ID associated with the returned plan unit instance.
service_name string Name of the service associated with the returned plan unit instance.
fulfillment_status string Fulfillment status codes.   Allowable Values
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 name of this plan unit instance field.
field_value string The value stored in this plan unit instance field.
plan_unit_inst_directive long This attribute is not in use. It is just a placeholder.

You must to post a comment.
Last modified
12:50, 12 Oct 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.