GetDomainFolderList


Definition

Retrieve a list of folders that a domain is in, or retrieve a list of all folders in an account.

Usage

Use this command to find out which folders a domain is in, or to retrieve a list of all folders in an 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/domains/Domain-Manager.aspx?tab=folder

The folders link calls the GetDomainFolderList command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The domain name 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
SLD Optional SLD (second-level domain name) of the domain for which you want to retrieve folder information. Use this parameter if you want information for one domain. Without SLD and TLD, the response lists all folders in the account. 63
TLD Optional TLD (top-level domain name) of the domain for which you want to retrieve folder information. Use this parameter if you want information for one domain. Without SLD and TLD, the response lists all folders in the account. 15
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Result Result of this query. Possible results are: 1 Successful
ID Folder identification number, assigned by us
Name Folder name, assigned by you
Type Folder type. Possible values are: 0 Standard folder; not Magic 1 Magic
DomainCount Number of domains in this folder
Status Status of this folder. Possible results are: 0 Standard 2 Magic, in sync 3 Magic, in process of synchronization 4 Magic, out of sync
Count Total number of folders in this account
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX 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