Wireless Account Lock Details

Wireless Account Lock Requests are used to lock specific Wireless Accounts. The following Requests can be made:

  • Lock and Unlock Wireless Accounts
  • Create exceptions on Wireless Account Locks
  • Request and Receive Wireless Account Lock History Reports
Request a Wireless Account Lock (WirelessAccountLockRequest)

The WirelessAccountLockRequest applies a lock to a specified Billing Account Number (BAN) to prevent users from completing a SimSwap or a Portout Request. It allows you to specify BAN and CTN level exceptions for the locked BAN.

(Note: Unlocking a BAN will unlock all BAN (SimSwap and Portout) exceptions and CTN exceptions)

The Wireless Account Lock Request should include the following information:

  • AccountGroupID (ID of the account you're modifying)
  • FoundationAccountNumber (FAN)
  • ManageListDetails (Group element)
    • BillingAccountNumber (BAN)
    • EnableLock (True/False)
    • BillingAccountNumberTransactionException (ADD / REMOVE) (SimSwap / Portout) (Optional)
    • CTNException List (ADD / REMOVE) (Optional)

Request a Wireless Account Lock History Report (WirelessAccountLockHistory)

You can request a Wireless Account Lock History Report to get the Lock History for a specific wireless BAN. To request the report, follow the 2-step (Generate Report / Retrieve Report) process under the API Reference / Reports menu item. This report is pull only, push is not available for this report type.

To request a Wireless Account Lock History Report, you will need to provide the following information:

  • AccountGroupID (ID of the account to generate a report about)
  • AccountType (Set to: "BAN")
  • AccountLevelValue (BAN number)
  • ReportType (Set to "wirelessAccountLockHistory")
  • fromDate (Start Date for the report data) (Optional)