NM_GetSearchCategories


Definition

Retrieve Premium Domain search categories and subcategories.

Usage

Use this command to retrieve search categories and/or subcategories for Premium Domains.

You can use this command to populate the Category and Subcategory values in the NM_Search command.These would typically be rendered as Category and Subcategory menus in a user interface.

Availability

Only our direct ETP resellers can sell Premium Domains.

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.

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
Display Optional; default is All Which part of the search category taxonomy to display. Permitted values are: All Retrieve all categories and sub categories Categories Retrieve categories Subcategories Retrieve the subcategories for one category 13
CategoryID Optional overall, but Required if Display= Subcategories Which category to display subcategories for. Permitted values are category ID numbers, which you can retrieve by running this command with Display=Categories. 3
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
ID Identification number of this category or subcategory
ParentID Identification number of this subcategory’s parent category
Name Name of this category or subcategory
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