AssignToDomainFolder


Definition

Assign one or more domains to one folder.

Usage

Use this command to assign one or more domains to a folder. Most commonly, you’ll put domains in a standard folder to organize them; in a Magic Folder to manage settings.

You can assign domains in several ways:

  • Put a list of domains into a folder.
  • Move a list of domains from one folder to another, or from all folders where the domains currently reside to a single folder.
  • Copy a list of domains to a folder so that they are in multiple folders (but a domain can only be in one Magic Folder at a time; see Notes).
  • Remove a list of domains from a folder or from all folders.

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=registered

At the bottom of the domain list, when the LIST ACTIONS menu is set to a folder option, the GO button calls the AssignToDomainFolder command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The folder must belong to this login ID.
  • A domain can only be in one Magic Folder at a time. See Notes.

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
DomainNameList Required Comma-separated list of domain names to put into this folder.
Permitted format is sld1.tld1,sld2.tld2,sld3.tld3
1500
TransferMode Required Action to execute. Permitted values:
1 Copy to ToFolderName (and leave in all folders where it is currently placed)
2 Move to ToFolderName (and remove from FromFolderName or from all)
3 Remove from FromFolderName or from all folders
1
FromFolderName Ignored if TransferMode=1; Optional if TransferMode=2 or 3; default is * (all); If TransferMode=2 or 3, the query operates only on domains that are currently in FromFolderName. Permitted values are one folder name or * (all folders)
If TransferMode=2 and no value is provided for FromFolderName, domains are moved from all folders where they are currently associated, to ToFolderName.
If TransferMode=3 and no value is provided for FromFolderName, domains are deleted from all folders.
125
ToFolderName Required if TransferMode=1 or 2; Ignored if TransferMode=3 Assign the listed domains to this folder. Permitted value is one folder name. 125
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
ToFolderName Destination folder for domains
FromFolderName Source folder for domains
ID Domain name IDs. To retrieve the domain names from these IDs, use the GetDomainSLDTLD command.
TransferMode Type of reassignment done by this query. Values are:
1 Copy to ToFolderName (and leave in all folders where it is currently associated)
2 Move to ToFolderName (and remove from FromFolderName or from all folders where it is currently associated)
3 Remove from FromFolderName
Result Result of this query. Values are:
0 General failure
1 Success
2 Unable to add domains to folder
3 No such folder
4 Cannot move a domain from a folder to the same folder
5 At least one domain is not found as active in this account
6 At least one domain cannot be removed from folder because synchronization is in progress
7 At least one domain is already associated with another Magic Folder
8 Unable to remove domains from folder
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.
  • A domain can only be in one Magic Folder at a time.
  • If a query string uses a wildcard value when removing domains from folders, or does not specify a foldername (TransferMode=3&FromFolderName=*), it will remove the domains from all folders they arecurrently in.

Example