Skip to main content
Aria Knowledge Central

get_acct_plan_unit_instance_all_m Guide

Array of all Plan Unit Instances and related Plan Unit Instance fields for all the plans under the account.

API Specification: get_acct_plan_unit_instance_all_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Additional Guidance

Input Fields
Field Name Notes
<status_cd>
Allowable values
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>
Allowable values
Values Description
0 All Statuses (default)
1 Active
2 Inactive
3 Queued
<fulfillment_only>
Allowable values
Values Description
0 Default i.e. Output fulfillment based and non-fulfillment based services.
1 output only fulfillment based services.

Output Fields

Field Name Notes
<queued_ind>
Allowable values
Values Description
Q Contains Queued Unit Instances
A All Unit Instances are Assigned
<plan_type>
Allowable values
Values Description
M Master
S Supplemental
<fulfillment_status>
Allowable values
Values Description
1 Null i.e. No Fulfillment Date
2 Queued i.e. Queued for Invoicing
3 Invoiced

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error

 

1002: no data found

 

1004: authentication error

<auth_key>, <client_no>

1016: invalid input

Additional Comments:  This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.

<plan_instance_no>, <plan_instance_no>, <client_plan_instance_id>, <fulfillment_only>, <plan_unit_inst_status_cd>, <plan_units>, <acct_no>

14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".

Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.

<plan_instance_no>, <client_plan_instance_id>

14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".

<client_plan_instance_id>

27003: invalid Plan unit instance

<plan_unit_inst_no>

27004: invalid Plan unit instance id

<client_plan_unit_inst_id>

27011: The API is not supported because your client parameter Enable Plan Unit Instances is set to False. Please contact Aria Customer Support with questions about the Enable Plan Unit Instances client parameter.

<client_no>
  • Was this article helpful?