Home > Aria Crescendo Documentation > Aria Crescendo core api > ban_acct_m

ban_acct_m

Sets an account's status to temporary ban and, optionally, specifies when the ban will be removed and the account returned to its previous status: either on a specific date (date_to_restore) or after a specified number of days (days_to_restore).

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 account_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If userid is valued, this value must be blank.
 

OR
 

      
 

userid
 

OR
 

client_acct_id

string



 

string

32



 

50

Account's user ID.

 



Client-defined account identifier.

Note: If you pass in a <client_acct_id>, an <account_no>, and a <userid> Aria will use this order of precedence to decide which account to take action on:

  1. <account_no>
  2. <userid>
  3. <client_acct_id>
  days_to_restore long 8 Number of days before the account is restored. Use this or date_to_restore to specify length of ban. If date_to_restore is valued, this field is ignored. Use this field or date_to_restore to specify when the account will be restored.
  date_to_restore string 10 Date in yyyy-mm-dd format that the account will be restored. If this field is valued, days_to_restore is ignored. Use this field or days_to_restore to specify when the account will be restored.
  reason_cd long 8 Reason this account was banned  

Allowable values for reason_cd:

Values Description
0 General Acceptable Use Policy violation
1 Subscriber harassment
2 Spamming (communication policy violation)
3 Cheating
4 Use of inappropriate language
5 Ignoring instructions of system administrator
  comments string 500 Additional explanatory text relating to this API call.
  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.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®