GetHostHeader


Definition

List attributes of a host header (pointer for a third-level domain name) in your Web hosting account.

Usage

Use this command to retrieve information about a host header in your Web hosting account.

Availability

All resellers have access to this command.

Implementation on eNom.com

This command is not implemented on enom.com.

Constraints

The query must meet the following requirements:

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

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 that contains the host header you are inquiring about 14
SLD Required Second-level domain name (for example, enom in enom.com) 63
TLD Required Top-level domain name (extension) 15
HostName Required Host header (third-level domain name) that you want information about 53
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
HostName Host header (third-level domain name) that the software looked for
Path Directory path to the host header
HostHeaderID Host header ID number, our internal record
Successful Successful completion status of the query
HostHeaderFound Return status of the host header; whether the software found the host header
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 XMLformat, 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