ListDomainHeaders


Definition

Retrieve a list of domain headers (pointers for domain names) and host headers for a Web hosting account.

Usage

Use this command to list the domain headers and host headers for one Web hosting account.

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

In the Domains column, the modify link calls the ListDomainHeaders 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.
  • The domain header must belong to this Web hosting 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 the Web hosting account for which you want a list of domain headers 14
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Domain Domain associated with the headers listed in this node
WebHostDomainID ID number from our internal records
HostHeaders Number of headers available for this host account
HostHeaderCount Number of domain headers currently defined for this domain
WebHostHeaderID ID number from our internal records
HostName Name of the host record, to be used in the URL
FilePath File path location of this host record
DomainCount Number of domains associated with this Web hosting account
ServerType Operating system for the Web hosting server for this Web hosting account
Successful Success status of this query
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