Skip to main content
Aria Knowledge Central

update_user_m Guide

API Specification:

update_user_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <username>

Error Codes

Error Code/Description Associated Inputs

1004: authentication error

Associated Inputs: auth_key, client_id, client_no

<auth_key>, <client_no>, client_role_id>

1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)

Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id

Alternate Message Output

1010: username is required
1010: first name is required
1010: last name is required
1010: email is required
1010: roles are required

Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m

Associated Inputs: username, first_name, last_name, email, role_no

Alternate Message Output Associated Inputs: <username>, <first_name>, <last_name>, <email>, <role_no>

1012: invalid input format

Associated Inputs: client_receipt_id

Additional Comments: This value must be unique for a client and must be alphanumeric. A previously used client_receipt_id can be reused if all those previous calls have failed (with an error_code other than 0/OK), if the client parameter NEVER_ALLOW_USED_RECEIPT_ID = FALSE.

Alternate Message Output

1012: email is invalid
1012: include_archived_user is invalid
1012: status is invalid

Associated APIs: create_user_m, get_users_m, update_user_m

Associated Inputs: email, include_archived_user, status

<client_role_id>

Alternate Message Output Associated Inputs: <email>, <status>

1013: Object does not exist, Threshold Rule not found: AriaNo ($AriaNo) or Billing Group not found: AriaNo ($AriaNo)

Associated Inputs: billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id

Alternate Message Output

1013: role_no is invalid
1013: username is invalid
1013: user does not exist
1013: client_role_id is invalid

Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m

Associated Inputs: role_no, username, client_role_id

Alternate Message Output Associated Inputs: <role_no>, <username>, <client_role_id>

1014: action not allowed

Alternate Message Output

1014: Maximum user limit reached
1014: This user cannot be deleted
1014: Archived users cannot be updated
1014: Status cannot be updated to Pending Activation

Associated APIs: create_user_m, delete_user_m, update_user_m

Associated Inputs: role_no, username, status

Alternate Message Output Associated Inputs: <role_no>, <username>, <status>

1016: invalid input, acct_no: (acct_no) is not a valid long, assignment_directive: (assignment_directive) is not a valid long, “billing_group_no: (billing_group_no) is not a valid long, threshold_billing_rule_no: (threshold_billing_rule_no) is not a valid long

Associated Inputs: alt_service_no_to_apply, assignment_directive, auto_skip_to_next_bill_date, client_billing_group_id, custom_rate_service_no/custom_rate_client_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_service_no, eligible_plan_no, eligible_service_no, email, force_master_bill_date_reset, fulfillment_only, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, invoice_no, length_months, end_date, limit, limit_records, modify_directive, contract_plan_instances_update, modify_directive, contract_plan_instances_update, offset, percent_amount, percent_eval_plan_instance_no, client_percent_eval_plan_instance_id, percent_eval_service_no, client_percent_eval_service_id, phone_ext, work_phone_ext, plan_unit_inst_status_cd, plan_units, reason_code, start_date, end_date, start_date, end_date, status_cd, acct_no, assignment_directive, billing_group_no, threshold_billing_rule_no

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

  • For the get_order_m API, this is the error code returned when the user passes an invalid order value for the <status_filter_cd> input which is other than the allowed values (0/null, 1, 2, 3, 4 and 5).
  • For the bulk_cancel_order_m API, invalid input can occur with the <order_status_directive> argument. Allowed values are 0, 1, 2, 3, 4/null, 5 and 6.
  • For the get_acct_coupon_details_m API, invalid input can occur with the <include_all_active> input parameter (values are 0, 1 or NULL).

Alternate Message Output

1016: username cannot be longer than 30 characters
1016: first_name cannot be longer than 30 characters
1016: last_name cannot be longer than 30 characters

Associated APIs: create_user_m, update_user_m

Associated Inputs: username, first_name, last_name

<email>, <status>

Alternate Message Output Associated Inputs: <username>, <first_name>, <last_name>

 

  • Was this article helpful?