ban_acct_m
Summary
| API Name | ban_acct_m |
|---|---|
| Class | account_services_m |
| Update Version | 33 |
Description
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).
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 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||||
| account_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If userid is valued, this value must be blank. Alternative required field: userid or client_acct_id |
||||||||||||||
| userid | string | 32 | Yes |
User's unique identifier. If account_no is valued, this value must be blank. Alternative required field: account_no or client_acct_id |
||||||||||||||
| days_to_restore | long | 8 | No |
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 | No |
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 | No |
Reason this account was banned Allowed values:
|
||||||||||||||
| 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: account_no or userid |
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. |