Skip to main content
Aria Knowledge Central

acct_plan_install_complete_m

Summary

API Name acct_plan_install_complete_m
Class account_services_m
Update Version 35

Description

For accounts with master plans in the pending installation status, marks the installation as failed or successful, causing the master plan to be either terminated or activated accordingly.

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 Yes

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

master_plan_instance_no long 22 No

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id

client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no

install_complete_ind string   No

Boolean indicating the account installation process is complete.

Allowed values:

Value Description
False  
True  
comments string 500 No

Additional explanatory text relating to this API call.

client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

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.

TOP
  • Was this article helpful?