GetHostAccount


Definition

Retrieve account and usage information about a Web hosting account.

Usage

Use this command to retrieve account information, limits, and this month’s usage-to-date information for a Web hosting account.

To retrieve day-by-day usage information, use the WebHostGetStats command.

To retrieve bandwidth overage information for end-of-month account reconciliation, use the

GetAccountOverages command.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/wsg/packagemanager.asp

Links in the Login Name column call the GetHostAccount command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The Web hosting account must belong to this account.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
HostAccount Required Name of Web hosting account. You can retrieve Web hosting account names using GetAllHostAccounts 14
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
WebHostID Web hosting package ID number from our internal records
HostAccount Web hosting account name
Password Web hosting account password
OSType Operating system of the computer in our data center that runs this account
DatabaseType The type of database support currently associated with this Web hosting account
BandwidthGB The bandwidth currently available to this Web hosting account per billing cycle, in GB
BandwidthUsedGB The bandwidth currently used by this Web hosting account, in GB
WebStorageMB Web storage space available to this Web hosting account, in MB
WebStorageUsedMB Web storage space currently used by this Web hosting account, in MB
DBStorageMB Database storage space available to this Web hosting account, in MB
DBStorageUsedMB Database storage space currently used by this Web hosting account, in MB
POPMailBoxes POP mail boxes allocated to this domain name
POPMailBoxCount POP mail boxes currently used by this domain name
OptionID Current setting for how to handle bandwidth overages
BillingDate Account creation date for bookkeeping purposes
Status Status of this Web hosting account
Price Subscription rate for this Web hosting account, per billing cycle
DomainHeaderCount Number of domain headers defined for this Web hosting account
SQLTableCount Number of SQL tables defined for this Web hosting account
Terminate Terminate flag. If True, this Web hosting account will be deleted at the end of this billing period.
TerminateDate Date on which this Web hosting account will be deleted, if one has been set
PercentBandwidthUsed Percentage of this month’s bandwidth allocation that has been used.
HasDisabledWSCAccount Has this WebSite Creator account been disabled?
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x) Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example