WebHostGetOverageOptions


Definition

Retrieve the permitted options for handling bandwidth overages.

Usage

Use this command to retrieve the permitted values–ID numbers and brief descriptions–for handling bandwidth overages. Overage handling is set by the end user on each individual 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/hostingconfig.asp?

Step 2 displays the options for the WebHostGetOverageOptions command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

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
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
OptionIDX
(Responses in HTML and text format are numbered, X=1 to 3
ID number of bandwidth-overage option X
DescriptionX Text description of bandwidth-overage option X
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 parameterErr(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example