API Commands

For resellers of domain names and related services Version 4.1

December 1, 2008

12/1/08

 1999-2008 eNom, Inc.

eNom, Incorporated ("eNom" or "eNom.com"), at its sole discretion, may change the terms, conditions and operation of its application programming interface and related documents (the "API") at any time. Access to and use of the API is by license only. By using the API and documentation, you agree to the terms of this license (following). eNom hereby grants you a non-exclusive, non-transferable, royalty-free license, exercisable solely during the term of this license, to use the API solely for the purpose of accessing and using the services provided by eNom and, unless otherwise specified in writing, solely for your personal, non-commercial use. Except for the rights expressly granted above, this license does not transfer from eNom to you any eNom technology, and all rights, titles and interests in and to any eNom technology and the API shall remain solely with eNom. You shall not prepare any derivatives of the API or otherwise branch the API. It is understood that a derivative or "branch" of the API would be a new version of the API, with changed or additional functions (an application you build which includes unmodified API commands is not a derivative or branch of the API). You shall not create, apply for, or otherwise procure any patent or copyright interest in the API and any derivative ("IP Interest") thereof which IP Interest would block, impede, or make more expensive eNoms continued use and enjoyment of the API. You agree that if you breach the provisions of this section, that any IP Interests created thereby shall be assigned to eNom as a "work for hire" as this expression is defined in U.S. copyright law and/or that you will provide, at no cost to eNom, a royalty free license to use such IP Interests as required for eNoms continued use and enjoyment of the API. You shall not copy or use the API except as specified in this license or as otherwise specified by eNom in writing. You shall not use the API to communicate with or to control a system other than system(s) designated by eNom and you may not access or use eNoms services using any access mechanism other than the API. WE AND OUR ADVERTISERS, SUPPLIERS AND LICENSORS PROVIDE OUR PRODUCTS AND SERVICES "AS IS" AND WITHOUT ANY WARRANTY OR CONDITION, EXPRESS OR IMPLIED. WE AND OUR ADVERTISERS, SUPPLIERS AND LICENSORS SPECIFICALLY DISCLAIM ANY IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND WARRANTY OF NON-INFRINGEMENT. SOME STATES DO NOT ALLOW THE DISCLAIMER OF IMPLIED WARRANTIES, SO THE FOREGOING DISCLAIMER MAY NOT APPLY TO YOU. THIS WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS AND YOU MAY ALSO HAVE OTHER LEGAL RIGHTS WHICH VARY FROM STATE TO STATE. WITHOUT LIMITING THE FOREGOING, ENOM.COM SHALL NOT BE LIABLE TO YOU OR YOUR BUSINESS FOR ANY INCIDENTAL, CONSEQUENTIAL, SPECIAL, OR PUNITIVE DAMAGES OR LOST OR IMPUTED PROFITS OR ROYALTIES ARISING OUT OF THE USE OF THE API AND THIS DOCUMENT OR ANY GOODS OR SERVICES PROVIDED, WHETHER FOR BREACH OF WARRANTY OR ANY OBLIGATION ARISING THEREFROM OR OTHERWISE, WHETHER LIABILITY IS ASSERTED IN CONTRACT OR TORT (INCLUDING NEGLIGENCE AND STRICT PRODUCT LIABILITY) AND IRRESPECTIVE OF WHETHER YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF ANY SUCH LOSS OR DAMAGE. EACH PARTY HEREBY WAIVES ANY CLAIMS THAT THESE EXCLUSIONS DEPRIVE SUCH PARTY OF AN ADEQUATE REMEDY. "eNom" is a trademark or registered trademark of eNom, Inc. and may not be used without permission. Other product and company names mentioned in the API or this document may be the property of their respective owners. Parties who develop objects using the API are hereby granted a trademark license to use "eNom" in connection with such objects as described below. This license is contingent on your adherence to the following rules and, regardless of your compliance with these rules, may be revoked at any time at eNom's sole discretion: ________________ eNom _________________ OBJECTS* Where the first blank is mandatory and must be filled in with an expression composed of two or more letters, numbers, or symbols chosen by you. This expression can be a name or a trademark, provided you have permission or do not need permission to use it. This expression may not imply ownership of, affiliation with, or endorsement

12/1/08

by eNom (which precludes words such as "Authentic" or "Exclusive"). This expression may not use single letters and may not contain profanity. It is preferred that the term used in this first blank be in the possessive form (see examples), but this is optional. Where the second blank line is optional and may filled in with an expression composed of one or more letters, numbers, or symbols chosen by the developer. All the restrictions described for the first blank apply to this blank, except that you may use one letter in this blank. Where the "*" (or equivalent symbol) must be associated with a disclaimer, placed in reasonable proximity, which says, "Not affiliated with or endorsed by eNom, Incorporated." Where the (R) must either be represented exactly as is or where you use the superscript symbol denoting a registered trademark. Where capitalization of "eNom" is as indicated and capitalization of other characters is at your option. Where you agree to indemnify and hold eNom harmless, including attorney's fees and court costs, for any third party claim alleging that the expression(s) you use to complete the blank field(s) infringe any intellectual property rights or cause any other harm to such third party claimant. EXAMPLES: FRED'S .NET eNom OBJECTS* GREG'S eNom PHP OBJECTS* ACME eNom OBJECTS*

December 1, 2008

12/1/08

1999-2008 eNom, Inc.

Contents Contents
API command categories . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 API commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
AddBulkDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AddContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AddDomainFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AddToCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AdvancedDomainSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AssignToDomainFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AuthorizeTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertConfigureCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetApproverEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetCertDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertGetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertModifyOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertParseCSR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CertPurchaseCert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CheckLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CheckNSStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CommissionAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CreateSubAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteAllPOPPaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteDomainFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteFromCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteHostedDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeletePOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeletePOPPak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteRegistration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DeleteSubaccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 20 23 26 39 46 50 53 59 62 67 71 74 77 80 84 86 89 91 95 100 103 106 108 110 113 115 117 120 123 125 128

12/1/08

1999-2008 eNom, Inc.

DisableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EnableServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ExtendDomainDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAccountValidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAddressBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAgreementPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAllAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetAllDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetBalance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCartContent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetConfirmationSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetContacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCusPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCustomerDefinedData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetCustomerPaymentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDNSStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainFolderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainFolderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainNameID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSLDTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExtAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetFraudScore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetGlobalChangeStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetGlobalChangeStatusDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetHomeDomainList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetIPResolver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetMailHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPasswordBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

131 133 136 140 143 147 150 153 155 158 162 165 169 172 174 177 180 183 186 190 194 197 200 203 205 208 211 217 220 225 228 230 234 238 241 243 246 249 252 255 258 262 266 269 272 275 278 281 284 287 290 293 296 299

12/1/08

1999-2008 eNom, Inc.

GetPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPOPExpirations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetPOPForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegistrationStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRegLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetResellerInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSPFHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetServiceContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetSubaccountsDetailList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetTLDList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetTransHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetWebHostingAll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetWhoisContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetWPPSInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_CancelAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_ChangePassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_CreateAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetAccountDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HE_UpgradeAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . InsertNewOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ME_AddChannelReseller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyNSHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ModifyPOP3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NameSpinner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ParseDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetCustomerPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetDomainPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetPOPPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetProductPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetResellerPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetRetailPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetRetailPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetRocketPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_GetTLDID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PE_SetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preconfigure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PreRegAddList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purchase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchaseHosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchasePOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchasePreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PurchaseServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PushDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RefillAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RegisterNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

302 306 309 312 315 318 321 324 327 330 333 336 343 346 349 352 355 360 363 366 370 373 376 379 382 385 388 391 394 398 401 403 406 410 412 416 419 421 425 429 433 438 440 442 447 454 456 465 469 472 475 487 490 494

12/1/08

1999-2008 eNom, Inc.

RemoveTLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RemoveUnsyncedDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RenewPOPBundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RenewServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RPT_GetReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SendAccountEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ServiceSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetCatchAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetCustomerDefinedData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDNSHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainSRVHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDomainSubServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetDotNameForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetIPResolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetPOPForwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetRegLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetResellerServicesPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetResellerTLDPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetSPFHosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetUpPOP3User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . StatusDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SubAccountDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SynchAuthInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_CancelOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_CreateOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetDetailsByDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetOrderReview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetOrdersByDomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetOrderStatuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_GetTLDInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_ResendEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_ResubmitLocked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_SubmitOrder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TP_UpdateOrderDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateAccountPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateCart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateCusPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateDomainFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateMetaTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateNameServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateNotificationAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdatePushList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UpdateRenewalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ValidatePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

497 500 503 507 511 515 517 521 524 527 529 532 535 538 541 544 548 551 554 557 560 563 566 569 573 576 579 582 585 587 590 596 599 603 607 610 613 616 620 623 626 630 636 641 646 649 653 662 664 667 670 672 675 678

12/1/08

1999-2008 eNom, Inc.

WBLConfigure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WBLGetCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WBLGetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WBLGetStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetAccountInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetAllPackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_GetPricing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WSC_Update_Ops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

680 685 688 691 694 699 703 706

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709

12/1/08

1999-2008 eNom, Inc.

API command categories

1
API command categories
The following pages list the categories of commands in the API, and give you an overview of the commands that are available to you for each major type of task. Click on any command name to jump to its full description in the catalog.

Domain registration commands

AddBulkDomains Check DeleteRegistration GetAgreementPage GetConfirmationSettings GetExtAttributes GetTLDList NameSpinner Preconfigure Purchase

Preregistration commands
PreRegAddList

Domain management commandshost records

GetDomainSRVHosts GetHosts GetMetaTag GetRegHosts GetSPFHosts SetDomainSRVHosts SetHosts SetSPFHosts UpdateMetaTag

12/1/08

1999-2008 eNom, Inc.

API command categories:

Domain management commandsname servers

CheckNSStatus DeleteNameServer GetDNS GetDNSStatus GetHomeDomainList ModifyNS ModifyNSHosting RegisterNameServer SetDNSHost UpdateNameServer

Domain management commandscontact information

Contacts GetContacts GetExtAttributes GetWPPSInfo GetWhoisContact

Domain management commandsgeneral

AdvancedDomainSearch GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomainNameID GetDomains GetDomainSLDTLD GetDomainStatus GetExpiredDomains GetExtendInfo GetHomeDomainList GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword ParseDomain RPT_GetReport SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

Domain management commandsMagic Folders

AddDomainFolder AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

10

1999-2008 eNom, Inc.

API command categories:

Domain renewal commands

Extend Extend_RGP GetDomainExp GetExtendInfo GetRenew InsertNewOrder SetRenew UpdateExpiredDomains UpdateRenewalSettings

Domain transfer commands

PE_GetTLDID PE_SetPricing PushDomain RefillAccount SetResellerServicesPricing SetResellerTLDPricing SynchAuthInfo TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_GetTLDInfo TP_ResendEmail TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdateAccountPricing UpdatePushList

DNS hosting commands

DeleteHostedDomain ExtendDomainDNS PurchaseHosting SetDNSHost

12/1/08

11

1999-2008 eNom, Inc.

API command categories:

Domain services
DisableServices EnableServices GetDomainMap GetDomainPhone GetDomainServices GetHomeDomainList GetIPResolver ME_AddChannelReseller PurchaseServices RenewServices ServiceSelect SetDomainMap SetDomainPhone SetIPResolver

Service managemente-mail services

DeleteAllPOPPaks DeletePOP3 DeletePOPPak DisableServices EnableServices Forwarding GetCatchAll GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 GetPOPExpirations GetPOPForwarding HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount ModifyPOP3 PurchasePOPBundle RenewPOPBundle SetCatchAll SetDotNameForwarding SetPakRenew SetPOPForwarding SetUpPOP3User

Service managementidentity protection

DisableServices EnableServices GetWPPSInfo RenewServices

12/1/08

12

1999-2008 eNom, Inc.

API command categories:

Service managementBusiness Listing

WBLConfigure WBLGetCategories WBLGetFields WBLGetStatus

Service managementSSL certificates

CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts

Service managementChannelME.TV and Web Site Creator

ME_AddChannelReseller WSC_GetAccountInfo WSC_GetAllPackages WSC_GetPricing WSC_Update_Ops

12/1/08

13

1999-2008 eNom, Inc.

API command categories:

Account commands
AddContact AuthorizeTLD CheckLogin CreateAccount CreateSubAccount DeleteContact DeleteSubaccount GetAccountInfo GetAccountPassword GetAccountValidation GetAddressBook GetAllAccountInfo GetCusPreferences GetCustomerPaymentInfo GetFraudScore GetGlobalChangeStatus GetGlobalChangeStatusDetail GetOrderDetail GetOrderList GetReport GetResellerInfo GetSubAccountDetails GetServiceContact GetSubAccounts GetSubaccountsDetailList GetTLDList GetTransHistory GetWebHostingAll RemoveTLD RPT_GetReport SendAccountEmail SubAccountDomains UpdateAccountInfo UpdateCusPreferences UpdateRenewalSettings

Accounting commands
CommissionAccount GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice RefillAccount UpdateNotificationAmount

12/1/08

14

1999-2008 eNom, Inc.

API command categories:

Shopping cart commands

AddBulkDomains AddToCart DeleteFromCart GetCartContent InsertNewOrder PurchasePreview UpdateCart

Real-time purchase commands

Extend Extend_RGP HE_CreateAccount HE_UpgradeAccount Purchase PurchaseHosting PurchasePOPBundle PurchaseServices RenewPOPBundle RenewServices TP_CreateOrder TP_ResubmitLocked TP_SubmitOrder UpdateExpiredDomains

Reporting commands
DeleteCustomerDefinedData GetCustomerDefinedData GetOrderDetail GetOrderList GetReport GetTLDList GetTransHistory RPT_GetReport SetCustomerDefinedData

Customer support commands

DeleteCustomerDefinedData GetCustomerDefinedData GetServiceContact SetCustomerDefinedData

12/1/08

15

1999-2008 eNom, Inc.

API commands

2
API commands
This chapter is an alphabetic catalog of the commands in the API. The documentation for each command includes a description, input and return parameters, and an example query and response. Our API supports HTTPS protocol. Nearly all API query strings are sensitive in that they include a login and password, but query strings that include credit card information are particularly so. We recommend that you consider using HTTPS for greater security when transmitting sensitive information. The responses for many commands differ slightly depending on whether you request XML, HTML, or text output. For example, return parameters may be numbered for HTML and text, but not for XML responses. Its important to test each command and write your code based on the actual response format. Our API is not case sensitive (except passwords), but your coding application or language might be. This catalog is formatted for readability, not for the cases our API returns. If your system is case sensitive, test and write your code to conform with your individual case sensitivity requirements. Our API requires that queries be URL encoded. Domain names using non-English character sets must be PUNY encoded.

12/1/08

16

1999-2008 eNom, Inc.

API commands: AddBulkDomains

AddBulkDomains
Description
Definition
Add a list of items to the shopping cart.

Usage
Use this command when you want to add multiple items to the shopping cart.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/ListRegister.asp

On the Batch register page, the add to cart button calls the AddBulkDomains command.

Constraints
The domain names in your list must meet the following requirements: The domain names must be valid (see the domain-name constraints under Check). The domain names must use a supported top-level domain. The number of SLDs must match the number of TLDs.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=addbulkdomains& uid=YourAccountID&pw=YourAccountPassword&producttype=register& listcount=NumberDomainsToAdd&sld1=FirstSLD&tld1=FirstTLD& sld2=SecondSLD&tld2=SecondTLD&sld3=thirdSLD&tld3=ThirdTLD&responsetype=xml

Param name Obligation Definition

UID PW ProductType ListCount SLDX (X=1 to listcount) TLDX (X=1 to listcount) numyearsX (X=1 to listcount) Required Required Required Required Required Required Optional Account login ID Account password Type of product to add. Options are register or renew. Number of names to add Second-level domain name, for example, resellerdocs in resellerdocs.com Top-level domain name, for example, com in resellerdocs.com Number of years to renew

Max size
20 20 16 4 63 15 1

12/1/08

17

1999-2008 eNom, Inc.

API commands: AddBulkDomains

Param name Obligation Definition

AutoRenew Optional Auto-renew setting for all domains in this order. If AutoRenew=1, domains automatically update 30 days before expiration. If not passed, default value is 0.

Max size
1

RegLock

Optional

Registrar lock setting for all domains in this order. If 1 RegLock=1, domain cannot be transferred to another registrar without account holders permission. If not passed, default value is 1. Use the shopping cart for this order. Permitted values are 0 1 and 1. If UseCart=1, this bulk list will go into the shopping cart and be processed through our queue; our system does not return an order ID until all names have been processed. If UseCart=0, our system returns an order ID and locks up the entire funds for the order immediately; the funds remain locked until all names in the list are processed. UseCart=1 is required if UID is a retail account. Format of response. Options are Text (default), HTML, or XML. 4

UseCart

UseCart=1 is Required if UID is a retail account, otherwise Optional.

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query adds resellerdocs.com, resellerdocs2.net, and resellerdocs3.info to the shopping cart of account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=addbulkdomains& uid=resellid&pw=resellpw&producttype=register&listcount=3& sld1=resellerdocs&tld1=com&sld2=resellerdocs2&tld2=net& sld3=resellerdocs3&tld3=info&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <AddBulkDomains> <Item> <ItemName>resellerdocs.com</ItemName>

12/1/08

18

1999-2008 eNom, Inc.

API commands: AddBulkDomains

<ItemId /> <Price>29.95</Price> <ItemAdded>True</ItemAdded> </Item> <Item> <ItemName>resellerdocs2.net</ItemName> <ItemId /> <Price>29.95</Price> <ItemAdded>True</ItemAdded> </Item> <Item> <ItemName>resellerdocs3.info</ItemName> <ItemId /> <Price>29.95</Price> <ItemAdded>True</ItemAdded> </Item> <AllItemsSuccessful>True</AllItemsSuccessful> </AddBulkDomains> <Command>ADDBULKDOMAINS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddToCart Check DeleteFromCart GetCartContent InsertNewOrder Purchase PurchasePreview UpdateCart

12/1/08

19

1999-2008 eNom, Inc.

API commands: AddContact

AddContact
Description
Definition
Add a contact to the address book for an account.

Usage
Use this command to add a contact to the address book for an account. To retrieve the contacts in an address book, use the GetAddressBook command.

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.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW RegistrantOrganizationName RegistrantJobTitle RegistrantFirstName RegistrantLastName RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantPostalCode RegistrantStateProvince RegistrantStateProvinceChoice

Obligation
Required Required Optional Optional Required Required Required Optional Required Required Optional Optional

Definition
Account login ID Account password Registrant organization Registrant job title Registrant first name Registrant last name Registrant address Registrant additional address info Registrant city Registrant postal code Registrant state or province Registrant state or province choice: S state P province Registrant country

Max size
20 20 60 60 60 60 60 60 60 16 60 1

RegistrantCountry

Optional

60

12/1/08

20

1999-2008 eNom, Inc.

API commands: AddContact

Param name
RegistrantPhone

Obligation
Required

Definition
Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Email address for Whois Format of response. Options are Text (default), HTML, or XML.

Max size
20

RegistrantFax

Optional

20

RegistrantEmailAddress ResponseType

Required Optional

128 4

Returned parameters and values

Param name Definition
PartyID Command ErrCount Err(x) Done Party ID number for this contact, assigned by us Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query adds a party to the address book for account resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=addcontact& uid=resellid&pw=resellpw&RegistrantFirstName=john&RegistrantLastName=doe& RegistrantAddress1=111%20Main%20Street&RegistrantAddress2=Suite%20100& RegistrantCity=Hometown&RegistrantStateProvince=WA&RegistrantStateProvinceChoice=state& RegistrantPostalCode=99999&RegistrantCountry=us&RegistrantPhone=+800.5554444& RegistrantFax=+800.5554445&[email protected]& responsetype=xml

In the response, a Party ID and an ErrCount value of 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <Contact> <RegistrantPartyID>{FFD61956-8D43-45FB-BC38-E0EE23331503}</RegistrantPartyID> </Contact> <Command>ADDCONTACT</Command> <Language>en</Language>

12/1/08

21

1999-2008 eNom, Inc.

API commands: AddContact

<ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>e</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.3164063</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
Contacts GetAddressBook GetContacts GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure

12/1/08

22

1999-2008 eNom, Inc.

API commands: AddDomainFolder

AddDomainFolder
Description
Definition
Create a folder for organizing or managing your domain names.

Usage
Use this command to create either a Standard folder that simply lets you organize your domains, or a Magic folder that allows you to apply the same settings to all the domains in the folder. This command creates folders; another command, UpdateDomainFolder, configures their settings. Settings that can be managed via a Magic folder include the following, in any combination: Auto-renew Registrar lock Access password DNS servers Host records Contact information (any combination of Registrant, Administrative, Auxiliary Billing, Technical)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/Domain-Manager.aspx?tab=folder&start=1

In the Create a new folder section, the GO button calls the AddDomainFolder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid.

12/1/08

23

1999-2008 eNom, Inc.

API commands: AddDomainFolder

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW FolderName

Obligation
Required Required Required

Definition
Account login ID Account password Folder name. Permitted characters are letters, numbers, hyphens, underscores, and spaces; name must begin with a letter or number. Description of folder or contents Type of folder to create. Permitted values: 0 Standard folder (for organizing and sorting) 1 Magic folder (a folder that allows you to manage settings of domains)

Max size
20 20 125

FolderDescription FolderType

Optional Optional; default is 0

256 1

CopyFolderName

Optional

Copy a folder into this folder, as well as leaving it in the 125 folder list. Permitted values are names of existing folders in this account. Copy one domain that is in another folder, and put it also in this folder. A domain can only be in one Magic folder at a time. The domain must be in this account. Permitted format is sld.tld 70

CopyDomainName Optional

ResponseType

Optional

Format of response. Options are Text (default), HTML, 4 or XML.

Returned parameters and values

Param name
FolderID FolderName FolderType FolderDescription Result

Definition
Identification number assigned by our database Folder name, as assigned by you Folder type. 0 indicates Standard folder, 1 indicates Magic folder. Folder description, as typed by you Result of running this query string. Values are: 0 Folder was not created 1 Folder was created successfully 2 A folder with this name already exists Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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.

12/1/08

24

1999-2008 eNom, Inc.

API commands: AddDomainFolder

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
The following query creates a new folder and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=AddDomainFolder& uid=resellid&pw=resellpw&FolderName=Favorites& FolderDescription=FolderForMyFavoriteNames&FolderType=1& CopyFolderName=Subfavorites&CopyDomainName=resellerdocs.com& responsetype=XML

In the response, the presence of your input values and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0"?> <interface-response> <AddResult> <FolderID>296</FolderID> <FolderName>Favorites</FolderName> <FolderType>1</FolderType> <FolderDescription>FolderForMyFavoriteNames</FolderDescription> <Result>1</Result> </AddResult> <Command>ADDDOMAINFOLDER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod></MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable></IsLockable> <IsRealTimeTLD></IsRealTimeTLD> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.047</ExecTime> <Done>true</Done> <debug><![CDATA[]]></debug> </interface-response>

Related commands
AdvancedDomainSearch AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

25

1999-2008 eNom, Inc.

API commands: AddToCart

AddToCart
Description
Definition
Add an item to the shopping cart.

Usage
Add an item to the shopping cart. To purchase items once they are in the shopping cart, use the InsertNewOrder command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Check the availability of a domain name.
http://www.enom.com/domains/Register.asp

On the register a name page, the add to cart button calls the AddToCart command. If the user selects multiple items, clicking the add to cart button calls the AddToCart command once for each item.

Constraints
The items a user attempts to add to the cart must meet the following requirements: If the item is a domain name, use the Check command to confirm that the name is available. The domain names must be valid (see the domain-name constraints under Check). The domain names must use a top-level domain supported by this registrar. The number of SLDs must match the number of TLDs.

Input parameters
Click the links below to go directly to specific products:

Product
Input parameters for domains Input parameters for dot-name Input parameters for ID Protect Input parameters for Business Listing Input parameters for POP Email Input parameters Hosted Microsoft Exchange Input parameters for Email Forwarding and URL Forwarding Input parameters for PDQ Input parameters for Web hosting Input parameters for Web Site Creator Input parameters for SSL certificates

12/1/08

26

1999-2008 eNom, Inc.

API commands: AddToCart

Input parameters for domains

Use the input parameters in the table below to add a domain name to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: Register Transfer Renew (Use Renew for all TLDs including .name bundles) RGP (Redemption Grace Period) Extended RGP Host (DNS hosting) Host Renew Second-level domain name (for example, enom in enom.com)

Max size
20 20 15

ProductType

Required

39

SLD

Required for Register Transfer Renew RGP Extended RGP Host Host Renew Required for Register Transfer Renew RGP Extended RGP Host Host Renew Optional for Register Transfer Renew Host Host Renew; default is duration you set in UpdateCusPreferences Optional for Register

63

TLD

Top-level domain name (extension)

15

Quantity

Number of years. Permitted values are 1 through 10; registration cannot extend beyond 10 years from today

AutoRenew

Do you want the name to attempt to renew 10 automatically (renewal will succeed if available account balance is sufficient)? Permitted values are 0 and 1 Do you want protection against 10 unauthorized transfer of this domain name? Permitted values are 0 and 1

RegLock

Optional for Register

12/1/08

27

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
UsePerm ClearItems

Obligation
Required for Extended RGP

Definition
For Extended RGP, required value is UsePerm=ok

Max size
10 3

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new the same query item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for dot-name

Use the input parameters in the table below to add a .name domain to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.

Max size
20 20 15

ProductType

Required

39 Type of product to add. Permitted values are: DotNameBundle DotNameForwarding (Use when the .name domain was purchased using the Purchase command and you want to add the .name Registrys email forwarding service. If a .name domain is purchased using the shopping cart, the Registrys email forwarding service is automatically bundled with the domain.) Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) 63

SLD

Required for DotNameBundle DotNameForwarding Required for DotNameBundle DotNameForwarding Optional; default is the duration you set in UpdateCusPreferences

TLD

15

Quantity

Number of years

ClearItems

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new item. Permitted value is yes. the same query To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

12/1/08

28

1999-2008 eNom, Inc.

API commands: AddToCart

Input parameters for ID Protect

Use the input parameters in the table below to add ID Protect to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: IDProtect (Whois Privacy Protection) IDProtectRenewal Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 15

ProductType

Required

39

SLD

Required for IDProtect IDProtectRenewal Required for IDProtect IDProtectRenewal Optional; default is 1

63

TLD

15

Quantity ClearItems

Number of years

2 3

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new item. Permitted value is yes. the same query To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for Business Listing

Use the input parameters in the table below to add ID Protect to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.

Max size
20 20 15

ProductType

Required

Type of product to add. For Business Listing, 39 values are BusListing and BusListingRenewal

12/1/08

29

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
SLD TLD Quantity ClearItems

Obligation
Required for BusListing and BusListingRenewal Required for BusListing and BusListingRenewal Optional; default is 1

Definition
Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Number of years

Max size
63 15 2 3

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new item. Permitted value is yes. the same query To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for POP Email

Use the input parameters in the table below to add POP Email to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: POP (10-mailbox pak with 1GB storage per mailbox) Renew-POP EmailStorage (512MB extra storage per mailbox) Second-level domain name (for example, enom in enom.com)

Max size
20 20 15

ProductType

Required

39

SLD

Required for POP Renew-POP EmailStorage Required for POP Renew-POP EmailStorage Optional for POP Renew-POP EmailStorage

10

TLD

Top-level domain name (extension)

10

Quantity

For ProductType=POP, the number of 2 10-mailbox paks to purchase for this domain. For ProductType=Renew-POP, the number of years to add to this POP pak subscription. For ProductType=EmailStorage, the number of 512MB units of storage to add to this pak.

12/1/08

30

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
ProductID

Obligation
Required for Renew-POP EmailStorage

Definition
POP pak ID number. To retrieve this value, use the GetPOP3 command.

Max size
3

ClearItems

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new the same query item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters Hosted Microsoft Exchange

Use the input parameters in the table below to add Hosted Microsoft Exchange to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW ProductType

Obligation
Required Required Required

Definition
Account login ID Account password For Hosted Microsoft Exchange, permitted values are: HostedExchange HostedExchangeUpgrade Second-level domain name (for example, enom in enom.com) for email address Top-level domain name (extension) for email address

Max size
20 20 39

SLD

Optional for HostedExchange Optional for HostedExchange Optional for HostedExchange

63

TLD Zone

15

15 Domain name, with host if desired, for email address. This is an optional alternative to SLD and TLD. Use format host.sld.tld

HostedExchangeLoginID

Required for For upgrading an existing Hosted 8 HostedExchangeUpgrade Microsoft Exchange account, the login ID of the account that you want to add components to. Permitted format is HXNNNNN Optional for HostedExchange; default is 1 Number of mailboxes to buy for a new Hosted Microsoft Exchange account. Permitted values are 1 to 255. 3

Quantity

MailboxQty

Required for Number of mailboxes to add to an HostedExchangeUpgrade existing Hosted Microsoft Exchange account. Permitted values are 0 to 254 (total, after this purchase, cannot exceed 255).

12/1/08

31

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
StorageMBQty

Obligation

Definition

Max size

3 Number of units of 100MB extra Optional for storage to buy (if you are HostedExchange or HostedExchangeUpgrade establishing a new Hosted Microsoft Exchange account now) or add (if you are upgrading storage for an existing Hosted Microsoft Exchange account). Storage is pooled: each unit of storage is shared among all mailboxes in this Hosted Microsoft Exchange account. Permitted values are 0 to 255 and cannot exceed 255 total for one Hosted Microsoft Exchange account. Optional for Number of BlackBerry users to HostedExchange or support (if new account) or add (if HostedExchangeUpgrade upgrading). Permitted values are 0 to 255 and cannot exceed 255 total for one Hosted Microsoft Exchange account. Number of ActiveSync users to Optional for support or add. Permitted values are HostedExchange or HostedExchangeUpgrade 0 to 255 and cannot exceed 255 total for one Hosted Microsoft Exchange account. Optional for Number of Good Mobile Messaging HostedExchange or (GoodLink) users to support or add. HostedExchangeUpgrade Permitted values are 0 to 255 and cannot exceed 255 total for one Hosted Microsoft Exchange account. Optional; you must also add Make all items currently in the cart another item to the cart in inactive (but keep them in the cart), and add a new item. Permitted value the same query is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML. 3

BlackBerryQty

ActiveSyncQty

GoodLinkQty

ClearItems

ResponseType

Input parameters for Email Forwarding and URL Forwarding

Use the input parameters in the table below to add Email Forwarding or URL Forwarding to the cart.

12/1/08

32

1999-2008 eNom, Inc.

API commands: AddToCart

Build the query string using this syntax:

http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew Second-level domain name (for example, enom in enom.com)

Max size
20 20 15

ProductType

Required

39

SLD

Required for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew Required for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew Optional for EmailForwarding EmailForwardingRenew URLForwarding URLForwardingRenew; default is 1

63

TLD

Top-level domain name (extension)

15

Quantity

Number of years

ClearItems

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new item. Permitted value is yes. the same query To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for PDQ

Use the input parameters in the table below to add PDQ to the cart.

12/1/08

33

1999-2008 eNom, Inc.

API commands: AddToCart

Build the query string using this syntax:

http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name Obligation

UID PW EndUserIP Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are BlackLabel BlackLabelRenew Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 15

ProductType

Required

39

SLD

Required for BlackLabel BlackLabelRenew Required for BlackLabel BlackLabelRenew Optional for BlackLabel BlackLabelRenew Optional; you must also add another item to the cart in the same query Optional

63

TLD

15

Quantity

Number of years

ClearItems

Make all items currently in the cart inactive (but keep them in the cart), and add a new item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for Web hosting

Use the input parameters in the table below to add Web hosting to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: WebHosting WebHostingSetupFee Number of months

Max size
20 20 15

ProductType

Required

39

Quantity

Optional; default is 1

12/1/08

34

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
WSCOption

Obligation
Optional; default is no WSC

Definition
Which WSC package, if any, to include in this Web hosting package. Permitted values are: WSCBasic WSCFull WSCEcommerce

Max size
14

HostID HostPW Package

Required for WebHosting Required for WebHosting Required for WebHosting Required for WebHosting

Web hosting account name. Must be alphanumeric and 6 to 14 14 characters in length. Web hosting account password. Must be alphanumeric and 6 to 14 characters in length. Web hosting package. Use the WebHostGetPackages command, in the Web hosting API catalog, to retrieve a list of permitted package names. Overage handling option. Permitted values are: 1 Automatically upgrade bandwidth 2 Charge overage fee 3 Temporarily disable until next month Name of domain to associate with this Web hosting account. Use format sld.tld Update www and @ host records to point to this Web hosting account. Permitted values are Yes or No. 1 14

OverageOption

Domain SetHostRecords ClearItems

Optional for WebHosting Required for WebHosting Optional; you must also add another item to the cart in the same query Optional

79 3

Make all items currently in the cart inactive (but keep them 3 in the cart), and add a new item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Input parameters for Web Site Creator

Use the input parameters in the table below to add Web Site Creator to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: LWSCBasic LWSCFull LWSCEcommerce

Max size
20 20 15

ProductType

Required

39

12/1/08

35

1999-2008 eNom, Inc.

API commands: AddToCart

Param name

Obligation

Definition
Account name for this Web Site Creator account. To retrieve this value, use the WSC_GetAllPackages API command. Permitted format is LWSCNNNxNNNN Web site ID number for this Web Site Creator account. To retrieve this value, use the WSCSiteID return value from the WSC_GetAllPackages API command. Number of years

Max size

LWSCAccountName Optional

LWSCWebSiteID

Required

Quantity ClearItems

Optional; default is 1

2 3

Optional; you must also add Make all items currently in the cart inactive another item to the cart in (but keep them in the cart), and add a new item. Permitted value is yes. the same query To reactivate items in the cart that are inactive, use the UpdateCart command. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Input parameters for SSL certificates

Use the input parameters in the table below to add an SSL certificate to the cart. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=AddToCart&UID=YourLoginID &PW=YourPassword&SLD=SLDValue&TLD=TLDvalue&ProductType=ProductToAdd& OptParam1=OptParamValue1&OptParam2=OptParamValue2

Param name
UID PW EndUserIP

Obligation
Required Required Required

Definition
Account login ID Account password

Max size
20 20

End users IP address. This is used in fraud checking, as 15 part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of product to add. Permitted values are: Certificate-GeoTrust-QuickSSL Certificate-GeoTrust-QuickSSL-Premium Certificate-GeoTrust-TrueBizID Certificate-GeoTrust-TrueBizID-Wildcard Certificate-GeoTrust-TrueBizID-EV Certificate-RapidSSL-RapidSSL Certificate-SBS-Secure Certificate-SBS-Secure-Plus Certificate-SBS-Instant Certificate-SBS-EV Certificate-SBS-SGC-EV 39

ProductType

Required

12/1/08

36

1999-2008 eNom, Inc.

API commands: AddToCart

Param name
Quantity ClearItems

Obligation
Required for all certs Optional; you must also add another item to the cart in the same query Optional

Definition
Number of years this SSL certificate should be active. Permitted values are 1 to 10.

Max size
2

Make all items currently in the cart inactive (but keep 3 them in the cart), and add a new item. Permitted value is yes. To reactivate items in the cart that are inactive, use the UpdateCart command. Format of response. Options are Text (default), HTML, 4 or XML.

ResponseType

Returned parameters and values

Param name Definition
ItemName ItemId Price ICANNFees CartItemID ItemAdded Command ErrCount Err(x) Done Domain name or service Item number Price for this product or service Fees charged by ICANN for this product or service ID number, assigned by us, of this item in your shopping cart True indicates this entire response has reached you successfully. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query adds resellerdocs.com to the shopping cart of account resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=addtocart& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&producttype=register& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <ItemName>resellerdocs.com</ItemName> <ItemId /> <Price>29.95</Price> <ItemAdded>True</ItemAdded> <Command>ADDTOCART</Command>

12/1/08

37

1999-2008 eNom, Inc.

API commands: AddToCart

<ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddBulkDomains DeleteFromCart GetCartContent GetHomeDomainList InsertNewOrder PurchasePreview UpdateCart

12/1/08

38

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

AdvancedDomainSearch
Description
Definition
Search the domains in your account.

Usage
Use this command to search domains that are in your 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.
http://enom.staging.local/domains/Domain-Manager.aspx?tab=search

The search button calls the AdvancedDomainSearch 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW TLDList

Obligation Definition
Required Required Optional; default is * Optional Account login ID Account password Comma-delimited list of TLDs to include in search results. Also permitted is *, which returns all TLDs that we offer. What part of domains to match? For example, SearchCriteria=Start&SLD=A returns all domains that start with A. Permitted values are Start End In Exact

Max size
20 20 120

SearchCriteria

12/1/08

39

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

Param name
SLD

Obligation Definition
Optional

Max size

String to match in domain name. Use with 8000 SearchCriteria to constrain results. For example, SearchCriteria=Start&SLD=A returns all domains that start with A. Permitted values are letters, numbers, and hyphens. 1 Return domains with numbers in the domain name? Permitted values are: 0 Exclude domain names containing numbers 1 Include domain names containing numbers Return domains with hyphens in the domain name? Permitted values are: 0 Exclude domain names containing hyphens 1 Include domain names containing hyphens Return parked domains? Permitted values are: 0 Return domains that are not parked 1 Return domains that are parked What registration status to return? Permitted values are Registered, Hosted, or Expired What auto-renew status to return? Permitted values are: 0 Auto-renew off 1 Auto-renew on What registrar lock status to return? Permitted values are: 0 Registrar lock off 1 Registrar lock on Date the domain was originally registered. Permitted format is MM/DD/YYYY 1

ExcludeNumbers

Optional

ExcludeDashes

Optional

ParkingStatus

Optional

RegistrationStatus AutoRenew

Optional Optional

10 1

Locked

Optional

CreationDate DaysTillExpires

Optional Optional

10

Return domains that are within this many days 7 of expiration date. Permitted values are integers 0 to 1000000 Return only domains that use our name servers? Permitted values are: Yes No Return domains that use this name server. Return domains with ID Protect? Permitted values are: 0 Domains with no subscription to ID Protect 1 Domains with ID Protect Return domains that have ID Protect thats due to expire within the number of days specified here. Permitted values are integers 0 to 1000000 Return domains with subscriptions to POP mail? Permitted values are: 0 No POP mail subscription 1 Subscribed to POP mail Return domains associated with Web hosting? Permitted values are: 0 No Web hosting subscription 1 Subscribed to Web hosting 5

NSStatus

Optional

NameServer HasIDProtect

Optional Optional

60 1

DaysUntilIDProtectExpires

Optional

HasPOPMail

Optional

HasWebHosting

Optional

12/1/08

40

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

Param name
IncludeSubaccounts

Obligation Definition
Optional

Max size

Include domains that fit the search criteria that 1 are in retail subaccounts? Permitted values are: 0 Exclude domain names in subaccounts 1 Include domain names in subaccounts Login name of subaccounts to include Permitted values are: SLD TLD NSStatus ExpDate Renew What number in the list to begin with in this response? For example, StartPosition=26&RecordsToReturn=25 returns domains 26 through 50 in the list. Number of domains to return in each response. For example, StartPosition=26&RecordsToReturn=25 returns domains 26 through 50 in the list. Maximum permitted value is 100. Retrieve domains associated with what types of folders? Permitted values are: 1 Domains that are not in any folders 2 Domains that are in at least one folder 3 Domains that are in any Magic folder 4 Domains that are in any standard folder 5 Domains that are only in a Magic folder 6 Domains that are only in a standard folder 7 Domains that are in folder FolderName 20 8

SubaccountLogin OrderBy

Optional Optional

StartPosition

Optional

RecordsToReturn

Optional

FolderOption

Optional

FolderName

Required when FolderOptio n=7 Optional

Return domains in this folder. Permitted value is 125 a folder name.

FolderSyncStatus

Synchronization status. Permitted values are: 1 Domains are in the process of synchronization 2 Domains are in sync 3 At least one domain is out of sync Permitted values are On or Off.

MultiLang ResponseType

Optional Optional

Format of response. Options are Text (default), 4 HTML, or XML.

Returned parameters and values

Param name
SP-TLDList SP-SLD SP-SearchCriteria SP-ParkingStatus SP-XML

Definition
Domains included in this return match these TLDs Domains included in this return include this character string in the SLD Domains included in this return include the SP-SLD value in this part of the SLD Returned domains match this parking status XML formatting options for this return

12/1/08

41

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

Param name
SP-RegistrationStatus SP-AutoRenew SP-Locked SP-DaysTillExpires SP-DaysExpired SP-NSStatus SP-HostRecordType SP-HostName SP-HostAddress SP-NameServer SP-HasIDProtect SP-HasPOPMail SP-EmailForwarding SP-HasWebHosting SP-ExcludeNumbers SP-ExcludeDashes SP-IncludeSubAccounts SP-SubAccountLogin SP-XMLResponse SP-RecordsToReturn SP-StartPosition SP-OrderBy SP-CustomerGroupName SP-FolderOption SP-FolderSyncStatus SP-FolderName TotalResults StartPosition NextPosition MultiRRP TLDOverride DomainNameID SLD TLD AutoRenew ExpDate DomainRegistrationStatus DeleteType NSStatus FolderStatus RRProcessor RRCompanyName HasIDProtect

Definition
Returned domains match this registration status Returned domains match this auto-renew setting Returned domains match this registrar lock setting Returned domains are within this many days of expiration Returned domains have expired in the last X days Returned domains match this name server status Not used Not used Not used Returned domains use this name server Returned domains match this ID Protect status Returned domains match this POP mail status Not used Returned domains match this Web hosting status If SP-ExcludeNumbers=1, returned domains do not contain numbers in the SLD If SP-ExcludeDashes=1, returned domains do not contain hyphens in the SLD If SP-IncludeSubAccounts=1, returned domains include domains in retail subaccounts Returned domains are in this subaccount XMLResponse setting This response includes this number of domains in a sorted list This response starts at this number in the sorted list Sort criterion for this list Not used Returned domains match this folder option Returned domains match this folder sync status Returned domains match this folder name Total number of domains that match these search criteria The first domain in this response is in this position in the overall sorted list of domains The next response will start at this position in the overall sorted list Multiple RRPs in this response? TLD override setting ID number for this domain SLD of this domain TLD of this domain Auto-renew setting of this domain Expiration date of this domain Registration status of this domain Delete status of this domain Is this domain using our name servers? Is this domain in any folders? Registrar credential of this domain name Registrar of record for this domain name Does this domain have ID Protect, and is it enabled?

12/1/08

42

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

Param name
DomainFolderStatus AbleToReactivate IsPremiumName PremiumPrice PremiumAboveThresholdPrice PremiumCategory ReactivatePrice WBLStatusID WBLStatus WBLExpDate WBLAutoRenew Command ErrCount Err(x) Done

Definition
Sync status of this domain If expired, can this name be reactivated? Is this a premium .tv name? Price for this premium .tv name Is the price for this premium .tv name above the premium threshold price? Premium category for a .tv name Price to reactivate this expired .tv name Status identifier for Business Listing for this domain name Description of status for Business Listing Expiration date for Business Listing Auto-renew setting for Business Listing Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves domains that match the specified search criteria, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=AdvancedDomainSearch& uid=resellid&pw=resellpw&SearchCriteria=Start&SLD=r&ExcludeNumbers=1& ExcludeDashes=1&OrderBy=ExpDate&responsetype=XML

In the response, a domain list and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainSearch> <SearchParams> <SP-TLDList /> <SP-SLD>r</SP-SLD> <SP-SearchCriteria>Start</SP-SearchCriteria> <SP-ParkingStatus /> <SP-XML> <DomainNames> <DomainName sld="r" location="Start" /> </DomainNames> </SP-XML> <SP-RegistrationStatus>Registered</SP-RegistrationStatus> <SP-AutoRenew /> <SP-Locked /> <SP-DaysTillExpires />

12/1/08

43

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

<SP-DaysExpired /> <SP-NsStatus /> <SP-HostRecordType /> <SP-HostName /> <SP-HostAddress /> <SP-NameServer /> <SP-HasIDProtect /> <SP-HasPOPMail /> <SP-EmailForwarding /> <SP-HasWebHosting /> <SP-ExcludeNumbers>1</SP-ExcludeNumbers> <SP-ExcludeDashes>1</SP-ExcludeDashes> <SP-IncludeSubAccounts /> <SP-SubAccountLogin /> <SP-XMLResponse>1</SP-XMLResponse> <SP-RecordsToReturn /> <SP-StartPosition>1</SP-StartPosition> <SP-OrderBy>ExpDate</SP-OrderBy> <SP-CustomerGroupName /> <SP-FolderOption /> <SP-FolderSyncStatus /> <SP-FolderName /> </SearchParams> <TotalResults>5</TotalResults> <StartPosition>1</StartPosition> <NextPosition>1</NextPosition> <MultiRRP>False</MultiRRP> <TLDOverride>0</TLDOverride> <Domains> <Domain> <DomainNameID>318265980</DomainNameID> <SLD>resellerdocs2</SLD> <TLD>net</TLD> <AutoRenew>0</AutoRenew> <ExpDate>1/9/2007</ExpDate> <DomainRegistrationStatus>Registered</DomainRegistrationStatus> <DeleteType /> <LoginID>resellid</LoginID> <AccountID>217-no-0647</AccountID> <NSStatus>NA</NSStatus> <FolderStatus>0</FolderStatus> <RRProcessor>E</RRProcessor> <RRCompanyName>eNom, Inc.</RRCompanyName> <HasIDProtect>disabled</HasIDProtect> <DomainFolderStatus>0</DomainFolderStatus> <WBLStatusID>0</WBLStatusID> <WBLStatus>Available</WBLStatus> <WBLExpDate /> <WBLAutoRenew /> </Domain> . . . <Domain> <DomainNameID>152533676</DomainNameID> <SLD>resellerdocs</SLD> <TLD>com</TLD> <AutoRenew>1</AutoRenew> <ExpDate>6/10/2014</ExpDate> <DomainRegistrationStatus>Registered</DomainRegistrationStatus> <DeleteType />

12/1/08

44

1999-2008 eNom, Inc.

API commands: AdvancedDomainSearch

<LoginID>resellid</LoginID> <AccountID>217-no-0647</AccountID> <NSStatus>NA</NSStatus> <FolderStatus>0</FolderStatus> <RRProcessor>E</RRProcessor> <RRCompanyName>eNom, Inc.</RRCompanyName> <HasIDProtect>disabled</HasIDProtect> <DomainFolderStatus>0</DomainFolderStatus> <WBLStatusID>0</WBLStatusID> <WBLStatus>Available</WBLStatus> <WBLExpDate /> <WBLAutoRenew /> </Domain> </Domains> </DomainSearch> <Command>ADVANCEDDOMAINSEARCH</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.438</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddDomainFolder AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

45

1999-2008 eNom, Inc.

API commands: AssignToDomainFolder

AssignToDomainFolder
Description
Definition
Assign one or more domains to one folder.

Usage
Use this command to assign one or more domains to a folder. Most commonly, youll 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.
http://enom.staging.local/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.

12/1/08

46

1999-2008 eNom, Inc.

API commands: AssignToDomainFolder

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW DomainNameList

Obligation
Required Required Required

Definition
Account login ID Account password

Max size
20 20

Comma-separated list of domain names to put into 1500 this folder. Permitted format is sld1.tld1,sld2.tld2,sld3.tld3 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

TransferMode

Required

FromFolderName

Ignored if TransferMode=1; Optional if TransferMode=2 or 3; default is * (all);

If TransferMode=2 or 3, the query operates only 125 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. Assign the listed domains to this folder. Permitted value is one folder name. 125

ToFolderName

Required if TransferMode=1 or 2; Ignored if TransferMode=3 Optional

ResponseType

Format of response. Options are Text (default), HTML, or XML.

Returned parameters and values

Param name
ToFolderName FromFolderName ID TransferMode

Definition
Destination folder for domains Source folder for domains Domain name IDs. To retrieve the domain names from these IDs, use the GetDomainSLDTLD command. 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

12/1/08

47

1999-2008 eNom, Inc.

API commands: AssignToDomainFolder

Param name
Result

Definition
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 Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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 folder name (TransferMode=3&FromFolderName=*), it will remove the domains from all folders they are currently in.

Example
The following query copies two domains into a folder and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=AssignToDomainFolder& uid=resellid&pw=resellpw&DomainIDList=152656650,152656651& ToFolderName=Lock&TransferMode=1&ResponseType=XML

In the response, a Result value 1 and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <AssignResult> <ToFolderName>Lock</ToFolderName> <FromFolderName>*</FromFolderName> <DomainNames> <ID>152656650</ID> <ID>152656651</ID> </DomainNames> <TransferMode>1</TransferMode> <Result>1</Result> </AssignResult> <Command>ASSIGNTODOMAINFOLDER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod />

12/1/08

48

1999-2008 eNom, Inc.

API commands: AssignToDomainFolder

<MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.078</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddDomainFolder AdvancedDomainSearch DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

49

1999-2008 eNom, Inc.

API commands: AuthorizeTLD

AuthorizeTLD
Description
Definition
Create or add to a list of TLDs that you offer to your resellers and retail customers.

Usage
Use this command to specify the TLDs that you offer to your resellers and retail customers. This command controls which TLDs your Web site can offer for registrations, renewals, and transfers. The first time you use this command, the list of TLDs we return to you switches from the list of all TLDs we offer, which is the default, to your own list that contains only the TLDs you authorize. You can also use this command to add to your list of authorized TLDs. When you want to add one TLD, run AuthorizeTLD with that single TLD. To revert from the authorized TLD mode back to the default mode (all TLDs that we support), or to remove TLDs from your list, use the RemoveTLD command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/Settings.asp

Clicking the TLD Pricing tab shows either the complete set of TLDs we offer, or the TLDs you have authorized.

Constraints
The query must meet the following requirements: The login ID and password must be valid. You can only authorize TLDs that we offer.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

50

1999-2008 eNom, Inc.

API commands: AuthorizeTLD

Param name Obligation

TLD Either TLD or DomainList is Required Either TLD or DomainList is Required Optional

Definition

Max size

One top-level domain (TLD) to add to your list of 15 authorized TLDs. For example, if you want to add .biz, use TLD=biz Comma-separated list of TLDs to add to your list of authorized TLDs. For example, if you want to add .com, .net, and .org, use DomainList=com,net,org Format of response. Options are Text (default), HTML, or XML. 100

DomainList

ResponseType

Returned parameters and values

Param name Definition
AuthorizeTLDX Command ErrCount Err(x) Done TLD to add to authorized list. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query authorizes TLDs .com, .net, and .org for account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=authorizetld uid=resellid&pw=resellpw&domainlist=com,net,org,info,biz&responsetype=xml

In the response, the list of TLDs and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <tldlist> <authorizetld>com</authorizetld> <authorizetld>net</authorizetld> <authorizetld>org</authorizetld> </tldlist> <Command>AUTHORIZETLD</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site /> <IsLockable />

12/1/08

51

1999-2008 eNom, Inc.

API commands: AuthorizeTLD

<IsRealTimeTLD /> <ExecTime>0.1523438</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetTLDList PE_SetPricing RemoveTLD SetResellerTLDPricing

12/1/08

52

1999-2008 eNom, Inc.

API commands: CertConfigureCert

CertConfigureCert
Description
Definition
Use this command to obtain information from the customer, which is needed to configure a cert.

Usage
The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder CertGetCerts

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertConfigureCert
(this command) CertParseCSR CertGetApproverEmail CertPurchaseCert CertModifyOrder (Optional)

Because the required parameters for this command exceed the length limits for many browser address bars, you should submit your HTTP request using the post instead of get method.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=289

The save changes button calls the CertConfigureCert command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account.

12/1/08

53

1999-2008 eNom, Inc.

API commands: CertConfigureCert

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW CertID

Obligation Definition
Required Required Required Account login ID Account password ID number for this individual certificate. Retrieve this number using the CertGetCerts command. Type of product to add. Permitted values are:

Max size
20 20 8

WebServerType (GeoTrust and RapidSSL certs on this page, SBS on next page)

Required

For GeoTrust and RapidSSL certs:

(see next page for SBS) 1 Apache + MOD SSL 2 Apache + Raven 3 Apache + SSLeay 4 C2Net Stronghold 7 IBM HTTP 8 iPlanet Server 4.1 9 Lotus Domino Go 4.6.2.51 10 Lotus Domino Go 4.6.2.6+ 11 Lotus Domino 4.6+ 12 Microsoft IIS 4.0 13 Microsoft IIS 5.0 14 Netscape Enterprise/FastTrack 17 Zeus v3+ 18 Other 20 Apache + OpenSSL 21 Apache 2 22 Apache + ApacheSSL 23 Cobalt Series 24 Cpanel 25 Ensim 26 Hsphere 27 Ipswitch 28 Plesk 29 Jakart-Tomcat 30 WebLogic (all versions) 31 OReilly WebSite Professional 32 WebStar 33 Microsoft IIS 6.0

12/1/08

54

1999-2008 eNom, Inc.

API commands: CertConfigureCert

Param name
WebServerType (SBS certs on this page; GeoTrust certs on previous page)

Obligation Definition
Required Type of product to add. Permitted values: For SBS certs: (see previous page for GeoTrust) 1000 Other 1001 AOL 1002 Apache/ModSSL 1003 Apache-SSL (Ben-SSL, not Stronghold) 1004 C2Net Stronghold 1005 Cobalt Raq 1006 Covalent Server Software 1007 IBM HTTP Server 1008 IBM Internet Connection Server 1009 iPlanet 1010 Java Web Server (Javasoft / Sun) 1011 Lotus Domino 1012 Lotus Domino Go! 1013 Microsoft IIS 1.x to 4.x 1014 Microsoft IIS 5.x and later 1015 Netscape Enterprise Server 1016 Netscape FastTrack 1017 Novell Web Server 1018 Oracle 1019 Quid Pro Quo 1020 R3 SSL Server 1021 Raven SSL 1022 RedHat Linux 1023 SAP Web Application Server 1024 Tomcat 1025 Website Professional 1026 WebStar 4.x and later 1027 WebTen (from Tenon) 1028 Zeus Web Server 1029 Ensim 1030 Plesk 1031 WHM/cPanel 1032 H-Sphere

Max size
4

CSR

Required

Certificate Signing Request. We 4500 recommend saving this value to use again in the CertParseCSR command. Click on the links to create a CSR: GeoTrust certs RapidSSL certs SBS certs Given name of ContactType contact. For example, AdminFName=John. 60

ContactTypeFName

Required for ContactType Admin, Tech, and Billing Required Optional for ContactType Admin, Tech, and Billing Optional

ContactTypeLName ContactTypeOrgName

Family name of ContactType contact. For example, AdminLName=Doe. Name of ContactTypes organization.

60 60

ContactTypeJobTitle

Contacts job title

60

12/1/08

55

1999-2008 eNom, Inc.

API commands: CertConfigureCert

Param name
ContactTypeAddress1 ContactTypeAddress2 ContactTypeCity ContactTypeState

Obligation Definition
Required Optional Required Either State or Province is Required for each ContactType Either State or Province is Required for each ContactType First line of Contacts address Second line of Contacts address Contacts city Contacts state

Max size
60 60 60 2

ContactTypeProvince

Contacts province

60

ContactTypeStateProvinceChoice Optional

Is Contacts location a state or province? Permitted values are: S state P province Contacts postal code Contacts country, in two-letter country code format Contacts phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Contacts phone extension Contacts fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Contacts email address. Use format [email protected] Format of response. Options are Text (default), HTML, or XML.

ContactTypePostalCode ContactTypeCountry ContactTypePhone

Required Required Required

16 2 17

ContactTypePhoneExt ContactTypeFax

Optional Optional

8 17

ContactTypeEmailAddress ResponseType

Required Optional

128 4

Returned parameters and values

Param name
CertID Success Organization DomainName Email HasBadExtensions IsValidQuickDomainName IsValidTrueDomainName Locality OrganizationUnit State Country

Definition
Identification number of this individual cert Has this cert been configured successfully? Organization embedded in this CSR Domain name embedded in this CSR Email addresss embedded in this CSR Any bad extensions? Valid quick domain name? Valid true domain name? Locality embedded in this CSR Organization unit embedded in this CSR State embedded in this CSR Country embedded in this CSR

12/1/08

56

1999-2008 eNom, Inc.

API commands: CertConfigureCert

Param name
ApproverType ApproverEmail Command ErrCount Err(x) Done

Definition
Type of this approver Email address of this approver Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
Because the required parameters for this command exceed the length limits for many browser address bars, you should submit your HTTP request using the post instead of get method. 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
The following query configures a cert, and sends the response in XML format:
http://resellertest.enom.com/ interface.asp?command=CERTCONFIGURECERT&uid=resellid&pw=resellpw&ResponseType=XML&Cert ID=289&Action=Configure&WebServerType=2&CSR=MIIDPjCCAqcCAQAwYzEYMBYGA1UEAxMPa2ltYm VybHlzaGluLnVzMQwwCgYDVQQLEwNLaW0xDDAKBgNVBAoTA0tpbTERMA8GA1UEBxMIQmVsbGV2dW UxCzAJBgNVBAgTAldBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA0gTzz YfBzisSajyZsb0wXPog%2FpHlmYZp5v7ta5LbgSQ0XbLGGXU7KYwrhFZqZ1pgboflWgYSEM%2BVwYc%2 B0AZHd5yeAZKFN08GhTQxgaV0oiK3Q1Nj4pNVsju%2B7uwiBI9v8S6Gyowa7LF4ZKcUWdHSX6e4%2Fg cgd1N%2FdWWQmzfpKisCAwEAAaCCAZkwGgYKKwYBBAGCNw0CAzEMFgo1LjAuMjE5NS4yMHsGCisGA QQBgjcCAQ4xbTBrMA4GA1UdDwEB%2FwQEAwIE8DBEBgkqhkiG9w0BCQ8ENzA1MA4GCCqGSIb3DQM CAgIAgDAOBggqhkiG9w0DBAICAIAwBwYFKw4DAgcwCgYIKoZIhvcNAwcwEwYDVR0lBAwwCgYIKwYBB QUHAwEwgf0GCisGAQQBgjcNAgIxge4wgesCAQEeWgBNAGkAYwByAG8AcwBvAGYAdAAgAFIAUwBBAC AAUwBDAGgAYQBuAG4AZQBsACAAQwByAHkAcAB0AG8AZwByAGEAcABoAGkAYwAgAFAAcgBvAHYAaQ BkAGUAcgOBiQAnUv2qmJCagvl02VUuQzY%2FpQVwxgwTVxQyJ08RQcQZ%2FE4HV5MZe7yuGC4l8NJx SLL2HVI6Qc7wKeMJAWhg%2BFv%2BJGFoJtu7VSw1%2BgkbWKYI%2FTsuvyTyA5bvrO6%2Bf7N9TkBtJ CMl%2F9JtfItk71MNt7hjZqSVGjZp5kFWbYZfPd7ONgAAAAAAAAAAMA0GCSqGSIb3DQEBBQUAA4GBAG vhsjZbtidJL48NqJecna5A0eIwGiizlYjJibLcdN6YnR%2BMN4BP8JmX8T2CJPnHOf2PIeXUujLhzv5bajXvHVT y1oG%2B%2FYLc%2B3LQzSm9rQXjMEk%2F1eJXi3OAShQX%2BS2GbyaUitu%2BlZ%2FK8QIzxCtoKf0 vNlzbB70fOjWWQqfJhVsm&AdminOrgName=Bel+Air&AdminJobTitle=Pres&AdminFName=F&AdminLN ame=Bern&AdminAddress1=516+Apple&AdminCity=Bel+Air&AdminState=MD&AdminPostalCode=21 014&AdminCountry=US&AdminPhone=5555555555&[email protected]&Te chOrgName=Bel+Air&TechJobTitle=Pres&TechFName=F&TechLName=Bern&TechAddress1=516+Appl e&TechCity=Bel+Air&TechState=MD&TechPostalCode=21014&TechCountry=US&TechPhone=5555555 555&[email protected]&BillingOrgName=Bel+Air&BillingJobTitle=Pres&Billing FName=F&BillingLName=Bern&BillingAddress1=516+Apple&BillingCity=Bel+Air&BillingState=MD&Bill ingPostalCode=21014&BillingCountry=US&BillingPhone=5555555555&[email protected]

In the response, a success value True confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertConfigureCert> <CertID>289</CertID>

12/1/08

57

1999-2008 eNom, Inc.

API commands: CertConfigureCert

<CSRData> <Success>True</Success> <Organization>Acme</Organization> <DomainName>resellerdocs.com</DomainName> <Email /> <HasBadExtensions>false</HasBadExtensions> <IsValidQuickDomainName>true</IsValidQuickDomainName> <IsValidTrueDomainName>true</IsValidTrueDomainName> <Locality>Townsville</Locality> <OrganizationUnit>Sales</OrganizationUnit> <State>WA</State> <Country>US</Country> </CSRData> <ApproverEmail /> <Success>True</Success> <Approver Type="Domain"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Domain"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> . . . </CertConfigureCert> <Command>CERTCONFIGURECERT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>1.328125</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts

12/1/08

58

1999-2008 eNom, Inc.

API commands: CertGetApproverEmail

CertGetApproverEmail
Description
Definition
Retrieve the email addresses of qualified approvers for the domain name embedded in a CSR.

Usage
The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder CertGetCerts CertConfigureCert CertParseCSR

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertGetApproverEmail
(this command) CertPurchaseCert CertModifyOrder (Optional)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=295

The save changes button calls the CertParseCSR command to retrieve the domain name associated with this CSR. Then, the CertGetApproverEmail command calls the authoritative WhoIs and retrieves the email address for the registrant of that domain.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account.

12/1/08

59

1999-2008 eNom, Inc.

API commands: CertGetApproverEmail

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Domain Required Required Required

Definition
Account login ID Account password Domain name that is associated with this cert, in format sld.tld. Use CertParseCSR or CertGetCertDetail to retrieve this value. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 79

ResponseType

Optional

Returned parameters and values

Param name Definition
Success ApproverType ApproverEmail Command ErrCount Err(x) Done Success status for retrieving the authoritative Whois registrant email Type of approver Email address of approver Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query queries the authoritative Whois database for the domain registrants email address, generates other email addresses that are likely to be valid approvers for the cert, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CertGetApproverEmail& uid=resellid&pw=resellpw&Domain=resellerdocs.com&ResponseType=XML

In the response, a Success status True confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertGetApproverEMail> <Success>True</Success> <Approver Type="Domain"> <ApproverEmail>[email protected]</ApproverEmail>

12/1/08

60

1999-2008 eNom, Inc.

API commands: CertGetApproverEmail

</Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Generic"> <ApproverEmail>[email protected]</ApproverEmail> </Approver> <Approver Type="Manual" /> </CertGetApproverEMail> <Command>CERTGETAPPROVEREMAIL</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.75</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts

12/1/08

61

1999-2008 eNom, Inc.

API commands: CertGetCertDetail

CertGetCertDetail
Description
Definition
Retrieve configuration information on one SSL certificate.

Usage
Use this command to retrieve detailed configuration information on one SSL certificate.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=288

The data on this page is supplied by the CertGetCertDetail command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW CertID ResponseType Required Required Required Optional

Definition
Account login ID Account password ID number of this cert. Use the CertGetCerts command to retrieve the ID number Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 8 4

Returned parameters and values

Param name
CertID DomainName

Definition
ID number of this individual cert Domain this cert is associated with

12/1/08

62

1999-2008 eNom, Inc.

API commands: CertGetCertDetail

Param name
ValidityPeriod OrderDate ConfigDate RenewalIndicator WebServerTypeID WebServerTypeName OrderID OrderDetailID ExpirationDate ServerCount ApproverEmail Message CertStatusID CertStatus ProdType ProdDesc CSR ReferenceID SSLCertificate ContactTypeOrgName ContactTypeJobTitle ContactTypeFName ContactTypeLName ContactTypeAddress1 ContactTypeAddress2 ContactTypeCity ContactTypeStateProvince ContactTypePostalCode ContactTypeCountry ContactTypePhone ContactTypeFax ContactTypeEmailAddress ContactTypePhoneExt WebServerTypeID WebServerTypeName WebServerTypeCode Command ErrCount Err(x) Done

Definition
Total validity duration of this cert, in months Date on which this cert was ordered Date on which this cert was installed Renewal indicator setting for this cert ID number of the type of server this cert is configured for Text description of the type of server this cert is configured for ID number of the order that included this cert Item ID number of this cert when it was ordered Expiration date of this cert Should always be 1 Email address of the registrant Message ID number that identifies this certs phase in its processing Text description of this certs status in its processing Product ID number of this type of cert Text description of this type of cert Certificate Signing Request (CSR) code, provided by the certificate authority Reference ID number for this cert SSL certificate, provided by the certificate authority. Organization name of Admin, Tech, or Billing Contact Job title of Contact Given name of Contact Family name of Contact Contact address, first line Contact address, second line Contact city Contact state or province Contact postal code Contact country Contact phone Contact fax Contact email address Contact phone extension ID number of this type of Web server Text description of this type of Web server Text abbreviation of this type of Web server Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

ContactTypeStateProvinceChoice Is this a state or a province?

12/1/08

63

1999-2008 eNom, Inc.

API commands: CertGetCertDetail

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
The following query retrieves information on a cert, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CERTGETCERTDETAIL& uid=resellid&pw=resellpw&CertID=288&ResponseType=XML

In the response, cert information and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertGetCertDetail> <CertID>288</CertID> <DomainName>resellerdocs.com</DomainName> <ValidityPeriod>12</ValidityPeriod> <OrderDate>2/14/2005 11:23:59 AM</OrderDate> <ConfigDate /> <RenewalIndicator>False</RenewalIndicator> <WebServerTypeID>13</WebServerTypeID> <WebServerTypeName>Microsoft IIS 5.0</WebServerTypeName> <OrderID>156249495</OrderID> <OrderDetailID>1372870</OrderDetailID> <ExpirationDate>2/14/2006 11:23:59 AM</ExpirationDate> <ServerCount>1</ServerCount> <ApproverEmail>[email protected]</ApproverEmail> <Message /> <CertStatusID>2</CertStatusID> <CertStatus>Processing</CertStatus> <ProdType>21</ProdType> <ProdDesc>SSL Certificate - GeoTrust True BusinessID</ProdDesc> <CSR>-----BEGIN NEW CERTIFICATE REQUEST----MIIDPjCCAqcCAQAwYzEYMBYGA1UEAxMPa2ltYmVybHlzaGluLnVzMQwwCgY DVQQLEwNLaW0xDDAKBgNVBAoTA0tpbTERMA8GA1UEBxMIQmVsbGV2dWUxCzA JBgNVBAgTAldBMQswCQYDVQQGEwJVUzCBnzANBgkqhkiG9w0BAQEFAAOBjQAw . . . 4BP8JmX8T2CJPnHOf2PIeXUujLhzv5bajXv HVTy1oG+/YLc+3LQzSm9rQXjMEk/1e JXi3OAShQX+S2GbyaUitu+lZ/K8QIzxCto Kf0vNlzbB70fOjWWQqfJhVsm -----END NEW CERTIFICATE REQUEST-----</CSR> <ReferenceID>17554</ReferenceID> <SSLCertificate>>-----BEGIN CERTIFICATE----MIIDRTCCAq6gAwIBAgIDBPEKMA0GCSqGSIb3DQEBBAUAMFoxCzAJBgNVBAYTAlVT MRwwGgYDVQQKExNFcXVpZmF4IFNlY3VyZSBJbmMuMS0wKwYDVQQDEyRFcXVpZm F4IFNlY3VyZSBHbG9iYWwgZUJ1c2luZXNzIENBLTEwHhcNMDYxMTEzMjIxNDA4WhcN . . . uJeFstXuC8vlHNiDbfiuVB3avYCKOChvRBcrZmiS907yPjIUbaJ0GtCXkp+uLyje Y29RJJlU0XN527CE5P3Vh6Oaok5J6cr2tJMwAJS+t9obF8yDR9NHSU+9wcz5nS6V zRpH7lZ2TDtq6+NT7EA3m5D3vvMI9ESDpw== -----END CERTIFICATE----</SSLCertificate> <AdminOrgName>Reseller Documents Inc.</AdminOrgName> <AdminJobTitle>Tester</AdminJobTitle>

12/1/08

64

1999-2008 eNom, Inc.

API commands: CertGetCertDetail

<AdminFName>John</AdminFName> <AdminLName>Doe</AdminLName> <AdminAddress1>100 Main Street</AdminAddress1> <AdminAddress2 /> <AdminCity>Hometown</AdminCity> <AdminStateProvince /> <AdminStateProvinceChoice /> <AdminPostalCode>99999</AdminPostalCode> <AdminCountry>US</AdminCountry> <AdminPhone>5559995555</AdminPhone> <AdminFax>none</AdminFax> <AdminEmailAddress>[email protected]</AdminEmailAddress> <AdminPhoneExt /> <TechOrgName>Reseller Documents Inc.</TechOrgName> . . . <BillingOrgName>Reseller Documents Inc.</BillingOrgName> . . . <WebServerTypes> <WebServerType> <WebServerTypeID>1</WebServerTypeID> <WebServerTypeName>Apache + MOD SSL</WebServerTypeName> <WebServerTypeCode>apachessl</WebServerTypeCode> </WebServerType> <WebServerType> <WebServerTypeID>20</WebServerTypeID> <WebServerTypeName>Apache + OpenSSL</WebServerTypeName> <WebServerTypeCode>apacheopenssl</WebServerTypeCode> </WebServerType> <WebServerType> <WebServerTypeID>2</WebServerTypeID> <WebServerTypeName>Apache + Raven</WebServerTypeName> <WebServerTypeCode>apacheraven</WebServerTypeCode> </WebServerType> . . . </WebServerTypes> </CertGetCertDetail> <Command>CERTGETCERTDETAIL</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1914063</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

65

1999-2008 eNom, Inc.

API commands: CertGetCertDetail

Related commands
CertConfigureCert CertGetApproverEmail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert GetCerts

12/1/08

66

1999-2008 eNom, Inc.

API commands: CertGetCerts

CertGetCerts
Description
Definition
Retrieve a list of the SSL certificates currently registered in this account.

Usage
Use this command to retrieve a list of the types of SSL certificates that that are currently registered in this account. The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertGetCerts
(this command) CertConfigureCert CertParseCSR CertGetApproverEmail CertPurchaseCert CertModifyOrder (Optional)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/MyCerts.asp

The table lists the certs currently registered in this account.

Constraints
The query must meet the following requirements: The login ID and password must be valid.

12/1/08

67

1999-2008 eNom, Inc.

API commands: CertGetCerts

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
IsExpired CertID OrderDate ConfigDate DomainName ValidityPeriod RenewalIndicator ProdType ProdDesc ExpirationDate ServerCount CertStatus CertStatusID OrderID Command ErrCount Err(x) Done

Definition
Is this cert expired? ID number for this individual cert, from our database Date on which this cert was purchased Date on which this cert was configured Domain that this cert is associated with Expiration date for this cert Renewal indicator setting Product ID number, from our records Text description of product Expiration date of this cert Should always return 1 Current status of this cert ID number corresponding to current cert status Identification number of the order that included this cert Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

68

1999-2008 eNom, Inc.

API commands: CertGetCerts

Example
The following query retrieves all certs in a domain name account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CertGetcerts& UID=resellid&PW=resellpw&ResponseType=XML

In the response, cert information and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertGetCerts> <Certs> <Cert> <IsExpired>False</IsExpired> <CertID>233</CertID> <OrderDate>3/21/2007</OrderDate> <ConfigDate /> <DomainName /> <ValidityPeriod>12</ValidityPeriod> <RenewalIndicator>False</RenewalIndicator> <ProdType>26</ProdType> <ProdDesc>SSL Certificate - GeoTrust QuickSSL</ProdDesc> <ExpirationDate>3/21/2008</ExpirationDate> <ServerCount>1</ServerCount> <CertStatus>Awaiting Configuration</CertStatus> <CertStatusID>1</CertStatusID> <OrderID>157404629</OrderID> </Cert> <Cert> <IsExpired>False</IsExpired> <CertID>208</CertID> <OrderDate>2/14/2007</OrderDate> <ConfigDate /> <DomainName>resellerdocs.com</DomainName> <ValidityPeriod>12</ValidityPeriod> <RenewalIndicator>False</RenewalIndicator> <ProdType>21</ProdType> <ProdDesc>SSL Certificate - GeoTrust True BusinessID</ProdDesc> <ExpirationDate>2/14/2008</ExpirationDate> <ServerCount>1</ServerCount> <CertStatus>Processing</CertStatus> <CertStatusID>2</CertStatusID> <OrderID>157402737</OrderID> </Cert> . . . </Certs> </CertGetCerts> <Command>CERTGETCERTS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1523438</ExecTime> <Done>true</Done>

12/1/08

69

1999-2008 eNom, Inc.

API commands: CertGetCerts

<debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetApproverEmail CertGetCertDetail CertModifyOrder CertParseCSR CertPurchaseCert GetCerts

12/1/08

70

1999-2008 eNom, Inc.

API commands: CertModifyOrder

CertModifyOrder
Description
Definition
Cancel a cert configuration order. Cancellation is permitted while a cert is in status Approval email sent or Processing. This command does not delete the cert from a customers account; it only cancels the configuration order. This allows a customer to change the configuration, including the domain name with which the cert will be associated.

Usage
A cert configuration order can only be canceled while the cert is in status Approval email sent or Processing. The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder CertGetCerts CertConfigureCert CertParseCSR CertGetApproverEmail CertPurchaseCert

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertModifyOrder (Optional)
(this command)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=295

The cancel button calls the CertModifyCert command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account. The CertModifyOrder command must reach the Certification Authority before they validate the cert.

12/1/08

71

1999-2008 eNom, Inc.

API commands: CertModifyOrder

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW CertID ResponseType

Obligation
Required Required Required Optional

Definition
Account login ID Account password ID number for this cert, from our records. Use the CertGetCerts command to retrieve this number. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 6 4

Returned parameters and values

Param name Definition
CertID Command ErrCount Err(x) Done Identification number of this cert Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query cancels the configuration order for a cert, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CertModifyOrder& uid=resellid&pw=resellpw&CertID=294&ResponseType=XML

In the response, a cert ID number and an ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertModifyOrder> <CertID>294</CertID> </CertModifyOrder> <Command>CERTMODIFYORDER</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod>

12/1/08

72

1999-2008 eNom, Inc.

API commands: CertModifyOrder

<Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.109375</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertParseCSR CertPurchaseCert GetCerts

12/1/08

73

1999-2008 eNom, Inc.

API commands: CertParseCSR

CertParseCSR
Description
Definition
Parse a Certificate Signing Request (CSR) to determine the domain name and other information associated with this cert.

Usage
The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder CertGetCerts CertConfigureCert

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertParseCSR
(this command) CertGetApproverEmail CertPurchaseCert CertModifyOrder (Optional)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=295

The save changes button calls the CertParseCSR command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account.

12/1/08

74

1999-2008 eNom, Inc.

API commands: CertParseCSR

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW CSR CertID ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Certificate Signing Request (CSR) generated as an input parameter for the CertConfigureCert command. ID number of this cert. To retrieve this number, use the CertGetCerts command. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4500 8 4

Returned parameters and values

Param name
Success Organization DomainName Email Locality OrganizationUnit State Country Command ErrCount Err(x) Done

Definition
Success status of this parsing operation Organization name embedded in the CSR Domain name embedded in the CSR Email address embedded in the CSR Locality (usually a city) embedded in the CSR Organizational unit embedded in the CSR State embedded in the CSR Country embedded in the CSR Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query parses a CSR and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CertParseCSR& uid=resellid&pw=resellpw&ResponseType=XML&CertID=295& CSR=%2D%2D%2D%2D%2DBEGIN+NEW+CERTIFICATE+REQUEST%2D%2D%2D%2D%2D%0D%0 AMIIDVzCCAsACAQAwfDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkRFMRMwEQYDVQQH%0D%0AEwp

12/1/08

75

1999-2008 eNom, Inc.

API commands: CertParseCSR

XaWxtaW5ndG9uMRIwEAYDVQQKEwlBY21lIEluYy4xGDAWBgNVBAsTD1NTTCBD%0D%0AZXJ0aWZpY2 F0ZTEdMBsGA1UEAxMUd3d3LnJlc2VsbGVyZG9jcy5jb20wgZ8wDQYJ%0D%0AKoZIhvcNAQEBBQADgY0 AMIGJAoGBAL0aEkBD2RkKOm82yJGy%2FIhLRH7pYIGZCazh%0D%0ACxp731BjemXjSaVJLu0%2BoE6 sIMRhV04X%2FJjVFgGGbswVvHT5qWZdpODe2EEBG971%0D%0ABJlUmBGEX%2Flgkd%2BjjHbP3MnO qbkuRRYrdao2CPjB3dcv46IcjFvCl5P%2BSEVx7Y9c%0D%0Awjk3n%2FxLAgMBAAGgggGZMBoGCisGAQ QBgjcNAgMxDBYKNS4yLjM3OTAuMjB7Bgor%0D%0ABgEEAYI3AgEOMW0wazAOBgNVHQ8BAf8EBAMCB PAwRAYJKoZIhvcNAQkPBDcwNTAO%0D%0ABggqhkiG9w0DAgICAIAwDgYIKoZIhvcNAwQCAgCAMAcGB SsOAwIHMAoGCCqGSIb3%0D%0ADQMHMBMGA1UdJQQMMAoGCCsGAQUFBwMBMIH9BgorBgEEAYI3D QICMYHuMIHrAgEB%0D%0AHloATQBpAGMAcgBvAHMAbwBmAHQAIABSAFMAQQAgAFMAQwBoAGEAb gBuAGUAbAAg%0D%0AAEMAcgB5AHAAdABvAGcAcgBhAHAAaABpAGMAIABQAHIAbwB2AGkAZABlAHI DgYkA%0D%0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA A%0D%0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%0 D%0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADANBgkqhkiG%0D%0A 9w0BAQUFAAOBgQCfN86YfjwTGCMj84DFkvQBPX0zQ8815bgqaZSNHQRYl67Gj4A%2B%0D%0Awmg3 O18lX0NwBt%2BT%2F57OaJS4HB6x6JvAo96N%2B1vX%2F%2BiG2thcu1PqTb%2Fu%2BmUbapaa%0 D%0Ackas6Ubbe2MVHKRz7o0ZNfIKUrRBdCRtZBEVxz1ZrPMqRHVo1oq5N17SEA%3D%3D%0D%0A%2 D%2D%2D%2D%2DEND+NEW+CERTIFICATE+REQUEST%2D%2D%2D%2D%2D

In the response, parsed information and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertParseCSR> <Success>True</Success> <Organization>Acme Inc.</Organization> <DomainName>www.resellerdocs.com</DomainName> <Email /> <Locality>Wilmington</Locality> <OrganizationUnit>SSL Certificate</OrganizationUnit> <State>DE</State> <Country>US</Country> </CertParseCSR> <Command>CERTPARSECSR</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.578125</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertPurchaseCert GetCerts

12/1/08

76

1999-2008 eNom, Inc.

API commands: CertPurchaseCert

CertPurchaseCert
Description
Definition
Send a cert configuration to its Certification Authority for final approval and issuance of the cert.

Usage
Once you have confirmed that all configuration information is correct, use this command to send the configuration to the Certification Authority for final approval and issuance of the cert. The process for purchasing, configuring, and issuing a cert proceeds in the following order:

Command/Procedure
AddToCart and InsertNewOrder CertGetCerts CertConfigureCert CertParseCSR CertGetApproverEmail

Definition
Purchase the cert in our system Retrieve the ID number for this cert, to use in configuring it Obtain information from customer to configure the cert Parse the CSR Retrieve registrant email address from Registry, for cert approval Submit configuration information to certification authority for final issuance of cert Cancel a cert issuance request, so that the cert can be reconfigured

CertPurchaseCert
(this command) CertModifyOrder (Optional)

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/ConfigureCerts.asp?CertID=295

The submit button calls the CertPurchaseCert command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The cert must belong to this account.

12/1/08

77

1999-2008 eNom, Inc.

API commands: CertPurchaseCert

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW ApproverEmail

Obligation
Required Required Required

Definition
Account login ID Account password Email address of the registrant of record for the domain to be associated with this cert. Use the CertParseCSR command to retrieve the domain name, and then use the CertGetApproverEmail command to retrieve the registrants email address (the approver) from the authoritative Whois database. ID number for this cert, from our records. Use the CertGetCerts command to retrieve this number. Name of the organization that will use this cert Unit within the organization that will use this cert

Max size
20 20 130

CertID CSROrganization

Required Optional for SBS certs

6 64 64

CSROrganizationUnit Optional for SBS CSRAddress1 CSRAddress2 CSRAddress3 CSRLocality CSRStateProvince CSRPostalCode CSRCountry DUNSNumber ResponseType Required for SBS Optional for SBS Optional for SBS Required for SBS Required for SBS Required for SBS Optional for SBS Optional for SBS Optional

Address, line 1, of the organization that will use this 128 cert Address, line 2 Address, line 3 Location (often a city) of the organization State or province in which the organization is located Postal code of the organization Country in which the organization is located D-U-N-S Number; speeds validation of SBS Secure and Secure Plus certs Format of response. Options are Text (default), HTML, or XML. 128 128 128 128 40 40 32 4

Returned parameters and values

Param name Definition
CertID Command ErrCount Err(x) Done Identification number of this cert Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

78

1999-2008 eNom, Inc.

API commands: CertPurchaseCert

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
The following query sends information to the Certification Authority for final validation of the cert, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=CertPurchaseCert& uid=resellid&pw=resellpw&[email protected]&CertID=295& CSRAddress1=111+Main&CSRLocality=Wilmington&CSRStateProvince=DE& CSRPostalCode=00123&ResponseType=XML

In the response, an ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CertPurchaseCert> <CertID>295</CertID> </CertPurchaseCert> <Command>CERTPURCHASECERT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.71875</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR GetCerts

12/1/08

79

1999-2008 eNom, Inc.

API commands: Check

Check
Description
Definition
Check the availability of a domain name, both at the Registry and in our auction system.

Usage
Use this command to check whether a domain name is already registered.

Availability
The Check command is available to every reseller.

Implementation on eNom.com
http://www.enom.com/

In the check a domain name area near the top of the page, the Go button activates the Check command.

Constraints
Domain names must meet the following requirements: Second-level domain (SLD) must be composed of the letters a through z, the numbers 0 through 9, and the hyphen (-) character. Some foreign character sets can display onscreen, but resolve to alphanumeric plus hyphen characters in the underlying code. The SLD must not begin or end with the hyphen character. The SLD must not contain spaces. The SLD must not contain special characters other than the hyphen character. The third and fourth characters of the SLD must not both be hyphens unless it is an encoded international-character domain name. The SLD must contain 2 to 63 characters, inclusive.
SLDs are not case sensitive.

The SLD-TLD combination must be unique.

12/1/08

80

1999-2008 eNom, Inc.

API commands: Check

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?Command=Check&UID=YourLogin &PW=YourPassword&SLD=DesiredSLD&TLD=DesiredTLD&OptParam1=ParamValue1 &OptParam2=ParamValue2

Param name Obligation Definition

UID PW SLD Required Required Required unless DomainList is used Account login ID Account password Second-level domain name (for example, enom in enom.com)

Max size
20 20 63

TLD

Top-level domain name (extension). Permitted values: Required Any single TLD, for example, com unless * returns 11 of the most commonly used TLDs: DomainList com, org, net, biz, ws, info, cc, us, tv, bz, nu or TLDList is *1 returns com, net, org, info, biz, us, ws used *2 returns com, net, org, info, biz, us @ returns com, net, org Optional A comma- or newline-delimited list of domains to check, up to 30 names. If used, SLD and TLD are ignored. A comma- or newline-delimited list of TLDs to check, up to 30 names. If used, TLD is ignored. Format of response. Options are Text (default), HTML, or XML.

15

DomainList

2000

TLDList

Optional

2000

ResponseType

Optional

Returned parameters and values

Param name
DomainX RRPCodeX RRPTextX

Definition
If return includes multiple domains, the name of domain X (indexed X in HTML and Text output, but not in XML output) Success code. Only 210 indicates that the name is available at the Registry. 211 indicates the domain is not available at the Registry. Text which accompanies and describes the RRPCode. 210 Domain available 211 Domain not available True indicates this is a premium name. Registration price per year for this premium name, in $US.

IsPremiumName PremiumPrice

PremiumAboveThresholdPrice True indicates the registration price for this premium name is higher than for non-premium names. AuctionDateX AuctionIDX DomainCount Command ErrCount Scheduled closing date for this auction Auction ID number for this domain name The number of names checked. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

81

1999-2008 eNom, Inc.

API commands: Check

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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. When parsing the response, use the RRPCode value rather than the RRPText value or the position in the response. Of these, only the RRPCode value is guaranteed by the Registry to be stable.

Example
The following checks whether the domain name unusualTVname.tv is available and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=check& sld=unusualTVname&tld=tv&responsetype=xml

The response indicates that unusualTVname.tv is available:

<?xml version="1.0" ?> <interface-response> <DomainName>unusualtvname.tv</DomainName> <PremiumName> <IsPremiumName>False</IsPremiumName> <PremiumPrice /> <PremiumAboveThresholdPrice>False</PremiumAboveThresholdPrice> </PremiumName> <RRPCode>210</RRPCode> <RRPText>Domain available</RRPText> <AuctionDate /> <AuctionID /> <Command>CHECK</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>Reseller4</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.172</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

12/1/08

82

1999-2008 eNom, Inc.

API commands: Check

Related commands
AddBulkDomains InsertNewOrder NameSpinner Purchase

12/1/08

83

1999-2008 eNom, Inc.

API commands: CheckLogin

CheckLogin
Description
Definition
Validate user login for a domain name.

Usage
Use this command when you want to validate a users identity.

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://www.enom.com/Login.asp?page=%2Fmyaccount%2FDefault%2Easp%3F

Clicking the log-in button calls the CheckLogin 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:
http://resellertest.enom.com/interface.asp?Command=CheckLogin&UID=YourLogin &PW=YourPassword

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
PartyID Reseller RSA ClubDrop Command PartyID of the account Is this a reseller account? Reserved parameter. Should always return False. Is this account a Club Drop member? Name of command executed

12/1/08

84

1999-2008 eNom, Inc.

API commands: CheckLogin

Param name Definition

ErrCount Err(x) Done The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the party ID and reseller status of account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=checklogin& uid=resellid&pw=resellpw&responsetype=xml

The response provides basic information about the account:

<?xml version="1.0" ?> <interface-response> <PartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyID> <Reseller>True</Reseller> <RSA>False</RSA> <ClubDrop>False</ClubDrop> <Command>CHECKLOGIN</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateAccountInfo UpdateCusPreferences

12/1/08

85

1999-2008 eNom, Inc.

API commands: CheckNSStatus

CheckNSStatus
Description
Definition
Check the status of a name server.

Usage
Use this command when you want to determine whether a name server exists.

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 name server must exist. The query must call the name server in a valid format (by its use name, not its IP address).

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW CheckNSName ResponseType Required Required Required Optional Account login ID Account password Name server use name to check. Use format dnsX.NameServerName.com. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 4

Returned parameters and values

Param name
NSCheckSuccess Other parameters Command

Definition
Was this name server check successful? 1 indicates yes; 0 indicates no. Other parameters will be returned, and will vary from one name server to another Name of command executed

12/1/08

86

1999-2008 eNom, Inc.

API commands: CheckNSStatus

Param name
ErrCount Err(x) Done

Definition
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the status of name server ns1.name-services.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=checknsstatus& uid=resellid&pw=resellpw&checknsname=ns1.name-services.com& responsetype=xml

The NsCheckStatus value of 1 indicates that the name server was found:
<?xml version="1.0" ?> <interface-response> <NsCheckSuccess>1</NsCheckSuccess> <CheckNsStatus> <version>0</version> <name>ns1.name-services.com</name> <status> <status>ok</status> <status>linked</status> </status> <ipaddress>63.251.83.37</ipaddress> <attrib-id>5232127_HOST_CNE-VRSN</attrib-id> <attrib-crdate>2002-01-15T20:34:07.0000Z</attrib-crdate> <attrib-update>2002-04-18T17:35:43.0000Z</attrib-update> <attrib-upid>y2ktest</attrib-upid> <attrib-crid>rccbatch</attrib-crid> <attrib-clid>024</attrib-clid> </CheckNsStatus> <RRPCode /> <RRPText /> <Command>CHECKNSSTATUS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>1.125</ExecTime> <Done>true</Done>

12/1/08

87

1999-2008 eNom, Inc.

API commands: CheckNSStatus

<debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer

12/1/08

88

1999-2008 eNom, Inc.

API commands: CommissionAccount

CommissionAccount
Description
Definition
Returns the current commission balance for an account.

Usage
Use this command to return the current commission balances for 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.
http://enomson/resellers/SubAccount.asp

On the subaccount page, the Access link calls the CommissionAccount 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

89

1999-2008 eNom, Inc.

API commands: CommissionAccount

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
The following query requests the total and available commission balances for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=commissionaccount& uid=resellid&pw=resellpw&responsetype=xml

The response lists the balances:

<?xml version="1.0" ?> <interface-response> <CommissionAccount> <Action /> <data-errors /> <CommissionBalance>6.69</CommissionBalance> <AvailComBalance>0</AvailComBalance> </CommissionAccount> <Command>COMMISSIONACCOUNT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetRetailPrice PE_GetRocketPrice PE_SetPricing

12/1/08

90

1999-2008 eNom, Inc.

API commands: Contacts

Contacts
Description
Definition
Update contact information for a domain name.

Usage
Use this command to set or change contact information for a domain. If you want to update one contact type and leave the others as is, use this command with the ContactType parameter.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/ContactConfig.asp?DomainNameID=152533676

On the edit contact info page, typing information in the text boxes provides the parameter values for the Contacts command.

Constraints
The query must meet the following requirements: The domain must exist in the account that is modifying it. Some country code TLDs require extended attributes (parameters that are specific to the country code). To find out whether a country code TLD requires extended parameters and what they are, run GetExtAttributes on the country code. The BILLING contact type cannot be updated with this command. To update billing information, use UpdateAccountInfo. If you use the ContactType parameter, you can reset only one contact type. If you use the ContactType parameter, the contact type of the other parameters must match it (for example, if you set ContactType=AUXBILLING, you must use parameters AuxBillingOrganizationName, AuxBillingFirstName, and so on. If you dont use the ContactType parameter and dont supply new information for all contacts, those that you dont supply will be empty in the database and will use our defaults in interfaces.

12/1/08

91

1999-2008 eNom, Inc.

API commands: Contacts

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD ContactType

Obligation
Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Type of contact to add/update. Options are REGISTRANT, AUXBILLING, TECH, ADMIN Organization of ContactType contact First name of ContactType contact

Max size
20 20 63 15 16

ContactTypeOrganizationName

Required for each contact type you add or update Required for each contact type you add or update Required for each contact type you add or update Optional Required for each contact type you add or update Optional Required for each contact type you add or update

60

ContactTypeFirstName

60

ContactTypeLastName

Last name of ContactType contact 60

ContactTypeJobTitle ContactTypeAddress1

Job title of ContactType contact Address of ContactType contact

60 60

ContactTypeAddress2 ContactTypeCity

Additional address info of ContactType contact City of ContactType contact

60 60

ContactTypeStateProvinceChoice Optional

State or province choice of ContactType contact. Permitted values are: S State P Province State or province of ContactType contact Postal code of ContactType contact Country of ContactType contact

ContactTypeStateProvince ContactTypePostalCode

Optional Optional for most TLDs; Required for .org Required for each contact type you add or update Required for each contact type you add or update

60 16

ContactTypeCountry

60

ContactTypeEmailAddress

Email address of ContactType contact

128

12/1/08

92

1999-2008 eNom, Inc.

API commands: Contacts

Param name
ContactTypePhone

Obligation
Required for each contact type you add or update

Definition
Phone number of ContactType contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Phone extension of ContactType contact Fax number of ContactType contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Data required by the Registry for some country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes. Format of response. Options are Text (default), HTML, or XML.

Max size
17

ContactTypePhoneExt

Optional for each contact type you add or update Optional

17

ContactTypeFax

17

ExtendedAttributes

Required for some country codes

varies

ResponseType

Optional

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
The BILLING contact type cannot be updated with this command. To update billing information, use UpdateAccountInfo. You can submit multiple contact data in a single request by omitting the ContactType parameter and sending additional contact data by replacing Registrant in the above optional parameters with the ContactTypes AUXBILLING, TECH, or ADMIN. If you use the ContactType parameter, you can reset only one contact type. If you use the ContactType parameter, the contact type of the other parameters must match it (for example, if you set ContactType=AUXBILLING, you must use parameters AuxBillingOrganizationName, AuxBillingFirstName, and so on). If you dont use the ContactType parameter and dont supply new information for all contacts, those that you dont supply will be empty in the database and will use our defaults in interfaces.
AUXBILLING masks the true billing contact in WhoIs output.

12/1/08

93

1999-2008 eNom, Inc.

API commands: Contacts

Some country code TLDs require extended attributes (parameters that are specific to the country code). To find out whether a country code TLD requires extended parameters and what they are, run GetExtAttributes on the country code. 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
The following query provides new technical contact information for resellerdocs.com and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=contacts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& ContactType=Tech&TechFirstName=John&TechLastName=Smith& TechPhone=+1.5555555555&TechAddress1=100%20Main%20St.&TechCity=Townsville& TechCountry=USA&[email protected]&responsetype=xml

The error count of 0 in the response confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>CONTACTS</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddContact GetAddressBook GetContacts GetExtAttributes GetServiceContact GetWhoisContact Preconfigure

12/1/08

94

1999-2008 eNom, Inc.

API commands: CreateAccount

CreateAccount
Description
Definition
Create a new subaccount.

Usage
Use this command to create a new retail subaccount. CreateAccount differs from CreateSubAccount in that CreateAccount offers credit card processing.

Availability
All resellers have access to this command.

Implementation on eNom.com
http://resellertest.enom.com/NewAccount.asp?page=

At the bottom of the information form, the submit button calls the CreateAccount command.

Constraints
The query must meet the following requirements: Parameter values submitted in the query must pass validation tests.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW NewUID

Obligation
Required Required Required

Definition
Account login ID Account password Subaccount login ID. Permitted characters are letters, numbers, hyphen, and underscore Subaccount password. Permitted characters are letters, numbers, hyphen, and underscore Confirm subaccount password. Permitted characters are letters, numbers, hyphen, and underscore Registrant organization Registrant job title Registrant first name Registrant last name

Max size
20 20 20

NewPW

Required

20

ConfirmPW

Required

20

RegistrantOrganizationName RegistrantJobTitle RegistrantFirstName RegistrantLastName

Required Optional Required Required

60 60 60 60

12/1/08

95

1999-2008 eNom, Inc.

API commands: CreateAccount

Param name
RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantPostalCode RegistrantStateProvince RegistrantStateProvinceChoice

Obligation
Required Optional Required Required Optional Optional

Definition
Registrant address Registrant additional address info Registrant city Registrant postal code Registrant state or province Registrant state or province choice: S state P province Registrant country Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Email address for Whois Email address for us to contact you about your domain name account Type of credit card Cardholder's name Customer's credit card number Credit card expiration month Credit card expiration year Credit card verification code Credit card billing address Credit card billing postal code Credit card billing country Type of question. Values can be smaiden, sbirth, ssocial, shigh The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security, or high school) The value of a send e-mail notification checkbox. If EmailInfo=checked an email will be sent to the registrant email parameter posted with this request containing this account information Format of response. Options are Text (default), HTML, or XML.

Max size
60 60 60 16 60 1

RegistrantCountry RegistrantPhone

Optional Required

60 17

RegistrantFax

Optional

17

RegistrantEmailAddress RegistrantEmailAddress_Contact CardType CCName CreditCardNumber CreditCardExpMonth CreditCardExpYear CVV2 CCAddress CCZip CCCountry AuthQuestionType AuthQuestionAnswer

Required Optional Required Required Required Required Required Required Required Required Required Required Required

128 128 20 60 128 2 4 4 60 15 60 10 50

EmailInfo

Optional

10

ResponseType

Optional

12/1/08

96

1999-2008 eNom, Inc.

API commands: CreateAccount

Returned parameters and values

Param name
OrganizationName FName LName JobTitle Address1 Address2 City StateProvince StateProvinceChoice PostalCode Country Phone PhoneExt Fax EmailAddress

Definition
Organization name of the Billing contact First name (given name) of the Billing contact Last name (family name) of the Billing contact Job title for the Billing contact Address, line 1, for the Billing contact Address, line 2, for the Billing contact City for the Billing contact State or province for the Billing contact Tells whether StateProvince value is a state or a province Postal code for the Billing contact County for the Billing contact Phone number for the Billing contact Phone extension for the Billing contact Fax number for the Billing contact Email address for public WhoIs record

EmailAddress_Contact Email address that we use when contacting account owner about this account EmailInfo CCType CCName CCNumber CCMonth CCYear CCAddress CCCity CCStateProvince CCZip CCCountry CCPhone Reseller NewUID NewPW ConfirmPW AuthQuestionType AuthQuestionAnswer DefPeriod StatusCustomerInfo PartyID Account sLoginPass Command ErrCount Tells whether confirmation emails should be sent to these email addresses Type of credit card Cardholders name Credit card number Expiration month for this credit card Expiration year for this credit card Billing address street address for this credit card Billing address city for this credit card Billing address state or province for this credit card Billing address postal code for this credit card Billing address country for this credit card Phone number on record for this credit card 1 indicates this subaccount is a reseller account; 0 indicates retail Login ID for this subaccount Password for this subaccount Repeat password, for confirmation purposes Type of authorization question for this subaccount Answer to the authorization question Default registration period for domain names, in years Returns Successful if the subaccount was created Party ID of this subaccount, for our records Account ID code of this subaccount, for our records. We recommend that you store this value. Code we use to log the user into the new subaccount immediately. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

97

1999-2008 eNom, Inc.

API commands: CreateAccount

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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. If there are errors validating the data passed in, the same parameters and values are returned to rebuild the form.

Example
The following query creates subaccount olerud, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=CreateAccount& uid=resellid&pw=resellpw&NewUID=olerud& NewPW=olerudpw&ConfirmPW=olerudpw& RegistrantOrganizationName=Reseller%20Documents%20Inc.&RegistrantFirstName=John& RegistrantLastName=Doe&RegistrantJobTitle=First%20Baseman& RegistrantAddress1=111%20Main%20St.&RegistrantCity=Hometown& RegistrantPostalCode=99999&RegistrantCountry=United+States& RegistrantEmailAddress=john%2Edoe%40resellerdocs%2Ecom& RegistrantPhone=+1.5555555555&RegistrantFax=+1.5555555556&AuthQuestionType=smaiden& AuthQuestionAnswer=jones&Reseller=0&CardType=visa&CCName=test1&ResponseType=XML

The response confirms the successful creation of the subaccount and returns subaccount information:
<?xml version="1.0" ?> <interface-response> <NewAccount> <StatusCustomerInfo>Successful</StatusCustomerInfo> <PartyID>{8D504DD5-C773-41C4-83F6-4495CA479103}</PartyID> <Account>154-dz-5567</Account> <sLoginPass>
91DDFEF7E0E7F6A9DDFEF7E0E7F6A9A5BDA0A6BDA0A2A2A0B2A5A8A2A3A8A2AAB2C2DF

</sLoginPass> </NewAccount> <Command>CREATEACCOUNT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

98

1999-2008 eNom, Inc.

API commands: CreateAccount

Related commands
CheckLogin CreateSubAccount DeleteSubaccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SubAccountDomains UpdateAccountInfo UpdateCusPreferences

12/1/08

99

1999-2008 eNom, Inc.

API commands: CreateSubAccount

CreateSubAccount
Description
Definition
Create a subaccount.

Usage
Use this command to create a new retail subaccount. Resellers can also create subaccounts to help organize their business. Sites created with PDQ call the CreateSubAccount command when a user clicks the create account button. CreateSubAccount differs from CreateAccount in that CreateAccount offers credit card processing; CreateSubAccount does not.

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://www.enom.com/resellers/NewSubAccount.asp?

The submit button calls the CreateSubAccount command.

Constraints
The query must meet the following requirements: The account must have reseller status in eNoms database.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW NewUID

Obligation Definition
Required Required Required Account login ID Account password

Max size
20 20

Subaccount login ID. Permitted 20 characters are letters, numbers, hyphen, and underscore 20 Subaccount password. Permitted characters are letters, numbers, hyphen, and underscore

NewPW

Required

12/1/08

100

1999-2008 eNom, Inc.

API commands: CreateSubAccount

Param name
ConfirmPW

Obligation Definition
Required Confirm subaccount password. Permitted characters are letters, numbers, hyphen, and underscore Type of question. Values can be smaiden, sbirth, ssocial, shigh The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security, or high school) Registrant address Registrant additional address info Registrant city Registrant country Email address for WhoIs Email address for us to contact you about your domain name account Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant first name Registrant last name Registrant job title Registrant organization Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant postal code Registrant state or province Registrant state or province choice: S state P province Format of response. Options are Text (default), HTML, or XML.

Max size
20

AuthQuestionType AuthQuestionAnswer

Optional Optional

10 50

RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantCountry RegistrantEmailAddress RegistrantEmailAddress_Contact RegistrantFax

Required Optional Required Required Required Optional Optional

60 60 60 60 128 128 17

RegistrantFirstName RegistrantLastName RegistrantJobTitle RegistrantOrganizationName RegistrantPhone

Required Required Optional Optional Required

60 60 60 60 17

RegistrantPostalCode RegistrantStateProvince RegistrantStateProvinceChoice

Optional Optional Optional

16 60 1

ResponseType

Optional

Returned parameters and values

Param name
StatusCustomerInfo PartyID Account Command ErrCount Err(x) Done

Definition
Returns Successful if account was created Party ID for the new subaccount Account ID for the new subaccount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

101

1999-2008 eNom, Inc.

API commands: CreateSubAccount

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
The following query creates a new subaccount, resellsub4, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=CreateSubAccount& uid=resellid&pw=resellpw&newuid=resellsub4&newpw=resellsub4& confirmpw=resellsub4&RegistrantOrganizationName=Reseller%20Documents%20Inc.& RegistrantFirstName=john&RegistrantLastName=doe&RegistrantAddress1=111%20Main%20St.& RegistrantCity=Hometown&RegistrantStateProvince=WA&RegistrantStateProvinceChoice=S& RegistrantPostalCode=98003&RegistrantCountry=United+States& RegistrantEmailAddress=john%2Edoe%40resellerdocs%2Ecom& RegistrantPhone=+1.5555555555&RegistrantFax=+1.5555555556& AuthQuestionType=smaiden&AuthQuestionAnswer=jones&ResponseType=XML

The response confirms the successful creation of the subaccount:

<?xml version="1.0" ?> <interface-response> <NewAccount> <StatusCustomerInfo>Successful</StatusCustomerInfo> <PartyID>{B301E3A9-1BFF-4600-9B2D-D214C29325A9}</PartyID> <Account>661-zw-1374</Account> </NewAccount> <Command>CREATESUBACCOUNT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SubAccountDomains UpdateAccountInfo UpdateCusPreferences

12/1/08

102

1999-2008 eNom, Inc.

API commands: DeleteAllPOPPaks

DeleteAllPOPPaks
Description
Definition
Delete all POP3 email paks in a domain.

Usage
Use this command to delete all POP3 paks from a domain. Note that if you delete the POP paks, the only way to replace them is to buy new paks.

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 domain name must belong to this account. All POP paks in the domain must have no user emails configured. You can use the DeletePOP3 command to remove user email accounts.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

103

1999-2008 eNom, Inc.

API commands: DeleteAllPOPPaks

Returned parameters and values

Param name Definition
PaksRemoved RegistrarHold Command ErrCount Err(x) Done Number of POP paks removed from the domain name The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. Use the DeletePOP3 command to delete any email user accounts before running DeleteAllPOPPaks.

Example
The following query deletes all POP3 10-paks from resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeleteAllPOPPaks& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

In the response, the error count 0 confirms that the command executed successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>DELETEALLPOPPAKS</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

104

1999-2008 eNom, Inc.

API commands: DeleteAllPOPPaks

Related commands
DeletePOP3 DeletePOPPak Forwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User

12/1/08

105

1999-2008 eNom, Inc.

API commands: DeleteContact

DeleteContact
Description
Definition
Delete a contact from the address book.

Usage
Use this command to delete a contact from a domain name accounts address book.

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. Only contacts added with the AddContact command can be deleted.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation
Required Required

Definition
Account login ID Account password

Max size
20 20

RegistrantPartyID Required

Party ID number of the contact you want to delete. Use 40 the GetAddressBook command to retrieve the Party ID. Required format is the Party ID enclosed in curly braces. Format of response. Options are Text (default), HTML, 4 or XML.

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

106

1999-2008 eNom, Inc.

API commands: DeleteContact

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes a contact from a domain accounts address book, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DELETECONTACT& uid=resellid&pw=resellpw& registrantpartyid={4545A013-B40A-4D50-A15A-5D4356723794}&responsetype=xml

In the response, the ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <Command>DELETECONTACT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>1.082</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddContact GetAddressBook GetContacts GetSubAccounts

12/1/08

107

1999-2008 eNom, Inc.

API commands: DeleteCustomerDefinedData

DeleteCustomerDefinedData
Description
Definition
Delete customer-defined data records.

Usage
Use this command to delete customer-defined data.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ObjectID Type Required Required Required Required

Definition
Account login ID Account password Object ID number, an integer assigned when this customer-defined field was first established. Object type. Permitted values are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Order ID, which you can retrieve using the GetDomainStatus comand. Title of this entry, or label describing this data field Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 2 1

SLD TLD OrderID Key ResponseType

Required if Type=2 Required if Type=2 Required if Type=3 Required Optional

63 15 11 50 4

12/1/08

108

1999-2008 eNom, Inc.

API commands: DeleteCustomerDefinedData

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes the customer-defined data labeled FavoriteCuisine from account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=deletecustomerdefineddata& uid=resellid&pw=resellpw&ObjectID=1&Type=1&Key=FavoriteCuisine& responsetype=xml

In the response, the ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <Command>DELETECUSTOMERDEFINEDDATA</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetCustomerDefinedData SetCustomerDefinedData

12/1/08

109

1999-2008 eNom, Inc.

API commands: DeleteDomainFolder

DeleteDomainFolder
Description
Definition
Delete a folder.

Usage
Use this command to delete one domain name folder. This command does not delete domains; only the folder. When you delete a folder, the domains that were in it keep the settings assigned by the folder until you change them.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/domains/Domain-Manager.aspx?tab=folder

In the list of folders, the delete link calls the DeleteDomainFolder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The folder must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW FolderName ResponseType Required Required Required Optional

Definition
Account login ID Account password Name of the folder you want to delete Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 125 4

12/1/08

110

1999-2008 eNom, Inc.

API commands: DeleteDomainFolder

Returned parameters and values

Param name Definition
FolderName Result Name of folder Success of this query. Values are: 0 Failure 1 Success 2 Folder not found in this account Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query deletes a domain folder, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeleteDOMAINFOLDER& uid=resellid&pw=resellpw&FolderName=Favorites%202&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DeleteResult> <FolderName>Favorites</FolderName> <Result>1</Result> </DeleteResult> <Command>DELETEDOMAINFOLDER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.188</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

12/1/08

111

1999-2008 eNom, Inc.

API commands: DeleteDomainFolder

Related commands
AddDomainFolder AdvancedDomainSearch AssignToDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

112

1999-2008 eNom, Inc.

API commands: DeleteFromCart

DeleteFromCart
Description
Definition
Delete an item or all items from the shopping cart.

Usage
Use this command when you want to remove one or all items from the shopping cart.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/Cart.asp

The delete button behaves similarly to the DeleteFromCart command.

Constraints
The query must meet the following requirements: The shopping cart must contain one or more items. One or all items in the shopping cart must be deleted.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ItemNumber Required Required Either ItemNumber or EmptyCart is Required Either ItemNumber or EmptyCart is Required Optional

Definition
Account login ID Account password Item ID number of the item to be deleted from the shopping cart. Use the GetCartContent command to retrieve the item ID numbers. Use EmptyCart=On to completely empty the shopping cart.

Max size
20 20 10

EmptyCart

ResponseType

Format of response. Options are Text (default), HTML, or XML.

12/1/08

113

1999-2008 eNom, Inc.

API commands: DeleteFromCart

Returned parameters and values

Param name Definition
ItemDeleted Command ErrCount Err(x) Done True if deleted. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that item 365485 be deleted from the shopping cart, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeleteFromCart& uid=resellid&pw=resellpw&ItemNumber=365485&ResponseType=XML

The response confirms the successful deletion from the shopping cart:
<?xml version="1.0" ?> <interface-response> <ItemDeleted>True</ItemDeleted> <Command>DELETEFROMCART</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddBulkDomains AddToCart GetCartContent InsertNewOrder PurchasePreview UpdateCart

12/1/08

114

1999-2008 eNom, Inc.

API commands: DeleteHostedDomain

DeleteHostedDomain
Description
Definition
Discontinue our DNS hosting of a domain name.

Usage
Use this command to cancel our DNS hosting of a domain name.

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 domain name must be hosted by this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name
OldRegistrationStatus Status Command

Definition
Registration status before running this query Success status for canceling DNS hosting on this domain Name of command executed

12/1/08

115

1999-2008 eNom, Inc.

API commands: DeleteHostedDomain

Param name
ErrCount Err(x) Done

Definition
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query discontinues our DNS hosting of ExternalHostedDomain.com, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeleteHostedDomain& uid=resellid&pw=resellpw&sld=ExternalHostedDomain&tld=com&responsetype=xml

In the response, the OldRegistrationStatus value Hosted and the ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <DeleteHostedDomain> <OldRegistrationStatus>Hosted</OldRegistrationStatus> <Status>Success</Status> </DeleteHostedDomain> <Command>DELETEHOSTEDDOMAIN</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>Reseller3</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.15625</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
ExtendDomainDNS PurchaseHosting

12/1/08

116

1999-2008 eNom, Inc.

API commands: DeleteNameServer

DeleteNameServer
Description
Definition
Delete a name server at the Registry.

Usage
Use this command to delete a name server at the Registry. This command does not affect the name servers listed for any individual domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/domains/RegNameServer.asp

In the Delete a Name Server box, the submit button calls the DeleteNameServer command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name server must be registered. The domain name this DNS uses must belong to this account. The domain name server must have no domains using it. All registrar locks and Registry holds must be off, and the domain must be in an active state.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW NS ResponseType Required Required Required Optional Account login ID Account password Use name of name server, in format dns1.ServerName.com Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 60 4

12/1/08

117

1999-2008 eNom, Inc.

API commands: DeleteNameServer

Returned parameters and values

Param name Definition
RegistrarLock NsSuccess RegistrarLock RRPCode RRPText Command ErrCount Err(x) Done Registrar lock status Success of the name server reset process Registrar lock setting Registry code Description of Registry code Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes the name server registration for dns3.resellerdocs.com at the Registry, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=deletenameserver& uid=resellid&pw=resellpw&ns=dns3.resellerdocs.com&responsetype=xml

In the response, the NsSuccess value 1, the RRPCode 200, and the RRPText Command completed successfully confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <RegisterNameserver> <RegistrarLock>ACTIVE</RegistrarLock> <NsSuccess>1</NsSuccess> <RegistrarLock>REGISTRAR-LOCK</RegistrarLock> </RegisterNameserver> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>DELETENAMESERVER</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

118

1999-2008 eNom, Inc.

API commands: DeleteNameServer

Related commands
CheckNSStatus GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer

12/1/08

119

1999-2008 eNom, Inc.

API commands: DeletePOP3

DeletePOP3
Description
Definition
Delete an individual POP3 user name from the database.

Usage
Use this command to delete an individual POP3 email user name. Once you delete it, you can fill that vacancy with another name. This command has no effect on the POP 10-pak nor on any other user names in the 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 domain name must belong to this account. The user name must be listed in the POP3 list for the account. The user name must be in a POP pak for which the subscription is current.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD PopUser ResponseType Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) POP mailbox user name to delete Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 16 4

12/1/08

120

1999-2008 eNom, Inc.

API commands: DeletePOP3

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes the POP user james and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeletePOP3& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&POPUser=james& responsetype=xml

In the response, the error count of 0 confirms that the POP user was deleted successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>DELETEPOP3</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

121

1999-2008 eNom, Inc.

API commands: DeletePOP3

Related commands
DeleteAllPOPPaks DeletePOPPak Forwarding GetCatchAll GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetCatchAll SetUpPOP3User

12/1/08

122

1999-2008 eNom, Inc.

API commands: DeletePOPPak

DeletePOPPak
Description
Definition
Delete a POP Email pak under a domain name.

Usage
Use this command to delete an entire 10-pak of POP accounts. Note that once a pak is deleted, the only way to replace it is to purchase a new one.

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 domain name must belong to this account. The pak must have no user email accounts currently configured.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD BundleID ResponseType Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

ID number of the POP pak to delete. Use GetPOP3 to get POP 6 pak IDs. Format of response. Options are Text (default), HTML, or XML. 4

12/1/08

123

1999-2008 eNom, Inc.

API commands: DeletePOPPak

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. Use the DeletePOP3 command to delete any email user accounts before running DeletePOPPak.

Example
The following query deletes POP bundle 5733 from resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DeletePOPPak& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&BundleID=5733& ResponseType=XML

The ErrCount value 0 confirms that the command was successful:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>DELETEPOPPAK</Command> <ErrCount>0</ErrCount> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 Forwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User

12/1/08

124

1999-2008 eNom, Inc.

API commands: DeleteRegistration

DeleteRegistration
Description
Definition
Delete a domain name registration.

Usage
Use this command to delete a domain name registration. Fees will apply.

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 domain name must belong to this account. The domain name must have been purchased less than five days ago. The most common TLDs, including .com and .net, can be deleted. For other TLDs, check the reseller pages on our Web site.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD EndUserIP ResponseType Required Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) End users IP address. Permitted format is NNN.NNN.NNN.NNN Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 15 4

12/1/08

125

1999-2008 eNom, Inc.

API commands: DeleteRegistration

Returned parameters and values

Param name Definition
DomainDeleted If domain deleted successfully, response is True ErrString ErrSource ErrSection RRPCode RRPText Command ErrCount Err(x) Done Error string Error source Error section Registry success code Text that corresponds to and explains the RRPCode value Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes a domain and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=deleteregistration& uid=resellid&pw=resellpw&sld=resellerdocs3&tld=info& responsetype=xml

In the response, an RRPCode value 200 confirms that the query was successful:
<interface-response> <deletedomain> <domaindeleted>True</domaindeleted> </deletedomain> <ErrString/> <ErrSource/> <ErrSection>DELETEREGISTRATION</ErrSection> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>DELETEREGISTRATION</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>2.75</ExecTime> <Done>true</Done>

12/1/08

126

1999-2008 eNom, Inc.

API commands: DeleteRegistration

<debug> [CDATA ] </debug> </interface-response>

Related commands
AddToCart Purchase

12/1/08

127

1999-2008 eNom, Inc.

API commands: DeleteSubaccount

DeleteSubaccount
Description
Definition
Delete a subaccount.

Usage
Use this command to delete a retail or reseller subaccount.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enomson/resellers/subaccount-list.asp

On the subaccounts page, the Delete link calls the DeleteSubaccount command with the Action=Confirm parameter.
Click a Delete link

On the Delete Sub-account page, the delete button calls the DeleteSubaccount command with the Action=Delete parameter.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The subaccount must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

128

1999-2008 eNom, Inc.

API commands: DeleteSubaccount

Param name Obligation

Account Required

Definition
Subaccount ID number, in NNN-aa-NNNN format. You can retrieve the subaccount ID number using the GetSubAccounts command.

Max size
11

Action

Action to take. Permitted values are Optional; Confirm Confirm which subaccount is to be deleted default value is Delete Delete the subaccount specified in this query Confirm Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Returned parameters and values

Param name Definition
Action Command ErrCount Err(x) Done Action to be taken with regard to deleting this subaccount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query deletes the sub-account with account number 332-ep-2379 and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=deletesubaccount& uid=resellid&pw=resellpw&account=332-ep-2379&Action=delete& responsetype=xml

In the response, the Action return parameter and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DeleteSubAccount> <Action>DELETE</Action> </DeleteSubAccount> <Command>DELETESUBACCOUNT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>e</Site> <IsLockable />

12/1/08

129

1999-2008 eNom, Inc.

API commands: DeleteSubaccount

<IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1523438</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CreateAccount GetSubAccountDetails GetSubAccounts

12/1/08

130

1999-2008 eNom, Inc.

API commands: DisableServices

DisableServices
Description
Definition
Switch off a service in an account.

Usage
Use this command to switch off a service in a domain name account. This command does not shut down the service or cancel it at the end of the current billing period; it merely toggles it off.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/ServiceSelection.asp?DomainNameID=152533676&service=wpps

When the unprotected option button is selected, the save changes button calls the DisableServices command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. Other constraints may apply depending on the services being disabled.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD Service Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Name of the service to be disabled. Permitted values are: WPPS (Whois Privacy Protection) EmailForwarding URLForwarding Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 15

ResponseType

Optional

12/1/08

131

1999-2008 eNom, Inc.

API commands: DisableServices

Returned parameters and values

Param name Definition
Service ServiceStatus Command ErrCount Err(x) Done Name of the service being disabled New status of this service Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query disables the ID Protect Whois privacy protection service on resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=DISABLESERVICES& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&service=wpps& responsetype=xml

In the response, the ServiceStatus value confirms the new status of the service:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Service>WPPS</Service> <ServiceStatus>Disabled</ServiceStatus> <Command>DISABLESERVICES</Command> <Language>en</Language> <ErrCount>0</ErrCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable>1</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
EnableServices GetWPPSInfo ServiceSelect

12/1/08

132

1999-2008 eNom, Inc.

API commands: EnableServices

EnableServices
Description
Definition
Switch on a service in a domain name account.

Usage
Use this command to switch on a service in a domain name account. This command does not give this account access to the service or subscribe to the service. Rather, it toggles on a service that the account has already subscribed to but has toggled off.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/ServiceSelection.asp?DomainNameID=152533676&service=wpps

When the protected option button is selected, the save changes button calls the EnableServices command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. Other constraints may apply depending on the services being enabled.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD Service Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Name of the service to be enabled. Permitted values are: WPPS (Whois Privacy Protection) EmailForwarding URLForwarding Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 15

ResponseType

Optional

12/1/08

133

1999-2008 eNom, Inc.

API commands: EnableServices

Returned parameters and values

Param name Definition
Service ServiceStatus Command ErrCount Err(x) Done Name of the service being enabled New status of this service Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query enables the ID Protect Whois privacy protection service on resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=ENABLESERVICES& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&service=wpps& responsetype=xml

In the response, the ServiceStatus value confirms the new status of the service:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Service>WPPS</Service> <ServiceStatus>Enabled</ServiceStatus> <Command>ENABLESERVICES</Command> <Language>en</Language> <ErrCount>0</ErrCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable>1</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

134

1999-2008 eNom, Inc.

API commands: EnableServices

Related commands
AddToCart DisableServices GetWPPSInfo PurchaseServices ServiceSelect SetRenew SetResellerServicesPricing UpdateAccountPricing

12/1/08

135

1999-2008 eNom, Inc.

API commands: Extend

Extend
Description
Definition
Extend (renew) the registration period for a domain name.

Usage
Use this command to renew domain registrations in real time. We recommend that you renew at least a week before the domain expiration date. Most commonly, this command is used by resellers who maintain their own databases. Resellers who use a shopping cart and our order processing queue generally use the AddToCart command with input parameter ProductType=Renew. After a domain expires, use UpdateExpiredDomains to reactivate it and renew its registration.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

The Extend command is a real-time command that is not implemented on enom.com; however, on the domain control panel page, the add years button behaves similarly to the Extend command.

Constraints
The query must meet the following requirements: To use our credit card processing, this must be an ETP reseller account. The domain name must be valid and active. The new expiration date cannot be more than 10 years in the future.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD NumYears

Obligation
Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Number of years to extend

Max size
20 20 63 15 10

12/1/08

136

1999-2008 eNom, Inc.

API commands: Extend

Param name
OverrideOrder

Obligation
Optional

Definition

Max size

1 Use OverrideOrder=1 to submit more than one renewal request for this domain name within 24 hours of the first transaction If UseCreditCard=yes, use eNoms credit-card processing services End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Amount to charge per year for the renewal. Use DD.cc format. Type of credit card 3 15

UseCreditCard EndUserIP

Optional Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Optional Required if UseCreditCard =yes

ChargeAmount

CardType

20

CCName

Cardholder's name

60

CreditCardNumber

Customer's credit card number

128

CreditCardExpMonth

Credit card expiration month

CreditCardExpYear

Credit card expiration year

CVV2

Credit card verification code

CCAddress

Credit card billing address

60

CCZip

Credit card billing postal code

15

CCCountry

Credit card billing country

60

RegistrantFirstName

Registrant first name

60

RegistrantLastName

Registrant last name

60

RegistrantAddress1

Registrant address

60

RegistrantAddress2 RegistrantCity

Registrant additional address info Registrant city

60 60

12/1/08

137

1999-2008 eNom, Inc.

API commands: Extend

Param name
RegistrantStateProvinceChoice

Obligation
Optional

Definition
Registrant state or province choice: S state P province Registrant state or province

Max size
1

RegistrantStateProvince

Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Optional Optional Required if UseCreditCard =yes

60

RegistrantPostalCode

Registrant postal code

16

RegistrantCountry

Registrant country

60

RegistrantEmailAddress

Registrant email address

128

RegistrantOrganizationName RegistrantJobTitle RegistrantPhone

Registrant organization Registrant job title Registrant phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Format of response. Options are Text (default), HTML, or XML.

60 60 20

RegistrantFax

Optional

20

ResponseType

Optional

Returned parameters and values

Param name Definition
RegistrarHold OrderID Extension RRPCode RRPText Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Order number if successful. We recommend that you store this value for future use. Returns Successful, otherwise this parameter isn't returned. Success code. Only a 200 indicates success. Text which accompanies and describes the RRPCode. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
If using our credit card option ALL credit card information is required.

12/1/08

138

1999-2008 eNom, Inc.

API commands: Extend

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. We recommend that you store the OrderID valueat least the most recent one for each domainfrom the return. Several other commands use this value as a required input parameter. 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
The following query requests that the registration period for resellerdocs.com be extended for 1 year, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=Extend& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&NumYears=1&ResponseType=XML

The response confirms the successful extension of the registration period for the domain:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Extension>successful</Extension> <DomainName>resellerdocs.com</DomainName> <OrderID>156062933</OrderID> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>EXTEND</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
Extend_RGP ExtendDomainDNS GetDomainExp GetExtendInfo GetPOPExpirations GetRenew InsertNewOrder RenewPOPBundle SetRenew UpdateExpiredDomains

12/1/08

139

1999-2008 eNom, Inc.

API commands: Extend_RGP

Extend_RGP
Description
Definition
Renew domain names that are in RGP status, in near-real time. This command charges not only the usual renewal fee, but also the higher redemption fee.

Usage
Use this command to extend names that are in RGP status. This command does not yet accommodate names in Extended RGP status. Use the GetExpiredDomains command to check a names status. RGP redemptions are performed at the Registry and generally take at least 3 hours to complete. When you run this command, we recommend that you store the Order ID so that you can check progress conveniently using the GetOrderDetail command. This command will result in both a redemption and a renewal charge for the domain name. We recommend that you check the RGP redemption price before running this command, as it can be quite high.

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: This command is available only to ETP reseller accounts. The login ID and password must be valid. The domain name must belong to this account. This command does not support our credit card processing; it deducts from the reseller balance. This command applies only to names in RGP status, not Extended RGP or domains in Expired status. To determine the status of a name, use the GetExpiredDomains command.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation
Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

140

1999-2008 eNom, Inc.

API commands: Extend_RGP

Param name
SLD TLD ResponseType

Obligation
Required Required Optional

Definition
Second-level domain name (for example, enom in enom.com) of name in RGP status Top-level domain name (extension) of name in RGP status Format of response. Options are Text (default), HTML, or XML.

Max size
63 15 4

Returned parameters and values

Param name Definition
Extension DomainName OrderID Command ErrCount Err(x) Done Success status of the query Name of the domain to be redeemed Order ID number. Store this number to simplify progress checks. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
We recommend that you check the redemption price for RGP names before running this command, as the price can be quite high. Use the PE_GetResellerPrice command, and look at product types 16 (renew) and 17 (RGP). 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
The following query redeems and renews a domain name that is in RGP status, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=Extend_RGP&uid=resellid&pw=resellpw& sld=VeryExpiredName&tld=com&ResponseType=xml

In the response, the Extension value Successful value confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Extension>successful</Extension> <DomainName>VeryExpiredName.com</DomainName> <OrderID>156251141</OrderID> <Command>EXTEND_RGP</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount>

12/1/08

141

1999-2008 eNom, Inc.

API commands: Extend_RGP

<MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.2109375</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddToCart Extend ExtendDomainDNS GetExpiredDomains GetOrderDetail GetRenew PE_GetResellerPrice PE_SetPricing Purchase PurchaseServices SetRenew UpdateExpiredDomains

12/1/08

142

1999-2008 eNom, Inc.

API commands: ExtendDomainDNS

ExtendDomainDNS
Description
Definition
In real time, renew DNS hosting services for a domain name that is registered elsewhere.

Usage
Use this command to renew DNS services for a name that is registered elsewhere. This is a real-time command that is most commonly used by resellers who maintain their own databases. Resellers who use a shopping cart and our order queue generally use the AddToCart command with input parameter ProductType=HostRenew.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/Checkout.asp

The ExtendDomainDNS command is not implemented on www.enom.com. However, on the checkout page, the purchase button calls InsertNewOrder, a similar command that initiates checkout. The difference is that InserNewOrder acquires contents of the shopping cart and puts them in a queue for checkout; the ExtendDomainDNS command bypasses the shopping cart and the queue.

Constraints
The query must meet the following requirements: The login ID and password must be valid. To use our credit card processing, this must be an ETP reseller account. The domain name must not be registered with us, but must use our name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD NumYears

Obligation
Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Number of years to add to the DNS hosting subscription. Default value is 1. Maximum total is 10.

Max size
20 20 63 15 2

12/1/08

143

1999-2008 eNom, Inc.

API commands: ExtendDomainDNS

Param name
RegistrantFirstName

Obligation

Definition

Max size
60

Required if using Registrant first name our credit card processing Required if using Registrant last name our credit card processing Required if using Registrant address our credit card processing Optional Registrant additional address info Required if using Registrant city our credit card processing Optional Registrant country Required if using Registrant email address our credit card processing Optional Optional Optional Registrant organization Registrant job title Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

RegistrantLastName

60

RegistrantAddress1

60

RegistrantAddress2 RegistrantCity

60 60

RegistrantCountry RegistrantEmailAddress

60 128

RegistrantOrganizationName RegistrantJobTitle RegistrantPhone

60 60 20

RegistrantFax

Optional

20

RegistrantPostalCode

Required if using Registrant postal code our credit card processing Optional Optional Registrant state or province Registrant state or province choice: S state P province Amount to charge to the credit card If UseCreditCard=yes, use our credit-card processing services End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Type of credit card. Permitted values are Visa, Mastercard, AmEx, and Discover Cardholder's name

16

RegistrantStateProvince RegistrantStateProvinceChoice

60 1

ChargeAmount UseCreditCard EndUserIP

Optional Optional Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes

6 3 15

CardType

20

CCName

60

CreditCardNumber

Customer's credit card number

128

12/1/08

144

1999-2008 eNom, Inc.

API commands: ExtendDomainDNS

Param name
CreditCardExpMonth

Obligation
Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Optional

Definition
Credit card expiration month, in MM format Credit card expiration year, in YYYY format Credit card verification code

Max size
2

CreditCardExpYear

CVV2

CCAddress

Credit card billing address

60

CCZip

Credit card billing postal code

15

CCCountry

Credit card billing country

60

ResponseType

Format of response. Options are Text (default), HTML, or XML.

Returned parameters and values

Param name Definition
RegistrarHold CCTransResult OrderID Command ErrCount Err(x) Done Registrar hold setting for this domain name Success status for the credit card transaction Order ID, assigned by us Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

145

1999-2008 eNom, Inc.

API commands: ExtendDomainDNS

Example
The following query renews DNS hosting for domain resellerdnshost.com, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=EXTENDDOMAINDNS& uid=resellid&pw=resellpw&sld=resellerdnshost&tld=com&numyears=1& RegistrantFirstName=John&RegistrantLastName=Doe&RegistrantAddress1=17462& RegistrantCity=Redmond&RegistrantPostalCode=98052&RegistrantCountry=USA& RegistrantPhone=+1.4255559999&[email protected]& UseCreditCard=yes&CardType=mastercard&CCName=John+Doe& CreditCardNumber=5555555555555555&CreditCardExpMonth=05&CreditCardExpYear=2005& cVV2=555&ccAddress=17462&ChargeAmount=12&responsetype=xml

In the response, the order ID and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <CCTRANSRESULT>APPROVED</CCTRANSRESULT> <OrderID>156180311</OrderID> <Command>EXTENDDOMAINDNS</Command> <ErrCount>0</ErrCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddToCart DeleteHostedDomain Extend InsertNewOrder Purchase PurchaseHosting PurchasePOPBundle PurchaseServices

12/1/08

146

1999-2008 eNom, Inc.

API commands: Forwarding

Forwarding
Description
Definition
Set email forwarding addresses.

Usage
Use this command to specify forwarding addresses for email sent to the domain. A similar command, SetPOPForwarding, allows you to create, change, or delete mailboxes for either email forwarding or POP mail.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/MailConfig.asp?DomainNameID=152533676

On the e-mail settings page,the save changes button calls the Forwarding command.

Constraints
The query must meet the following requirements: The domain must be using eNoms domain name server. The domain must exist in the account cited in the query. The query must include all addresses that you want to keep. Forwarding addresses not included in the query are deleted from the account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

12/1/08

147

1999-2008 eNom, Inc.

API commands: Forwarding

Param name Obligation Definition

AddressX ForwardToX ResponseType Required Required Optional Address (mailbox user name) to be forwarded from this domain Where this address will be forwarded to, in format [email protected] Format of response. Options are Text (default), HTML, or XML.

Max size
30 130 4

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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: [email protected] to be forwarded to [email protected]. Pass as Address1=thisAddress and [email protected]

Example
The following query gives instructions that email addressed to [email protected] and [email protected] be forwarded to [email protected] and [email protected], and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=Forwarding& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& Address1=jane.doe&[email protected]& Address2=john.doe&[email protected]&ResponseType=XML

The error count 0 confirms that the email forwarding instructions are successful:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <MailCount>2</MailCount> <Command>FORWARDING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]>

12/1/08

148

1999-2008 eNom, Inc.

API commands: Forwarding

</debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak GetCatchAll GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetCatchAll SetDotNameForwarding SetPOPForwarding SetUpPOP3User

12/1/08

149

1999-2008 eNom, Inc.

API commands: GetAccountInfo

GetAccountInfo
Description
Definition
Get account ID, password, authorization question and answer, reseller flag, and credit card agreement settings.

Usage
Use this command to return a short list of account identification information and reseller status. GetAllAccountInfo, a similar command, returns a complete list of account information.

Availability
All resellers have access to this command.

Implementation on eNom.com
This command runs in the background of eNoms Web site.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
UserID Password AuthQuestionType AuthQuestionAnswer Account Reseller AcceptTerms

Definition
Current login ID Current account password Current authorization question Current answer to the authorization question Account number Is this a reseller account or not Returns True if the credit card agreement has been signed, False otherwise

12/1/08

150

1999-2008 eNom, Inc.

API commands: GetAccountInfo

Param name
Command ErrCount Err(x) Done

Definition
Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a limited list of account information for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetAccountInfo& uid=resellid&pw=resellpw&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetAccountInfo> <UserID>resellid</UserID> <Password>resellpw</Password> <AuthQuestionType>smaiden</AuthQuestionType> <AuthQuestionAnswer>Jones</AuthQuestionAnswer> <Account>217-no-0647</Account> <Reseller>True</Reseller> <AcceptTerms>True</AcceptTerms> </GetAccountInfo> <Command>GETACCOUNTINFO</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

151

1999-2008 eNom, Inc.

API commands: GetAccountInfo

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateAccountInfo UpdateCusPreferences

12/1/08

152

1999-2008 eNom, Inc.

API commands: GetAccountPassword

GetAccountPassword
Description
Definition
Get the password for an account.

Usage
Use this command to have the password for an account e-mailed to the contact for that 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.
http://resellertest.enom.com/help/

On the help page, the Password recovery link calls the GetAccountPassword command.

Constraints
The query must meet the following requirements: The AuthQuestionAnswer value must be correct.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID LoginID AuthQuestionAnswer ResponseType

Obligation Definition
Required Required Required Optional Account login ID Login ID for the account for which you want the password. Answer to the authorization question Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 50 4

Returned parameters and values

Param name
GotAccountInfo Command ErrCount

Definition
Account information has been located in the registrars database. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

153

1999-2008 eNom, Inc.

API commands: GetAccountPassword

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the password for subaccount olerud, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetAccountPassword& uid=resellid&pw=resellpw&LoginID=olerud&AuthQuestionAnswer=Jones&responsetype=xml

In the response, the true value for GotAccountInfo and the 0 value for ErrCount indicate that the query was successful. The password is sent to the registrant e-mail address almost instantly.
<?xml version="1.0" ?> <interface-response> <GetSubAcctLogin> <GotAccountInfo>true</GotAccountInfo> </GetSubAcctLogin> <Command>GETACCOUNTPASSWORD</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountValidation GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SendAccountEmail UpdateAccountInfo UpdateCusPreferences

12/1/08

154

1999-2008 eNom, Inc.

API commands: GetAccountValidation

GetAccountValidation
Description
Definition
Retrieve the authorization question and answer for a subaccount.

Usage
Use this command to retrieve the authorization question and answer for a subaccount. Typically, you would use this command to validate the identity of a user before using the GetAccountPassword command to email their password to them.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/EditContact.asp

In the Login ID and Password Information section, the Secret Word Type and Secret Word fields display the return values of the GetAccountValidation command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The subaccount must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW LoginID ResponseType Required Required Required Optional

Definition
Login ID of the parent account Password of the parent account Login ID of the subaccount Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 20 4

12/1/08

155

1999-2008 eNom, Inc.

API commands: GetAccountValidation

Returned parameters and values

Param name
AuthQuestionType LoginID Command ErrCount Err(x) Done

Definition
The authorization question for the subaccount The login ID of the subaccount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

AuthQuestionAnswer The answer to the authorization question for the subaccount

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
The following query retrieves the authorization question and answer for subaccount olerud and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getaccountvalidation& uid=resellid&pw=resellpw&loginid=olerud&responsetype=xml

In the response, values for AuthQuestionType and AuthQuestionAnswer indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <GetAcctValidation> <AuthQuestionType>Mother's Maiden Name</AuthQuestionType> <AuthQuestionAnswer>Smith</AuthQuestionAnswer> <LoginID>olerud</LoginID> </GetAcctValidation> <Command>GETACCOUNTVALIDATION</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.0390625</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

156

1999-2008 eNom, Inc.

API commands: GetAccountValidation

Related commands
GetAccountPassword GetSubAccounts GetSubaccountsDetailList SendAccountEmail

12/1/08

157

1999-2008 eNom, Inc.

API commands: GetAddressBook

GetAddressBook
Description
Definition
Retrieve all contact information that has been entered for all domains in this account.

Usage
Use this command to retrieve all contact information that has been entered for domains in this account. This command retrieves only information associated with names in this account. It does not retrieve information from subaccounts. A typical use for this command is for accounts that offer real-time purchases, where the account contains domain names registered by many customers.

Availability
All resellers have access to this command.

Implementation on eNom.com
This command is not implemented on enom.com. This command will typically be used by a domain name reseller for administrative purposes.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW PageSize Page Required Required Optional; default is 100 Optional; default is 1 Optional

Definition
Account login ID Account password Number of contacts to return in this response Which page of responses to return. For example, if PageSize=100&Page=2 generates the second page of 100 contacts: contacts 101 through 200. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4 3

ResponseType

12/1/08

158

1999-2008 eNom, Inc.

API commands: GetAddressBook

Returned parameters and values

Param name
Address Rec PartyID OrganizationName JobTitle FirstName LastName Address1 Address2 City StateProvince StateProvinceChoice PostalCode Country Phone PhoneExt Fax Email Count TotalPages Command ErrCount Err(x) Done

Definition
Record number for this contact, assigned dynamically when this query runs Party ID for this contact, a permanent value Organization name Job title First name Last name Street address, first line Street address, second line City State or province S indicates the StateProvince value is a state; P indicates province Postal code Country Phone number Phone extension Fax number Email address Number of contacts returned in this response (may be fewer than the PageSize value) Total number of pages of contacts that exist for this account, given the PageSize value submitted in this query. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
The first contact in the response will always be the Billing contact for the account. This is true regardless of the Page and PageSize values submitted in the query. Other than the first contact in the response, contacts are listed in the order they are retrieved from our database. No sort parameters are offered for this command. 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
The following query retrieves the first 100 contacts recorded for account resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETADDRESSBOOK& uid=resellid&pw=resellpw&responsetype=xml

12/1/08

159

1999-2008 eNom, Inc.

API commands: GetAddressBook

In the response, address records, a Count value, and a TotalPages value confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <AddressBook> <Address rec="0"> <PartyId>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyId> <OrganizationName>Reseller Documents Inc.</OrganizationName> <JobTitle>President</JobTitle> <FirstName>John</FirstName> <LastName>Doe</LastName> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <StateProvinceChoice>S</StateProvinceChoice> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>+1.5555555555</Phone> <PhoneExt /> <Fax>+1.5555555556</Fax> <Email>[email protected]</Email> </Address> <Address rec="2"> <PartyId>{AD45BE6C-B3FA-4F7D-ADC1-A1D5B97EAB4B}</PartyId> <OrganizationName>eMachines, Inc.</OrganizationName> <JobTitle /> <FirstName>Administration,</FirstName> <LastName>Domains</LastName> <Address1>14350 Myford Rd. Bldg. #100</Address1> <Address2 /> <City>Irvine</City> <StateProvince>CA</StateProvince> <StateProvinceChoice>S</StateProvinceChoice> <PostalCode>92606</PostalCode> <Country>US</Country> <Phone>(714) 481-2828</Phone> <PhoneExt /> <Fax /> <Email>[email protected]</Email> </Address> . . . <Count>100</Count> <TotalPages>3</TotalPages> </AddressBook> <Command>GETADDRESSBOOK</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>6.515625</ExecTime> <Done>true</Done> <debug>

12/1/08

160

1999-2008 eNom, Inc.

API commands: GetAddressBook

<![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddContact Contacts DeleteContact GetContacts GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure

12/1/08

161

1999-2008 eNom, Inc.

API commands: GetAgreementPage

GetAgreementPage
Description
Definition
Retrieve the up-to-date Registration Agreement.

Usage
Use this command to retrieve the up-to-date verbiage for our Registration Agreement. You can implement this command in your own Web site so that your agreement page always contains the current language.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/help/HostTerms.asp

The eNoms Registration Agreement link calls the GetAgreementPage command.

Constraints
The query must meet the following requirements: The login ID and password must be valid.

12/1/08

162

1999-2008 eNom, Inc.

API commands: GetAgreementPage

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Page Required Required Optional; default is Agreement

Definition
Account login ID Account password Which agreement to retrieve. Permitted values are: Agreement General registration agreement Altdotcom Additional Registry requirements for .Country.com and .Country.net TLDs (such as .br.com and .se.net) Biz additional requirements for .biz Ca additional requirements for .ca Cc additional requirements for .cc, .bz, and .ws Cn additional requirements for .cn De additional requirements for .de Info additional requirements for .info Jobs additional requirements for .jobs Jp additional requirements for .jp Kids additional requirements for .kids Name additional requirements for .name Nu additional requirements for .nu Tm additional requirements for .tm Tv additional requirements for .tv Tw additional requirements for .tw Uk additional requirements for .uk Us additional requirements for .us Language of agreement. Permitted values are: Eng English Ger German Por Portuguese Spa Spanish

Max size
20 20 9

Language

Optional; default is Eng

ResponseType

Optional

Format of response. Options are Text (default), HTML, or 4 XML. For this command, the text response is URL-encoded so that the response will parse correctly.

Returned parameters and values

Param name Definition
Content Command ErrCount Err(x) Done Content of the Registration Agreement Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

163

1999-2008 eNom, Inc.

API commands: GetAgreementPage

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
The following query retrieves the Registration Agreement text and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetAgreementPage& uid=resellid&pw=resellpw&responsetype=xml

In the response, the presence of Regristration Agreement verbiage indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <content><table border="0" cellspacing="0" cellpadding="12" width="100%"> <tr> <td> This Registration Agreement ("Agreement") sets forth the terms and conditions of your use of domain name registration and related services ("Services"). In this Agreement . . . <Command>GETAGREEMENTPAGE</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.328125</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
None

12/1/08

164

1999-2008 eNom, Inc.

API commands: GetAllAccountInfo

GetAllAccountInfo
Description
Definition
Combines GetAccountInfo, GetCustomerPaymentInfo, and GetCustomerPreferences.

Usage
Use this command to access all information for an account.

Availability
All resellers have access to this command.

Implementation on eNom.com
This command runs in the background of eNoms Web site.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
OrganizationName JobTitle FName LName Address1 Address2 City StateProvince

Definition
Name of organization Job title First Name Last Name Address line 1 Address line 2 City State or province

12/1/08

165

1999-2008 eNom, Inc.

API commands: GetAllAccountInfo

Param name
StateProvinceChoice PostalCode Country Phone Fax EmailAddress UserID Password AuthQuestionType AuthQuestionAnswer Account Reseller CardType CCName CreditCardNumber CreditCardExpMonth CreditCardExpYear CCAddress CCZip CCCountry DefPeriod PIN Enabled Command ErrCount Err(x) Done

Definition
State or province choice Postal code Country Telephone number Fax number Email address for WhoIs Current account ID Current account password Current type of question setting Current question answer Account number Is this a reseller account or not Type of credit card Cardholder's name Customer's credit card number Credit card expiration month Credit card expiration year Credit card billing address Credit card billing postal code Credit card billing country Default number of years to register a name Personal identification number for our technical support Is the technical support PIN enabled? Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

EmailAddress_Contact Email address for us to contact you about your domain name account

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
The following query requests all account information for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetAllAccountInfo& uid=resellid&pw=resellpw&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response>

12/1/08

166

1999-2008 eNom, Inc.

API commands: GetAllAccountInfo

<OrganizationName>Reseller Documents Inc.</OrganizationName> <JobTitle>President</JobTitle> <Fname>John</Fname> <Lname>Doe</Lname> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <StateProvinceChoice>S</StateProvinceChoice> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>5555555555</Phone> <Fax>5555555556</Fax> <EmailAddress>[email protected] </EmailAddress> <URL /> <GetAccountInfo> <UserID>resellid</UserID> <Password>resellpw</Password> <AuthQuestionType>smaiden</AuthQuestionType> <AuthQuestionAnswer>Jones</AuthQuestionAnswer> <Account>217-no-0647</Account> <Reseller>True</Reseller> <AcceptTerms>True</AcceptTerms> </GetAccountInfo> <GetCustomerPaymentInfo> <CCName /> <CCNumber /> <CCType /> <CCMonth /> <CCYear /> </GetCustomerPaymentInfo> <GetCustomerPreferences> <DefPeriod /> </GetCustomerPreferences> <Command>GETALLACCOUNTINFO</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

167

1999-2008 eNom, Inc.

API commands: GetAllAccountInfo

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetResellerInfo GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences

12/1/08

168

1999-2008 eNom, Inc.

API commands: GetAllDomains

GetAllDomains
Description
Definition
Get all domain names in an account.

Usage
Use this command to list all the domain names in an account, with their domain name IDs and expiration dates. We recommend that you use this command only for accounts with fewer than 200 names, because longer lists can time out. For large accounts, use GetDomains.

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: We recommend that you use this command only for accounts with fewer than 200 names, because longer lists can time out. For large accounts, use GetDomains. The login ID and password must be valid.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW UseDNS Required Required Optional

Definition
Account login ID Account password Returns a list of domains that use custom (user-specified) name servers. Permitted value is custom. Returns default name servers. Value is 1. Returns domains with the specified first character. Permitted values are 0 through 9 and A through Z. Returns domains with the specified Registrar Lock status. Permitted values are Locked and Not Locked. Returns domains with the specified Auto Renew status. Permitted values are Yes and No.

Max size
20 20 10 1 1 10 3

GetDefaultOnly Optional Letter RegistrarLock AutoRenew Optional Optional Optional

12/1/08

169

1999-2008 eNom, Inc.

API commands: GetAllDomains

Param name Obligation

Name Optional

Definition

Max size

Returns domains with the specified name, on record for the 40 contact type specified in ContactType. Permitted values are space-separated first and last names, for example, Name=John Doe. Returns domains with the specified name, on record for the 14 contact type specified in ContactType. Permitted values are Registrant, Aux Billing, Technical, or Administrative. Returns domains that use the specified name server. Use format dns1.nameserver.com. Returns domains that use the specified name servers. Permitted values are Yes or No. Format of response. Options are XML (recommended), HTML, or Text (default). 135 3 4

ContactType

Optional

NameServer UseEnomNS ResponseType

Optional Optional Optional

Returned parameters and values

Param name
DomainName DomainNameID Expiration-Date Command ErrCount Err(x) Done

Definition
Name of the domain described in this node Database ID of this domain Expiration date of this domain Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests all domains in account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetAllDomains &uid=resellid&pw=resellpw&ResponseType=XML

The response lists all domain names in the account, with the ID number and expiration date for each domain:
<?xml version="1.0" ?> <interface-response> <GetAllDomains> <DomainDetail> <DomainName>resellerdocs.com</DomainName> <DomainNameID>317534985</DomainNameID> <expiration-date>6/23/2005 6:44:19 PM</expiration-date>

12/1/08

170

1999-2008 eNom, Inc.

API commands: GetAllDomains

</DomainDetail> <DomainDetail> <DomainName>resellerdocs2.net</DomainName> <DomainNameID>317564218</DomainNameID> <expiration-date>6/23/2005 6:53:23 PM</expiration-date> </DomainDetail> <DomainDetail> <DomainName>resellerdocs3.info</DomainName> <DomainNameID>152533676</DomainNameID> <expiration-date>6/23/2005 7:15:50 PM</expiration-date> </DomainDetail> . . . <UserRequestStatus>DomainBox</UserRequestStatus> </GetAllDomains> <Command>GETALLDOMAINS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetHomeDomainList GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

171

1999-2008 eNom, Inc.

API commands: GetBalance

GetBalance
Description
Definition
Get account balances.

Usage
Use this command to return the current balance on 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.
http://resellertest.enom.com/resellers/SubAccount.asp

The Access link calls the GetBalance 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
Reseller Balance AvailableBalance Price COMPrice

Definition
Returns 1 if this is a reseller account, 0 otherwise Current account balance Current available balance Default price for names Price for .com

12/1/08

172

1999-2008 eNom, Inc.

API commands: GetBalance

Param name
NETPrice ORGPrice CCPrice TVPrice DomainCount Command ErrCount Err(x) Done

Definition
Price for .net Price for .org Price for .cc Price for .tv Current count of domains in the account Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. This command only returns the price for original purchase of domains, not tranfers or renewals. For a complete list of prices, use PE_GETPRICING.

Example
The following query requests the account balance for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetBalance& uid=resellid&pw=resellpw&responsetype=xml

The response lists the balance and the available balance:

<?xml version="1.0" ?> <interface-response> <Reseller>1</Reseller> <Balance>3,709.20</Balance> <AvailableBalance>3,669.40</AvailableBalance> <DomainCount>74</DomainCount> <Command>GETBALANCE</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CommissionAccount RefillAccount UpdateNotificationAmount

12/1/08

173

1999-2008 eNom, Inc.

API commands: GetCartContent

GetCartContent
Description
Definition
Get the contents of the shopping cart.

Usage
Use this command to display the contents of the shopping cart.

Availability
All resellers have access to this command.

Implementation on eNom.com
http://www.enom.com/

The cart link calls the GetCartContent command. The command creates the list of cart contents on the cart page.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
ItemID Description Years NameID Name

Definition
Item number Nature of the transaction. Options are Register, Renew Number of years to register Name ID Domain name

12/1/08

174

1999-2008 eNom, Inc.

API commands: GetCartContent

Param name
StatusID ItemPrice Renew NeedsConfig

Definition
Current status of the name. Value A indicates item is active and will be affected by future transactions, or I for inactive Item price Auto-renew setting. Value 1 indicates this item is set to auto-renew, 0 indicates this item is not set to auto-renew A NeedsConfig value of 1 indicates that the Preconfigure icon should be displayed for this cart item. This happens when the cart item is a domain name that requires preconfiguration, and the preconfiguration has not yet been done. An IsMailPak value of 1 indicates that the POP mail icon should be displayed for this cart item. This happens when the cart item is a domain name for which POP mail is available, and the user has not added the POP mail to the shopping cart. A ShowWPPSLink value of 1 indicates that the Whois Privacy Protection Service (WPPS) icon should be displayed for this cart item. This happens when the cart item is a domain name for which WPPS is available, and the user has not added WPPS to the shopping cart. Unit by which this item is sold A SubItem value of 0 indicates that this item is a single line item in the shopping cart A FreeTrial value of 0 indicates that the user begins paying for this item as soon as it is purchased Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

IsMailPak

ShowWPPSLink

QtyDesc SubItem FreeTrial Command ErrCount Err(x) Done

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. The parameter StatusID returns A for active and will be affected by future transactions, or I for inactive.

Example
The following query requests the contents of the shopping cart for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetCartContent& uid=resellid&pw=resellpw&ResponseType=XML

The response indicates that the shopping cart currently contains a domain to register (resellerdocs.us):
<?xml version="1.0" ?> <interface-response> <GetCartContent> <item> <ItemID>393955</ItemID> <Description>Register</Description> <ProdType>10</ProdType> <Years>1</Years>

12/1/08

175

1999-2008 eNom, Inc.

API commands: GetCartContent

<NameID>152556457</NameID> <Name>resellerdocs.us</Name> <StatusID>I</StatusID> <ItemPrice>8.95</ItemPrice> <Renew>0</Renew> <cd> <NeedsConfig>1</NeedsConfig> <IsMailPak>0</IsMailPak> <ShowWPPSLink>1</ShowWPPSLink> <p> <QtyDesc>Year(s)</QtyDesc> <SubItem>0</SubItem> <FreeTrial>0</FreeTrial> </p> </cd> </item> </GetCartContent> <Command>GETCARTCONTENT</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug><![CDATA [ ] ]></debug> </interface-response>

Related commands
AddBulkDomains AddToCart DeleteFromCart InsertNewOrder PurchasePreview UpdateCart

12/1/08

176

1999-2008 eNom, Inc.

API commands: GetCatchAll

GetCatchAll
Description
Definition
Get the forwarding address for emails addressed to nonexistent mailboxes.

Usage
Use this command to retrieve the forwarding address for nonexistent email addresses under a domain name. The domain name must be in our system, but the forwarding address does not need to be.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. http://resellertest.enom.com/domains/POPConfig.asp?DomainNameId=152533676 The Catch-All Email box at the bottom of the page uses the GetCatchAll 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

177

1999-2008 eNom, Inc.

API commands: GetCatchAll

Returned parameters and values

Param name Definition
CatchAll Command ErrCount Err(x) Done Email address that mail will be sent to if the addressee mailbox does not exist Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the Catch-All email address for this domain name, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetCatchAll& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& responsetype=xml

In the response, the presence of the Catch-All email address confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CatchAll>[email protected]</CatchAll> <Command>GETCATCHALL</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.125</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

12/1/08

178

1999-2008 eNom, Inc.

API commands: GetCatchAll

Related commands
DeletePOP3 Forwarding GetDotNameForwarding GetForwarding GetPOP3 GetPOPForwarding SetCatchAll SetDotNameForwarding SetPOPForwarding SetUpPOP3User

12/1/08

179

1999-2008 eNom, Inc.

API commands: GetCerts

GetCerts
Description
Definition
Retrieve a list of the SSL certificates that we offer.

Usage
Use this command to retrieve a list of the types of SSL certificates that we offer.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/secure/PurchaseCerts.asp?

The table lists the certs we offer.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
Reseller ProdCode ProdType ProdDesc QtyDesc Is this a reseller account? Product text ID Product number ID Product description Units in which this product is sold

12/1/08

180

1999-2008 eNom, Inc.

API commands: GetCerts

Param name Definition

RetailPrice ResellerPrice Enabled Years CertCount Command ErrCount Err(x) Done Retail selling price charged to customers Wholesale price this account pays Is this product enabled for selling? Quantities available. For example, Years=3 indicates that a customer can buy a 3year registration of this product. Number of SSL certificate products listed in this return Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of the SSL certificate products we offer, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetCerts& UID=resellid&PW=resellpw&ResponseType=XML

In the response, a list of certificates and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <GetCerts> <Reseller>True</Reseller> <Certs> <Cert1> <ProdCode>certificate-rapidssl-rapidssl</ProdCode> <ProdType>23</ProdType> <ProdDesc>SSL Certificate - RapidSSL</ProdDesc> <QtyDesc>Year(s)</QtyDesc> <RetailPrice>$78.00</RetailPrice> <ResellerPrice>$9.95</ResellerPrice> <Enabled>True</Enabled> <Years>1</Years> <Years>2</Years> <Years>3</Years> <Years>4</Years> <Years>5</Years> </Cert1> <Cert2> <ProdCode>certificate-geotrust-quickssl</ProdCode> <ProdType>26</ProdType> <ProdDesc>SSL Certificate - GeoTrust QuickSSL</ProdDesc> <QtyDesc>Year(s)</QtyDesc> <RetailPrice>$500.00</RetailPrice>

12/1/08

181

1999-2008 eNom, Inc.

API commands: GetCerts

<ResellerPrice>$69.00</ResellerPrice> <Enabled>True</Enabled> <Years>1</Years> <Years>2</Years> <Years>3</Years> <Years>4</Years> <Years>5</Years> </Cert2> . . . </Certs> <CertCount>6</CertCount> </GetCerts> <Command>GETCERTS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1992188</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CertConfigureCert CertGetApproverEmail CertGetCertDetail CertGetCerts CertModifyOrder CertParseCSR CertPurchaseCert

12/1/08

182

1999-2008 eNom, Inc.

API commands: GetConfirmationSettings

GetConfirmationSettings
Description
Definition
Retrieve the settings for email confirmations of orders.

Usage
Use this command to retrieve the current settings for email confirmations of orders (confirmations sent to you when a customer places an order).

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/ConfirmationSettings.asp

The settings on the Reseller Confirmation Email Settings page are retrieved using the GetConfirmationSettings 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
OrderConfirmation TransferOrderConfirmation

Definition
The setting for sending copies of order confirmation emails to you, when orders are placed on this account The setting for sending copies of transfer request emails to you, when orders are placed on this account

12/1/08

183

1999-2008 eNom, Inc.

API commands: GetConfirmationSettings

Param name
OrderConfirmationBCC TransferOrderConfirmationBCC EmailHead EmailTail Command ErrCount Err(x) Done

Definition
The setting for sending copies of order confirmation emails to you, when orders are placed on a subaccount of this account The setting for sending copies of transfer request emails to you, when orders are placed on a subaccount of this account If set for custom email text, the header string that will be used If set for custom email text, the tail string that will be used Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the settings for order confirmation emails, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetConfirmationSettings& uid=resellid&pw=resellpw&responsetype=xml

In the response, return values in the ConfirmationSettings node confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <ConfirmationSettings> <OrderConfirmation>True</OrderConfirmation> <TransferOrderConfirmation>True</TransferOrderConfirmation> <OrderConfirmationBCC>True</OrderConfirmationBCC> <TransferOrderConfirmationBCC>True</TransferOrderConfirmationBCC> <EmailHead>Thank you for your recent order.</EmailHead> <EmailTail>Thanks again for using our online services.</EmailTail> </ConfirmationSettings> <Command>GETCONFIRMATIONSETTINGS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>8.203125E-02</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]>

12/1/08

184

1999-2008 eNom, Inc.

API commands: GetConfirmationSettings

</debug> </interface-response>

Related commands
GetAccountInfo GetCusPreferences GetSubAccountDetails GetTLDList PE_GetRetailPricing PE_SetPricing UpdateCusPreferences

12/1/08

185

1999-2008 eNom, Inc.

API commands: GetContacts

GetContacts
Description
Definition
Get all contact data for a domain name.

Usage
Use this command to display contact information for this 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.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the utilities section, the Contact/WhoIs Information link calls the GetContacts 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD ResponseType

Obligation Definition
Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

186

1999-2008 eNom, Inc.

API commands: GetContacts

Returned parameters and values

Param name
DomainName SLD TLD DomainNameID Registrant

Definition
Domain name Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Identification number for this domain name, in our system None indicates no separate Registrant information has been entered for this domain name. Otherwise, Registrant information is returned None indicates no separate Auxiliary Billing information has been entered for this domain name. Otherwise, Auxiliary Billing contact information is returned None indicates no separate Technical contact information has been entered for this domain name. Otherwise, Technical contact information is returned None indicates no separate Admin contact information has been entered for this domain name. Otherwise, Admin contact information is returned Billing information is returned for most TLDs, with some exceptions like .eu Party ID Address 1 Address 2 City Country Email Address Fax First Name Last Name Job Title Organization Name Phone number Phone extension Postal Code State or Province True indicates that AuxBilling appears on the Contacts page as an optional alternative for this ContactType PartyID for Auxiliary Billing contact PartyID for Registrant contact Registry-specific data for some country-code TLDs. For each TLD, you can retrieve the expected extended attributes by running this command or the GetExtAttributes command. Is ID Protect permitted for this TLD? Is there a current ID Protect subscription for this domain name? Is the ID Protect subscription currently being used to protect this domain name? Expiration date for ID Protect subscription Auto renew setting for ID Protect subscription

AuxBilling

Tech

Admin

Billing ContactTypePartyID ContactTypeAddress1 ContactTypeAddress2 ContactTypeCity ContactTypeCountry ContactTypeEmailAddress ContactTypeFax ContactTypeFirstName ContactTypeLastName ContactTypeJobTitle ContactTypeOrganizationName ContactTypePhone ContactTypePhoneExt ContactTypePostalCode ContactTypeStateProvince UseBelowAuxInfo AuxID RegID ExtendedAttributes

ContactTypeStateProvinceChoice State or Province? S indicates State; P indicates Province

WPPSAllowed WPPSExists WPPSEnabled WPPSExpDate WPPSAutoRenew

12/1/08

187

1999-2008 eNom, Inc.

API commands: GetContacts

Param name
EscrowLiftDate EscrowHold ContactRestrictedTLD Command ErrCount Err(x) Done

Definition
If this domain name is currently in escrow, the lift date Is this domain name currently in escrow? Does this TLD have restrictions on the freedom to update contact information without a trade (transfer)? Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. If there are additional contact entries, Billing in the above return parameter names is replaced with REGISTRANT, AUXBILLING, TECH, or ADMIN.

Example
The following query requests the contact information for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getcontacts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response gives contact information for the registrant party and billing party, and states that no different information was provided for the auxiliary billing, technical, and administrative contacts. Where no different information is provided, these contacts default to the billing party information:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <GetContacts> <domainname sld="resellerdocs" tld="com" domainnameid="152533676">resellerdocs.com </domainname> <Registrant> <RegistrantPartyID>{F6A676E4-5BB7-453C-87A6-9BBB164318F5} </RegistrantPartyID> <RegistrantAddress1>100 Main St.</RegistrantAddress1> <RegistrantAddress2 /> <RegistrantCity>Townsville</RegistrantCity> <RegistrantCountry>US</RegistrantCountry> <RegistrantEmailAddress>[email protected]</RegistrantEmailAddress> <RegistrantFax /> <RegistrantFirstName>John</RegistrantFirstName> <RegistrantJobTitle /> <RegistrantLastName>Smith</RegistrantLastName> <RegistrantOrganizationName /> <RegistrantPhone>5555555555</RegistrantPhone> <RegistrantPostalCode /> <RegistrantStateProvince />

12/1/08

188

1999-2008 eNom, Inc.

API commands: GetContacts

<RegistrantStateProvinceChoice /> </Registrant> <AuxBilling>None</AuxBilling> <Tech>None</Tech> <Admin>None</Admin> <Billing> <BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID> <BillingAddress1>111 Main Street</BillingAddress1> <BillingAddress2 /> <BillingCity>Hometown</BillingCity> <BillingCountry>US</BillingCountry> <BillingEmailAddress>[email protected]</BillingEmailAddress> <BillingFax>555-555-5556</BillingFax> <BillingFirstName>John</BillingFirstName> <BillingJobTitle>President</BillingJobTitle> <BillingLastName>Doe</BillingLastName> <BillingOrganizationName>Reseller Documents Inc.</BillingOrganizationName> <BillingPhone>555-555-5555</BillingPhone> <BillingPostalCode>99999</BillingPostalCode> <BillingStateProvince>WA</BillingStateProvince> <BillingStateProvinceChoice>S</BillingStateProvinceChoice> <BillingFullCountry>United States</BillingFullCountry> <UseBelowAuxInfo>True</UseBelowAuxInfo> <auxID /> <regID>{F6A676E4-5BB7-453C-87A6-9BBB164318F5}</regID> </Billing> </GetContacts> <Command>GETCONTACTS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddContact Contacts DeleteContact GetAddressBook GetExtAttributes GetResellerInfo GetServiceContact GetWhoisContact Preconfigure

12/1/08

189

1999-2008 eNom, Inc.

API commands: GetCusPreferences

GetCusPreferences
Description
Definition
Retrieve global preferences for an account.

Usage
Use this command to retrieve global preferences for 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.
http://resellertest.enom.com/myaccount/Settings.asp

On the settings page, many of the settings shown can be retrieved using GetCusPreferences.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResellerKey ResellerStatus ResponseType Required Required Optional Optional Optional

Definition
Account login ID Account password Reseller EC key for this PDQ or Registry Rocket site, if different from this UID ResellerStatus=1 retrieves information about Registry Rocket sites and reseller balances Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 40 1 4

12/1/08

190

1999-2008 eNom, Inc.

API commands: GetCusPreferences

Returned parameters and values

Param name
DefPeriod AllowDNS ShowPopUps AutoRenew RegLock AutoPakRenew UseDNS ResellerStatus RenewalSetting RenewalBCC RenewalURLForward RenewalEMailForward HostName Address RecordType DefaultHostRecordOwn UseOurDNS DNSX AcceptTerms URL ParentAccount NoService BulkRegLimit ResellerKey HostPrice CCPrice InfoPrice PictureURL ContactEmail CompanyName Referrer Balance BalanceThreshold Price CCPrice AvailableBalance ResCustomerPrice CommissionBalance NotifyAmount Current commission balance for this account Send a notification email to the Billing contact for this account when available balance drops below this amount

Definition
Default period for registrations, renewals, and transfers, in years True allows name servers other than eNoms True shows pop-up menus True automatically renews the domain 30 days before it expires True requires the account holders permission to transfer the domain to another registrar True automatically renews POP paks 30 days before they expire. True uses eNoms name servers Is this a reseller account? 0 indicates no email; 1 indicates send notice; 2 indicates contact and charge customer 1 indicates send copy of email to reseller; 0 indicates no copy to reseller True automatically renews URL forwarding 30 days before the URL forwarding subscription expires. True automatically renews email forwarding 30 days before the email forwarding subscription expires. Name of this default host record Address of this default host record Record type of this default host record Is this account using its own set of default host records? Does this account use eNoms DNS servers by default? Default DNS server X for this domain name account True indicates this account has signed a credit-card processing agreement with us URL for reseller site listed in email notices This accounts parent Service status Maximum number of names this account can register in a single query Reseller key for this Registry Rocket site Price this Registry Rocket account charges for DNS hosting Price this Registry Rocket account charges for .cc Price this Registry Rocket account charges for .info URL of image file used in this Registry Rocket site Contact email address for this Registry Rocket account Company name for this Registry Rocket account Referrer for this Registry Rocket account Current balance for this reseller account Balance threshold for this reseller account Wholesale price this account pays for .com Wholesale price this account pays for .cc Avaliable balance for this account

12/1/08

191

1999-2008 eNom, Inc.

API commands: GetCusPreferences

Param name
Command ErrCount Err(x) Done

Definition
Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the account settings for resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetCusPreferences& uid=resellid&pw=resellpw&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <CustomerPrefs> <DefPeriod>4</DefPeriod> <AllowDNS>False</AllowDNS> <ShowPopups>False</ShowPopups> <AutoRenew>False</AutoRenew> <RegLock>False</RegLock> <AutoPakRenew>False</AutoPakRenew> <UseDNS>True</UseDNS> <ResellerStatus /> <RenewalSetting>0</RenewalSetting> <RenewalBCC>0</RenewalBCC> <RenewalURLForward>False</RenewalURLForward> <RenewalEmailForward>False</RenewalEmailForward> </CustomerPrefs> <CustomerInformation> <AcceptTerms>True</AcceptTerms> <URL /> </CustomerInformation> <Command>GETCUSPREFERENCES</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

192

1999-2008 eNom, Inc.

API commands: GetCusPreferences

Related commands
GetConfirmationSettings UpdateCusPreferences UpdateRenewalSettings

12/1/08

193

1999-2008 eNom, Inc.

API commands: GetCustomerDefinedData

GetCustomerDefinedData
Description
Definition
Retrieve customer-defined data.

Usage
Use this command to retrieve custom data.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ObjectID Type Required Required Required Required

Definition
Account login ID Account password Object ID number, an integer assigned when this customer-defined field was first established. Object type. Options are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Order ID, which you can retrieve using GetDomainStatus Title of this entry, or label describing this data field Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 2 1

SLD TLD OrderID Key ResponseType

Required if Type=2 Required if Type=2 Required if Type=3 Required Optional

63 15 11 50 4

12/1/08

194

1999-2008 eNom, Inc.

API commands: GetCustomerDefinedData

Returned parameters and values

Param name
Value DisplayFlag

Definition
Content of this entry Visibility to subaccount. Options are: 0 This entry not visible when logged on using subaccount ID 1 This entry is visible when logged on using subaccount ID Name of the person adding this entry Last date on which this entry was changed Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

EnteredBy LastUpdatedDate Command ErrCount Err(x) Done

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
The following query retrieves the value for the customer-defined data titled FavoriteCuisine for account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getcustomerdefineddata& uid=resellid&pw=resellpw&ObjectID=1&Type=1&Key=FavoriteCuisine& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <CustomerData> <Value>Italian</Value> <DisplayFlag>True</DisplayFlag> <EnteredBy>John</EnteredBy> <LastUpdatedDate>7/7/2003 5:46:10 PM</LastUpdatedDate> </CustomerData> <Command>GETCUSTOMERDEFINEDDATA</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

195

1999-2008 eNom, Inc.

API commands: GetCustomerDefinedData

Related commands
DeleteCustomerDefinedData SetCustomerDefinedData

12/1/08

196

1999-2008 eNom, Inc.

API commands: GetCustomerPaymentInfo

GetCustomerPaymentInfo
Description
Definition
Retrieve customer payment information.

Usage
Use this command to retrieve customer payment information.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/EditContact.asp

The Credit Card Information box contains the return values supplied by the GetCustomerPaymentInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
CCName CCNumber CCType CCMonth

Definition
Credit card holders name Credit card number Credit card type Credit card expiration month

12/1/08

197

1999-2008 eNom, Inc.

API commands: GetCustomerPaymentInfo

Param name
CCYear CCAddress CCZip CCCity CCStateProvince CCCountry CCPhoneDial CCPhone Command ErrCount Err(x) Done

Definition
Credit card expiration year Credit card billing address street address Credit card billing address postal code Credit card billing address city Credit card billing address province Credit card billing address country Telephone country code Telephone number with area code Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the payment information on record for an account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetCustomerPaymentInfo& uid=resellid&pw=resellpw&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetCustomerPaymentInfo> <CCName>John Doe</CCName> <CCNumber>************5215</CCNumber> <CCType>MASTERCARD</CCType> <CCMonth>11</CCMonth> <CCYear>2005</CCYear> <CCAddress>17462</CCAddress> <CCZip>98052</CCZip> <CCCity>Hometown</CCCity> <CCStateProvince>WA</CCStateProvince> <CCCountry>US</CCCountry> <CCPhoneDial>1</CCPhoneDial> <CCPhone>5555559999</CCPhone> </GetCustomerPaymentInfo> <Command>GETCUSTOMERPAYMENTINFO</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod>

12/1/08

198

1999-2008 eNom, Inc.

API commands: GetCustomerPaymentInfo

<Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>8.203125E-02</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CreateAccount CreateSubAccount GetAccountInfo GetAllAccountInfo GetSubAccountDetails GetSubAccounts UpdateAccountInfo UpdateCusPreferences

12/1/08

199

1999-2008 eNom, Inc.

API commands: GetDNS

GetDNS
Description
Definition
Get the nameserver settings for a domain name.

Usage
Use this command to display name servers.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name Definition
RegistrarHold NSCount DNSX UseDNS The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Number of DNS entries Name server X. Indexed X when ResponseType=Text or HTML. Which name servers a domain is using. Default indicates our name servers

12/1/08

200

1999-2008 eNom, Inc.

API commands: GetDNS

Param name Definition

NSStatus Command ErrCount Err(x) Done Returns yes if using registrar's name servers. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the domain name servers for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDNS& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <dns>ns1.name-services.com</dns> <dns>ns2.name-services.com</dns> <dns>ns3.name-services.com</dns> <dns>ns4.name-services.com</dns> <dns>ns5.name-services.com</dns> <UseDNS>ours</UseDNS> <NSStatus>Yes</NSStatus> <RRPCode /> <RRPText /> <Command>GETDNS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

201

1999-2008 eNom, Inc.

API commands: GetDNS

Related commands
CheckNSStatus DeleteNameServer GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer

12/1/08

202

1999-2008 eNom, Inc.

API commands: GetDNSStatus

GetDNSStatus
Description
Definition
Get the nameserver status for a domain name.

Usage
Use this command to determine what DNS this domain uses. The query returns values only if the domain uses eNom servers.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name Definition
UseDNS Which name servers a domain is using. Default indicates our name servers. HostsNumLimit Maximum number of host records permitted for this domain, of types A, CNAME, URL, and FRAME

12/1/08

203

1999-2008 eNom, Inc.

API commands: GetDNSStatus

Param name Definition

Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the DNS status of resellerdocs.com -- that is, whether the domain uses its registrars servers. The query also requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDNSStatus& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The NS status Yes indicates that the domain uses the registrars name servers:
<?xml version="1.0" ?> <interface-response> <UseDNS>ours</UseDNS> <HostsNumLimit>15</HostsNumLimit> <Command>GETDNSSTATUS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
CheckNSStatus DeleteNameServer GetDNS ModifyNS ModifyNSHosting RegisterNameServer UpdateNameServer

12/1/08

204

1999-2008 eNom, Inc.

API commands: GetDomainCount

GetDomainCount
Description
Definition
Get the count for registered, hosted, processing, watch list, cart item and expired domains.

Usage
Use this command to return the number of domains in each category.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

GetDomainCount is not implemented on eNom.com, but clicking the log-in button returns information that includes counts of the domains in each category.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
RegisteredCount HostCount ExpiredDomainsCount ProcessCount

Definition
Number of registered domain names. Number of hosted domain names. Number of expired domain names. Number of domain names that are still processing.

12/1/08

205

1999-2008 eNom, Inc.

API commands: GetDomainCount

Param name
KeywordCount WatchlistCount CartItemCount ExpiringCount Command ErrCount Err(x) Done

Definition
Number of keywords (obsolete feature). Number of domain names in the watchlist. Number of items in the shopping cart. Number of expiring domain names. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a tally of domains in account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainCount& uid=resellid&pw=resellpw&ResponseType=XML

The response indicates that the account has 72 registered and 2 hosted domains:
<?xml version="1.0" ?> <interface-response> <RegisteredCount>72</RegisteredCount> <HostCount>2</HostCount> <ExpiredDomainsCount>0</ExpiredDomainsCount> <ProcessCount>0</ProcessCount> <KeywordCount>0</KeywordCount> <WatchlistCount>0</WatchlistCount> <CartItemCount>2</CartItemCount> <ExpiringCount>0</ExpiringCount> <Command>GETDOMAINCOUNT</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

206

1999-2008 eNom, Inc.

API commands: GetDomainCount

Related commands
GetAllDomains GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

207

1999-2008 eNom, Inc.

API commands: GetDomainExp

GetDomainExp
Description
Definition
Get domain expiration date.

Usage
Use this command to display the expiration date for a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/

GetDomainExp is not implemented on eNom.com, but clicking the domain names link on the my enom page returns information that includes expiration dates.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

208

1999-2008 eNom, Inc.

API commands: GetDomainExp

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully. ExpirationDate Expiration date for the domain registration.

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
The following query requests the expiration date for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainExp& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response indicates that the expiration date for the domain is 6/25/2012:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <ExpirationDate>6/25/2012 4:20:24 PM</ExpirationDate> <Command>GETDOMAINEXP</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

209

1999-2008 eNom, Inc.

API commands: GetDomainExp

Related commands
Extend Extend_RGP GetAllDomains GetDomainCount GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPassword SetRegLock SetRenew StatusDomain UpdateExpiredDomains ValidatePassword

12/1/08

210

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

GetDomainFolderDetail
Description
Definition
Retrieve an extensive set of information on a domain folder.

Usage
Use this command to retrieve an extensive set of information on a domain folder.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/Domain-Manager.aspx?tab=folder

Clicking a Settings link calls the GetDomainFolderDetail command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The folder must belong to this account

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW FolderName ResponseType

Obligation
Required Required Required Optional

Definition
Account login ID Account password Name of the folder for which you want details

Max size
20 20 125

Format of response. Options are Text (default), HTML, 4 or XML.

12/1/08

211

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

Returned parameters and values

Param name
Result

Definition
Result of this query. Values are: 0 Failure 1 Success 2 Folder does not exist in this account Identification number of this folder, used by our database Name of this folder Description entered by user when this folder was created Folder type. Values are: 0 regular folder (for organizing domains) 1 Magic Folder (for managing domain settings) Folder status. Values are: 1 Standard folder 2 Magic Folder that is in sync 3 Magic Folderuser has revised settings, but not processed yet 4 Magic Folder that is out of sync Number of domains in this folder Should DNS settings be the same for all domains in this folder? Values are: 0 Leave DNS records for each domain as is 1 Update DNS records for all domains to this folders settings Synchronization status of DNS settings. Values are: 1 In sync and eligible for updates to DNS settings 2 Newly created and eligible for updates to DNS settings 3 Pendingrevisions to DNS settings are not yet processed Name server status. Values are: Yes Domains use our name servers NA Domains use custom name servers Should auto-renew settings be the same for all domains in this folder? If auto-renew is on, domains automatically renew 30 days before they expire. Values are: 0 Leave auto-renew settings for each domain as is 1 Update auto-renew settings for all domains to this folders setting Synchronization status of auto-renew settings. Values are: 1 In sync and eligible for updates to auto-renew settings 2 Newly created and eligible for updates to auto-renew settings 3 Pendingrevisions to auto-renew settings are not yet processed Auto-renew setting for this folder, if one is set. Values are: 0 Do not auto-renew domains in this folder 1 Automatically renew domains in this folder Should registrar lock settings be the same for all domains in this folder? If registrar lock is on, domains can be transferred only after the registrant grants permission. Values are: 0 Leave registrar lock settings for each domain as is 1 Update registrar lock settings for all domains to this folders setting Synchronization status of registrar lock settings. Values are: 1 In sync and eligible for updates to registrar lock settings 2 Newly created and eligible for updates to registrar lock settings 3 Pendingrevisions to registrar lock settings are not yet processed Registrar lock setting for this folder, if one is set. Values are: 0 Do not lock domains in this folder 1 Automatically lock domains in this folder

FolderID FolderName FolderDescription FolderType

FolderStatus

FolderDomainCount SyncDNS

SyncDNSStatus

NSStatus

SyncRenew

SyncRenewStatus

RenewStatus

SyncRegLock

SyncRegLockStatus

RegLockStatus

12/1/08

212

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

Param name
SyncDomainPwd

Definition
Should domain password settings be the same for all domains in this folder? If domain password is on, domains can be managed individually by their registrants, without logging in to the domain name account. Values are: 0 Leave domain password settings for each domain as is 1 Update domain password settings for all domains to the folder setting Synchronization status of domain password settings. Values are: 1 In sync and eligible for updates to domain password settings 2 Newly created and eligible for updates to domain password settings 3 Pendingrevisions to domain password settings are not yet processed Domain password setting for this folder, if one is set. Values are: 0 Do not require a password for domains in this folder 1 Require a password for all domains in this folder Should host records be the same for all domains in this folder? Host records are also known as third-level domain names, like www. Values are: 0 Leave host records for each domain as is 1 Update host records for all domains to the folder settings Synchronization status of host records. Values are: 1 In sync and eligible for updates to host records 2 Newly created and eligible for updates to host records 3 Pendingrevisions to host records are not yet processed Should any contacts be reset to match the accounts Billing contact? Values are: 0 Leave contact information for each domain as is 1 Update any contacts that have a SyncContactContactType value 1 Synchronization status of contact information. Values are: 1 In sync and eligible for updates to contact settings 2 Newly created and eligible for updates to contact settings 3 Pendingrevisions to contact settings are not yet processed Should the contact information for this contact type (Registrant, Tech, Admin, or AuxBilling) be revised to match another contact type? Values are: 0 Leave contact information for each domain as is 1 Update the contact information of this ContactType for all domains in this folder Party ID of this contact Organization name of this contact Job title of this contact First (given) name of this contact Last (family) name of this contact Address, first line, of this contact Address, second line, of this contact City of this contact State or province of this contact Is StateProvince value a state or a province? Values are: S State P Province Postal code of this contact Country of this contact Phone number of this contact Fax number of this contact Email address of this contact

SyncDomainPwdStatus

DomainPwdValue

SyncHosts

SyncHostsStatus

SyncContact

SyncContactStatus

SyncContactContactType

PartyID OrganizationName JobTitle FName LName Address1 Address2 City StateProvince StateProvinceChoice

PostalCode Country Phone Fax EmailAddress

12/1/08

213

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

Param name
PhoneExt SameAs FolderNameEnc TrafficOnly NameOnly ParkingEnabled Reseller Command ErrCount Err(x) Done

Definition
Phone extension of this contact Same As setting of this contact Name of folder True indicates that this is a Traffic Only account True indicates that this is a Name Only account True indicates that parking is enabled Customer Type. True indicates that this account is in our reseller category (Reseller, Name Only, or Traffic Only). Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves details on a folder, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainFolderDetail& uid=resellid&pw=resellpw&FolderName=Favorites&responsetype=XML

In the response, the presence of data and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0"?> <interface-response> <Result>1</Result> <Folder> <FolderID>296</FolderID> <FolderName>Favorites</FolderName> <FolderDescription><![CDATA[Favorite domain names]]></FolderDescription> <FolderType>1</FolderType> <FolderStatus>2</FolderStatus> <FolderDomainCount>0</FolderDomainCount> <DNS> <SyncDNS>0</SyncDNS> <SyncDNSStatus>2</SyncDNSStatus> <NSStatus /> </DNS> <Renew> <SyncRenew>0</SyncRenew> <SyncRenewStatus>2</SyncRenewStatus> <RenewStatus /> </Renew> <RegLock> <SyncRegLock>0</SyncRegLock> <SyncRegLockStatus>2</SyncRegLockStatus> <RegLockStatus />

12/1/08

214

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

</RegLock> <DomainPwd> <SyncDomainPwd>0</SyncDomainPwd> <SyncDomainPwdStatus>2</SyncDomainPwdStatus> <DomainPwdValue> <![CDATA[ ]]> </DomainPwdValue> </DomainPwd> <Hosts> <SyncHosts>0</SyncHosts> <SyncHostsStatus>2</SyncHostsStatus> </Hosts> <Contacts> <SyncContact>0</SyncContact> <SyncContactStatus>2</SyncContactStatus> <BillingContact> <PartyID>39AE68C0-D019-4690-9999-FD632BC1AFAA</PartyID> <OrganizationName> <![CDATA[ Number3Domain ]]> </OrganizationName> <JobTitle> <![CDATA[ Software Tester ]]> </JobTitle> <FName> <![CDATA[ John ]]> </FName> <LName> <![CDATA[ Doe ]]> </LName> <Address1> <![CDATA[ 123 Main Street ]]> </Address1> . . . </BillingContact> <RegistrantContact> . . . </RegistrantContact> <AdminContact> . . . </AdminContact> <TechContact> . . . </TechContact> <AuxBillingContact> . . . </AuxBillingContact> </Contacts> </Folder> <FolderNameEnc>Favorites</FolderNameEnc> <TrafficOnly>False</TrafficOnly> <NameOnly>False</NameOnly> <ParkingEnabled>False</ParkingEnabled> <Reseller>True</Reseller>

12/1/08

215

1999-2008 eNom, Inc.

API commands: GetDomainFolderDetail

<Command>GETDOMAINFOLDERDETAIL</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.094</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddDomainFolder AdvancedDomainSearch AssignToDomainFolder DeleteDomainFolder GetDomainFolderList RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

216

1999-2008 eNom, Inc.

API commands: GetDomainFolderList

GetDomainFolderList
Description
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.
http://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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD

Obligation
Required Required Optional

Definition
Account login ID Account password

Max size
20 20

SLD (second-level domain name) of the domain for which 63 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 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. Format of response. Options are Text (default), HTML, or XML. 4

TLD

Optional

ResponseType

Optional

12/1/08

217

1999-2008 eNom, Inc.

API commands: GetDomainFolderList

Returned parameters and values

Param name Definition
Result ID Name Type Result of this query. Possible results are: 1 Successful Folder identification number, assigned by us Folder name, assigned by you Folder type. Possible values are: 0 Standard folder; not Magic 1 Magic Number of domains in this folder Status of this folder. Possible results are: 0 Standard 2 Magic, in sync 3 Magic, in process of synchronization 4 Magic, out of sync Total number of folders in this account Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

DomainCount Status

Count Command ErrCount Err(x) Done

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
The following query requests a list of folders that contain the specified domain, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainFolderList& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

In the response, a Result value 1 and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <GetResult> <Result>1</Result> </GetResult> <folders> <item> <ID>3100</ID> <Name>ResellFolder</Name> <Type>1</Type> <DomainCount>3</DomainCount> <Status>4</Status> </item> <item>

12/1/08

218

1999-2008 eNom, Inc.

API commands: GetDomainFolderList

<ID>974</ID> <Name>a3223</Name> <Type>0</Type> <DomainCount>44</DomainCount> <Status>0</Status> </item> </folders> <count>2</count> <Command>GETDOMAINFOLDERLIST</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>1</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.109</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddDomainFolder AdvancedDomainSearch AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail RemoveUnsyncedDomains UpdateDomainFolder

12/1/08

219

1999-2008 eNom, Inc.

API commands: GetDomainInfo

GetDomainInfo
Description
Definition
Get information about a single domain name.

Usage
Use this command to display current information about a single domain name. This command also retrieves the DomainNameID value, which is required by some other commands in our API.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainManager.asp

On the my domains page, clicking a link in the Domain Name column calls the GetDomainInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

220

1999-2008 eNom, Inc.

API commands: GetDomainInfo

Returned parameters and values

Param name
RegistrarHold SLD TLD DomainNameID Multy-LangSLD Expiration Registrar RegistrationStatus Purchase-Status Party-ID Belongs-To Entry Name Changable Service

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) ID number of this individual domain Is this a multi-language SLD? Expiration date of this domain registration Registrar of this domain Registration status of this domain Purchase status of this domain Party ID of the account in which this domain is registered Login ID of the account in which this domain is registered Name of the product or service described in this node Can this service be changed? Setting for the service. Permitted values are: DNSServer (which domain name servers): 1006 use our name servers 1012 use user-specified domain servers, including none DNSSettings (host records): 1021 host records WSB (Web site services): 1060 no Web site building or hosting services 1063 Web Site Builder 1066 Web site hosting accounts EmailSet (Email services): 1048 no email 1051 email forwarding (to a POP or WebMail address) 1054 user (mail server name required) 1105 user simplified (mail servers IP address required) 1114 POP3/WebMail plus email forwarding WPPS (ID Protect Whois Privacy Protection): 1120 WhoIs information is masked 1123 WhoIs information is viewable WBL (Business Listing): 1130 Business Listing settings Messaging (NameMyPhone): 1087 disabled 1090 enabled Map (NameMyMap): 1108 disabled 1111 enabled Can this service be toggled on or off, or switched? Business Listing identification number Status number of this Business Listing Status ID of this Business Listing Expiration date of this Business Listing Visibility status of this Business Listing in the WhoisBusinessListings.com directory Automatic renewal setting of this Business Listing Company name for this Business Listing

Service Changable WBLID StatusID StatusDescr ExpDate Enabled Renew CompanyName

ConfigurationChangable Is this a configurable product or service?

12/1/08

221

1999-2008 eNom, Inc.

API commands: GetDomainInfo

Param name
CompanyDescription DomainName Street City PostalCode Country CategoryIDX FieldName Value Name Type Address MXPref Command ErrCount Err(x) Done

Definition
Description of company Domain name to which this Business Listing is attached Street address of this Business Listing City of this Business Listing Postal code of this Business Listing Country of this Business Listing Category identification number(s) of this Business Listing Name of descriptive field Descriptive content associated with this field name Name of this host record Type of product, service, or host record Host record address Priority value of this host record Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests domain informationstatus and services for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainInfo& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <GetDomainInfo> <domainname sld="resellerdocs" tld="com" domainnameid="152533676">resellerdocs.com </domainname> <multy-langSLD /> <status> <expiration>6/10/2013 3:56:56 PM</expiration> <registrar>eNom, Inc.</registrar> <registrationstatus>Registered</registrationstatus> <purchase-status>Paid</purchase-status> <belongs-to party-id="{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}">resellid

12/1/08

222

1999-2008 eNom, Inc.

API commands: GetDomainInfo

</belongs-to> </status> <services> <entry name="dnsserver"> <ourDNS value="YES" isDotName="NO" /> <service changable="1">1006</service> <configuration changable="0" type="dns"> <dns>ns1.name-services.com</dns> <dns>ns2.name-services.com</dns> <dns>ns3.name-services.com</dns> <dns>ns4.name-services.com</dns> <dns>ns5.name-services.com</dns> </configuration> </entry> <entry name="dnssettings"> <service changable="0">1021</service> <configuration changable="1" type="host"> <host> ' <name> <![CDATA[ @ ] ]> </name> <type>A</type> <address> <![CDATA[ 66.151.151.164 ] ]> </address> <mxpref>10</mxpref> </host> <host> ' <name> <![CDATA[ www ] ]> </name> <type>CNAME</type> <address> <![CDATA[ @ ] ]> </address> <mxpref>10</mxpref> </host> <host> ' <name> <![CDATA[ Hello ] ]> </name> <type>FRAME</type> <address> <![CDATA[ 127.0.0.1 ] ]> </address> <mxpref>10</mxpref> </host> </configuration> </entry> <entry name="wsb"> <service changable="1">1066</service> <configuration changable="1" type="wsb"> <wsb>resellwebid</wsb> </configuration> </entry> <entry name="emailset"> <service changable="1">1114</service> <configuration changable="1" type="pop">

12/1/08

223

1999-2008 eNom, Inc.

API commands: GetDomainInfo

<pop> <username> <![CDATA[ john.doe ] ]> </username> </pop> </configuration> </entry> <entry name="wpps"> <service changable="1">1120</service> <configuration changable="1" type="wpps"> <wpps> <cloakedemail>[email protected]</cloakedemail> <forward-to>[email protected]</forward-to> <expiredate>Nov 26, 2006</expiredate> <autorenew>No</autorenew> </wpps> </configuration> </entry> <entry name="messaging"> <service changable="1">1087</service> </entry> </services> </GetDomainInfo> <RRPCode /> <RRPText /> <Command>GETDOMAININFO</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.390625</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomains GetExpiredDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

224

1999-2008 eNom, Inc.

API commands: GetDomainMap

GetDomainMap
Description
Definition
Get name my map settings.

Usage
Use this command to display settings, for a single domain, for the name my map service.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?domainnameid=152533676

If the name my map service is enabled, clicking the configure button calls the GetDomainMap 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

225

1999-2008 eNom, Inc.

API commands: GetDomainMap

Returned parameters and values

Param name Definition
RegistrarHold Host-Name Address City StateProvince PostalCode Country Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name for user's host Address for the map City for the map State or province for the map Postal code for the map Country for the map Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
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
The following query requests the Name My Map data for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainMap& UID=resellid&PW=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response provides the Name My Map data:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <GetDomainMap> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <configuration> <map> <host-name> <![CDATA[ dns1.name-services.com ] ]> </host-name> <address> <![CDATA[ 100 Main St. ] ]> </address> <city> <![CDATA[ Townsville ] ]> </city> <stateprovince> <![CDATA[ WA ] ]> </stateprovince> <postalcode> <![CDATA[ 99999 ] ]>

12/1/08

226

1999-2008 eNom, Inc.

API commands: GetDomainMap

</postalcode> <country> <![CDATA[ US ] ]> </country> </map> </configuration> </GetDomainMap> <Command>GETDOMAINMAP</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainPhone GetIPResolver ServiceSelect SetDomainMap SetDomainPhone SetIPResolver

12/1/08

227

1999-2008 eNom, Inc.

API commands: GetDomainNameID

GetDomainNameID
Description
Definition
Retrieves the ID number for a domain.

Usage
In some API commands, you can use the domain name ID instead of the SLD and TLD. Our database associates a unique ID with each domain name, and all activity in the database is tracked by ID rather than by domain name.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name
DomainRRP RegistrarHold

Definition
Processor identifier of the registrar which manages the domain The enabled status of a domain. If RegistrarHold is True, the domain is disabled.

12/1/08

228

1999-2008 eNom, Inc.

API commands: GetDomainNameID

Param name
SLD TLD DomainNameID Command ErrCount Err(x) Done

Definition
Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Identification number of this domain name Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the domain name ID for resellerdocs.com, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getdomainnameid& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The successful response returns the domain name ID:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <SLD>resellerdocs</SLD> <TLD>com</TLD> <DomainNameID>152533676</DomainNameID> <Command>GETDOMAINNAMEID</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainSLDTLD

12/1/08

229

1999-2008 eNom, Inc.

API commands: GetDomainPhone

GetDomainPhone
Description
Definition
Get name my phone settings.

Usage
Use this command to display the current name my phone settings.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?domainnameid=152533676

If name my phone service is enabled, the configure button calls the GetDomainPhone 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

230

1999-2008 eNom, Inc.

API commands: GetDomainPhone

Returned parameters and values

Param name Definition
RegistrarHold phone-number service-email device-email host-name email-alias cc-email1 cc-email2 cc-email3 max-chars page-count Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled Phone number Service email address Complete device email address (phone number and service email combined) Host name for DNS entry (default is phone) Flag to set up Email Forwarding alias - True or False CC to email #1 CC to email #2 CC to email #3 Maximum number of characters allowed per message Total number of pages sent (not implemented) Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the Name My Phone data for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainPhone& UID=resellid&PW=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response provides the current Name My Phone information:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <GetDomainPhone> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <configuration> <device> <phone-number> <![CDATA[ 5555555555 ] ]> </phone-number> <service id="4"> <![CDATA[ Verizon ] ]> </service>

12/1/08

231

1999-2008 eNom, Inc.

API commands: GetDomainPhone

<service-type> <![CDATA[ Verizon ] ]> </service-type> <service-email> <![CDATA[ msg.myvzw.com ] ]> </service-email> <device-email> <![CDATA [ ] ]> </device-email> <template id="3">Modern</template> <service-template> <![CDATA[ 3 ] ]> </service-template> <host-name>phone</host-name> <email-alias>True</email-alias> <cc-email1> <![CDATA [ ] ]> </cc-email1> <cc-email2> <![CDATA [ ] ]> </cc-email2> <cc-email3> <![CDATA [ ] ]> </cc-email3> <max-chars>120</max-chars> <page-count>0</page-count> </device> </configuration> <options> <services> <service id="99" maxChars="200"> <![CDATA[ --Other-- ] ]> </service> <service id="5" maxChars="140"> <![CDATA[ AT&T Wireless ] ]> </service> <service id="12" maxChars="640"> <![CDATA[ Cingular ] ]> </service> <service id="1" maxChars="140"> <![CDATA[ Nextel ] ]> </service> <service id="11" maxChars="100"> <![CDATA[ Qwest ] ]> </service> <service id="2" maxChars="100"> <![CDATA[ Sprint PCS ] ]> </service> <service id="4" maxChars="120"> <![CDATA[ Verizon ] ]> </service> <service id="8" maxChars="140"> <![CDATA[ VoiceStream ] ]> </service> </services> <templates> <template id="6">Business</template> <template id="5">Hand Held</template> <template id="1">Letter Head</template> <template id="3">Modern</template>

12/1/08

232

1999-2008 eNom, Inc.

API commands: GetDomainPhone

<template id="2">Techno</template> <template id="4">Western</template> </templates> </options> </GetDomainPhone> <Command>GETDOMAINPHONE</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetIPResolver ServiceSelect SetDomainMap SetDomainPhone SetIPResolver

12/1/08

233

1999-2008 eNom, Inc.

API commands: GetDomains

GetDomains
Description
Definition
Get a single page of domain names with the ability to load the next or previous page of names.

Usage
Use this command to list a single page of domains in an account. GetDomains is the recommended command for large accounts. GetAllDomains, a similar command, returns the complete list of domain names in an account but can time out for accounts with more than 200 domain names.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/

In the my enom section, the x domain names link calls the GetDomains 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Tab

Obligation
Required Required Optional; default is IOwn

Definition
Account login ID Account password The type of domains to return. Permitted values are: IOwn current names in this account Sub_IOwn names in retail subaccounts WatchList names in this accounts watchlist IHost DNS hosting names, this account ExpiringNames names nearing expiration ExpiredDomains expired but able to renew RGP RGP and Extended RGP names Promotion names on promotional basis

Max size
20 20 10

12/1/08

234

1999-2008 eNom, Inc.

API commands: GetDomains

Param name
DaysToExpired

Obligation
Optional with Tab=ExpiringNames Optional with Tab=Sub_IOwn; default is Registered Optional; default is 25 Optional; default is 1

Definition

Max size

Return names that expire within this number of 4 days, whether they are set to auto-renew or not The type of domains to return for a subaccount. Permitted values are Registered and Expired. Number of domains to return in one response. Permitted values are 0 to 100. Return names that start with this number in the sorted list. For example, Display=25&Start=26 returns the 26th through 50th names from a numeroalphabetically sorted list. The order to return the results. Permitted values are SLD, TLD, DNS, and ExpirationDate. Return names that start with this letter If MultiLang=On, display SLD in native character set in UI. Return names that match this name. Use format SLD.TLD 10

RegStatus

Display Start

4 4

OrderBy

Optional

15

StartLetter MultiLang Domain ExtFormat

Optional Optional Optional Optional

1 1 60

1 Returns XML tags without hyphens, to more rigorously adhere to XML standards and allow more trouble-free performance with automated parsers. Use ExtFormat=1 to return tags without hyphens. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

Returned parameters and values

Param name
DomainNameIDX SLDX TLDX NS-StatusX Expiration-DateX Auto-RenewX WPPSStatusX RRProcessor Command ErrCount

Definition
Domain name ID. Indexed X when ResponseType=Text or HTML. Second-level domain name (for example, enom in enom.com). Indexed X when ResponseType=Text or HTML. Top-level domain name (extension). Indexed X when ResponseType=Text or HTML. Name server status. YES indicates this domain uses our name servers. Indexed X when ResponseType=Text or HTML. Expiration date of the domain registration. Indexed X when ResponseType=Text or HTML. Auto-renew setting. Return values are Yes or No. Indexed X when ResponseType=Text or HTML. WhoIs privacy protection setting. Return values are Enabled or Disabled. Indexed X when ResponseType=Text or HTML. RR processor. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

235

1999-2008 eNom, Inc.

API commands: GetDomains

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a list of domains and basic information about them for account resellid, and requests the response in XML format. This command returns 25 domains at a time. Because it does not specify which domain to start with, the response by default starts with the first domain (sorting by domain name: numbers first, then letters):
http://resellertest.enom.com/interface.asp?command=GetDomains& uid=resellid&pw=resellpw&ResponseType=XML

The response lists the first 25 domains in account resellid, starting with resellerdocs.com and resellerdocs3.info. It also provides some summary information about the total contents of the account:
<?xml version="1.0" ?> <interface-response> <GetDomains> <tab>iown</tab> <domain-list type="Registered"> <domain> <DomainNameID>152533676</DomainNameID> <sld>resellerdocs</sld> <tld>com</tld> <Renew>Yes</Renew> <expiration-date>6/25/2012</expiration-date> </domain> <domain> <DomainNameID>152533677</DomainNameID> <sld>resellerdocs3</sld> <tld>info</tld> <Renew>Yes</Renew> <expiration-date>6/25/2004</expiration-date> </domain> . . . </domain-list> <EndPosition>25</EndPosition> <PreviousRecords>0</PreviousRecords> <NextRecords>26</NextRecords> <OrderBy /> <Result>True</Result> <StartPosition>1</StartPosition> <DomainCount>72</DomainCount> <TotalDomainCount>72</TotalDomainCount> <StartLetter /> </GetDomains>

12/1/08

236

1999-2008 eNom, Inc.

API commands: GetDomains

<Command>GETDOMAINS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> </interface-response>

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetExpiredDomains GetExtendInfo GetHomeDomainList GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

237

1999-2008 eNom, Inc.

API commands: GetDomainServices

GetDomainServices
Description
Definition
Retrieve the settings for domain services and value-added services for a domain.

Usage
Use this command to retrieve information about email forwarding, URL forwarding, and other domain and valueadd services for a domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

On the domain control panel, change and configure buttons give access to current settings and the ability to change value-add settings.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

238

1999-2008 eNom, Inc.

API commands: GetDomainServices

Returned parameters and values

Param name
WebSite Phone IPResolver Map DomainNameID EMailForwarding EmailForwardExpDate EMailAutoRenew URLForwarding URLForwardExpDate URLAutoRenew EMailForwardingPrice URLForwardingPrice Command ErrCount Err(x) Done

Definition
Web site setting Name-My-Phone setting Setting for resolving dynamic IP addresses Name-My-Map setting ID number for this domain, from our internal records Email forwarding setting for this domain Expiration date for email forwarding Auto-renew setting for email forwarding URL forwarding setting for this domain Expiration date for URL forwarding Auto-renew setting for URL forwarding Price for email forwarding Price for URL forwarding Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the domain and value-add service settings for resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainServices& uid=resellid&pw=resellpw&responsetype=xml&sld=resellerdocs&tld=com

The response is as follows:

<?xml version="1.0" ?> <interface-response> <domainservices> <website>0</website> <phone>False</phone> <ipresolver>0</ipresolver> <map>False</map> <domainnameid>152551776</domainnameid> <valueadd> <EmailForwarding>0</EmailForwarding> <EmailForwardExpDate /> <EmailAutoRenew /> <URLForwarding>0</URLForwarding>

12/1/08

239

1999-2008 eNom, Inc.

API commands: GetDomainServices

<URLForwardExpDate /> <URLAutoRenew /> <emailForwardingPrice>0.00</emailForwardingPrice> <urlForwardingPrice>0.00</urlForwardingPrice> </valueadd> </domainservices> <Command>GETDOMAINSERVICES</Command> <ErrCount>0</ErrCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
DisableServices EnableServices GetDomainMap GetDomainPhone GetIPResolver ServiceSelect SetDomainMap SetDomainPhone SetDomainSubServices SetIPResolver

12/1/08

240

1999-2008 eNom, Inc.

API commands: GetDomainSLDTLD

GetDomainSLDTLD
Description
Definition
Retrieve the domain name (SLD and TLD).

Usage
Use this command when you have the domain name ID and want the domain name (SLD and TLD).

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW DomainNameID ResponseType

Obligation
Required Required Required Optional

Definition
Account login ID Account password Domain name ID Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 11 4

Returned parameters and values

Param name
DomainRRP RegistrarHold SLD TLD DomainNameID Command

Definition
Registrar identifier The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Domain name ID Name of command executed

12/1/08

241

1999-2008 eNom, Inc.

API commands: GetDomainSLDTLD

Param name
ErrCount Err(x) Done

Definition
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the SLD and TLD for domain name ID 152533676 and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getdomainsldtld& uid=resellid&pw=resellpw&domainnameid=152533676&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <SLD>resellerdocs</SLD> <TLD>com</TLD> <DomainNameID>152533676</DomainNameID> <Command>GETDOMAINSLDTLD</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainInfo GetDomainNameID

12/1/08

242

1999-2008 eNom, Inc.

API commands: GetDomainSRVHosts

GetDomainSRVHosts
Description
Definition
Retrieve SRV host records for a domain name.

Usage
Use this command to retrieve a list of all SRV records for a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/control-panel/default.asp?DomainNameID=152533676#

The list of SRV records is populated by the GetDomainSRVHosts 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. The domain must use our DNS servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

243

1999-2008 eNom, Inc.

API commands: GetDomainSRVHosts

Returned parameters and values

Param name Definition
HostID HostName Protocol Address RecordType MXPref Weight Priority Port Command ErrCount Err(x) Done Identification number for this SRV record, assigned by us Use name you have assigned to this SRV record Internet protocol you have assigned for this SRV record Fully qualified domain name you have assigned for this SRV record Host record type for this recordshould always be SRV MXPref value. Not used for SRV records Weight you have assigned to this SRV record (for load balancing) Priority you have assigned to this SRV record (for backup servers) Port you have assigned to this SRV record Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves SRV records and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETDOMAINSRVHOSTS& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <srv-records> <srv> <HostID>17217418</HostID> <HostName>_imap</HostName> <Protocol>_TCP</Protocol> <Address>imap.resellerdocs.com.</Address> <RecordType>SRV</RecordType> <mxPref>0</mxPref> <Weight>50</Weight> <priority>10</priority> <Port>1</Port> </srv> <srv> <HostID>17217420</HostID> <HostName>_xmpp</HostName> <Protocol>_UDP</Protocol> <Address>xmpp.resellerdocs.com.</Address> <RecordType>SRV</RecordType>

12/1/08

244

1999-2008 eNom, Inc.

API commands: GetDomainSRVHosts

<mxPref>0</mxPref> <Weight>50</Weight> <priority>10</priority> <Port>98</Port> </srv> </srv-records> <Command>GETDOMAINSRVHOSTS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.047</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
GetDomainInfo GetHosts SetDomainSRVHosts SetHosts

12/1/08

245

1999-2008 eNom, Inc.

API commands: GetDomainStatus

GetDomainStatus
Description
Definition
Check the registration status of TLDs that do not register in real time.

Usage
Use this command to check the status of domains that do not register in real time (including .ca, .co.uk, .org.uk, and others). Because of the delay inherent in the non-real-time registrations, wait at least five minutes after your transaction to run this command, and run it at intervals of five minutes or longer. This command runs more quickly than a similar command, StatusDomain. Use this command to retrieve the most recent order ID for a domain name.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD OrderID OrderType Required Required Required Required Recommended Optional; default is Purchase Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Order ID of the most recent transaction for this domain Type of order. Permitted values are Purchase (default), Transfer, or Extend Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 15 10

ResponseType

12/1/08

246

1999-2008 eNom, Inc.

API commands: GetDomainStatus

Returned parameters and values

Param name Definition
DomainName InAccount Domain name Status of the domain in our database: 0 not in our database 1 in our database and in the account cited in this query 2 in our database but in a different account than the one cited in this query More detailed explanation of the InAccount value Expiration date of the domain registration Order identification number of the most recent transaction for this domain Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

StatusDesc ExpDate OrderID Command ErrCount Err(x) Done

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
The following query retrieves the status of domain resellerdocs.co.uk and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETDOMAINSTATUS& uid=resellid&pw=resellpw&sld=resellerdocs&tld=co.uk& orderID=156162742&ordertype=purchase&responsetype=xml

In the response, the InAccount value 0 and the StatusDesc value Awaiting Registry Response confirm that the order is currently being processed at the co.uk Registry:
<?xml version="1.0" ?> <interface-response> <DomainStatus> <DomainName>resellerdocs.co.uk</DomainName> <InAccount>0</InAccount> <StatusDesc>Awaiting Registry Response</StatusDesc> <OrderID>156162742</OrderID> </DomainStatus> <Command>GETDOMAINSTATUS</Command> <ErrCount>0</ErrCount> <Server>Test1</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>False</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

247

1999-2008 eNom, Inc.

API commands: GetDomainStatus

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

248

1999-2008 eNom, Inc.

API commands: GetDomainSubServices

GetDomainSubServices
Description
Definition
Get current settings for domain services (active or inactive).

Usage
Use this command to get which services are enabled to control whether to present the user the ability to get or update information related to the service. (eg. Host or email forwarding records). For some services, you can get more detailed information using the GetDomainServices command.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=GetDomainSubServices& uid=yourloginid&pw=yourpassword&sld=domain&tld=com

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

249

1999-2008 eNom, Inc.

API commands: GetDomainSubServices

Returned parameters and values

Param name
RegistrarHold EmailForwarding HostRecords SetDomainServices Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. True, False or empty True, False or empty Successful or Failed Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets the subservices of a domain and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetDomainSubServices& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The error count value of 0 confirms that hosts have been set successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <DomainServices> <EmailForwarding>True</EmailForwarding> <HostRecords>True</HostRecords> </DomainServices> <Command>GETDOMAINSUBSERVICES</Command> <ErrCount>0</ErrCount> <Server>Dev</Server> <Site>enom</Site> <Done>true</Done> </interface-response>

12/1/08

250

1999-2008 eNom, Inc.

API commands: GetDomainSubServices

Related commands
GetDomainMap GetDomainPhone GetIPResolver ServiceSelect SetDomainMap SetDomainPhone SetDomainSubServices SetIPResolver

12/1/08

251

1999-2008 eNom, Inc.

API commands: GetDotNameForwarding

GetDotNameForwarding
Description
Definition
Retrieve the current address for email forwarding by the .name Registry.

Usage
Use this command to retrieve the email forwarding address used by the .name Registry for forwarding email addressed to this domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. On the domain names menu, click my domains, and then click a .name domain. In the email settings box of the domain control panel, the .name email button calls the GetDotNameForwarding 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. The domain must be a .name domain.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63

Top-level domain. For this command, value must be name. 15 4

12/1/08

252

1999-2008 eNom, Inc.

API commands: GetDotNameForwarding

Returned parameters and values

Param name
DomainNameID SLD TLD Status Address Command ErrCount Err(x) Done

Definition
Domain name ID, eNoms internal accounting number Second-level domain name (for example, enom in enom.com) Top-level domain. For this command, value is name. Status Email address to which email addressed to this domain is forwarded. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the email forwarding address for john.doe.name and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getdotnameforwarding& uid=resellid&pw=resellpw&sld=john.doe&tld=name&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <dotnameforwarding> <domainname domainnameid="157171163" sld="john.doe" tld="name" /> <status>1</status> <address>[email protected]</address> </dotnameforwarding> <Command>GETDOTNAMEFORWARDING</Command> <ErrCount>0</ErrCount> <Server>Reseller5</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

253

1999-2008 eNom, Inc.

API commands: GetDotNameForwarding

Related commands
Forwarding GetCatchAll GetForwarding GetPOP3 SetCatchAll SetDotNameForwarding

12/1/08

254

1999-2008 eNom, Inc.

API commands: GetExpiredDomains

GetExpiredDomains
Description
Definition
Retrieve a list of an accounts domains that are in expired, RGP, and Extended RGP status.

Usage
Use this command to retrieve a list of expired, RGP, and Extended RGP names in the account specified in the query string. Typically, a reseller will use this information to determine which command to use to reactivate a domain, and what price they will charge.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainManager.asp?tab=iown

Clicking the expired or redemption tabs call the GetExpiredDomains 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
DomainName DomainNameID Status

Definition
Domain name Domain name ID number, from our database Expiration status of this domain

12/1/08

255

1999-2008 eNom, Inc.

API commands: GetExpiredDomains

Param name
Expiration-Date LockStatus Command ErrCount Err(x) Done

Definition
Expiration date of this domain Registrar lock status of this domain Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the expired domains in account resellid; identifies them as Expired, RGP, or Extended RGP status; and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getexpireddomains& uid=resellid&pw=resellpw&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainDetail> <DomainName>northwestcrafts.com</DomainName> <DomainNameID>152139242</DomainNameID> <status>Extended RGP</status> <expiration-date>2/26/2003</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> <DomainDetail> <DomainName>fabrics-wallpaper.com</DomainName> <DomainNameID>152134074</DomainNameID> <status>RGP</status> <expiration-date>3/1/2003 6:54:40 AM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> <DomainDetail> <DomainName>onlinebrochure.com</DomainName> <DomainNameID>152129772</DomainNameID> <status>RGP</status> <expiration-date>6/4/2002 6:18:36 PM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> <DomainDetail> <DomainName>eweathervane.com</DomainName> <DomainNameID>2062920</DomainNameID> <status>Expired</status> <expiration-date>3/8/2002 2:14:45 AM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail>

12/1/08

256

1999-2008 eNom, Inc.

API commands: GetExpiredDomains

<DomainDetail> <DomainName>signonworldwide.com</DomainName> <DomainNameID>2063248</DomainNameID> <status>Expired</status> <expiration-date>3/8/2002 11:38:32 PM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> <DomainDetail> <DomainName>Youcanhelp.net</DomainName> <DomainNameID>152151738</DomainNameID> <status>Expired</status> <expiration-date>3/7/2002 6:44:29 PM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> <DomainDetail> <DomainName>ccpays.com</DomainName> <DomainNameID>2082140</DomainNameID> <status>Extended RGP</status> <expiration-date>4/26/2002 4:01:46 PM</expiration-date> <lockstatus>Locked</lockstatus> </DomainDetail> . . . <domaincount>120</domaincount> <Command>GETEXPIREDDOMAINS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>1.503906</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddToCart Extend_RGP GetDomainInfo GetDomains PE_SetPricing Purchase

12/1/08

257

1999-2008 eNom, Inc.

API commands: GetExtAttributes

GetExtAttributes
Description
Definition
This command retrieves the extended attributes for a country code TLD (required parameters specific to the country code).

Usage
Use this command to determine whether a country code TLD requires extended attributes, and what they are. Extended attributes supplied by this command are used in the Preconfigure command to configure some TLDs. Input parameter names for the Preconfigure command are tagged <Name> in the return of this command, and permitted values for the Preconfigure command are tagged <Value> in the return for this command.

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 domain name must belong to this account. The country code must be valid.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW TLD ResponseType Required Required Required Optional Account login ID Account password Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 15 4

12/1/08

258

1999-2008 eNom, Inc.

API commands: GetExtAttributes

Returned parameters and values

Param name Definition
ID Name Value Title Application UserDefined Required ID number for our internal use Parameter name. Use this as the input parameter name in the Preconfigure command. Parameter value for the query string. Use this as the input parameter value in the Preconfigure command. Short definition of the parameter value Application. 2 indicates Registrant contact. User must supply the value for this parameter from outside sources Obligation of this parameter. 0 indicates optional, 1 indicates required, 2 indicates a child attribute/parameter that is required for some values of the parent. Values that require the child are indicated in the <Required> node of the parent. Extended definition of the parameter value If IsChild=1, this parameter is the child of another extended attribute. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Description IsChild Command ErrCount Err(x) Done

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
The following query requests the extended attributes for the .us TLD and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getextattributes& uid=resellid&pw=resellpw&tld=us&responsetype=xml

The response indicates that the entended attributes for .us are us_nexus, global_cc_us, and us_purpose. In the Preconfigure command, these parameters would be input, for example, as us_nexus=C11&us_purpose=P2:
<?xml version="1.0" ?> <interface-response> <Attributes> <Attribute> <ID>1</ID> <Name>us_nexus</Name> <Application>2</Application> <UserDefined>False</UserDefined> <Required>1</Required> <Description>Nexus Category</Description> <IsChild>0</IsChild> <Options> <Option>

12/1/08

259

1999-2008 eNom, Inc.

API commands: GetExtAttributes

<ID>12</ID> <Value>C11</Value> <Title>US Citizen</Title> <Description>A natural person who is a US Citizen</Description> </Option> <Option> <ID>13</ID> <Value>C12</Value> <Title>Permanent Resident</Title> <Description>A natural person who is a Permanent Resident</Description> </Option> . . . </Options> </Attribute> <Attribute> <ID>4</ID> <Name>global_cc_us</Name> <Application>2</Application> <UserDefined>False</UserDefined> <Required>0</Required> <Description>Country</Description> <IsChild>1</IsChild> <Options /> </Attribute> <Attribute> <ID>2</ID> <Name>us_purpose</Name> <Application>2</Application> <UserDefined>False</UserDefined> <Required>1</Required> <Description>Application Purpose</Description> <IsChild>0</IsChild> <Options> <Option> <ID>17</ID> <Value>P1</Value> <Title>For Profit</Title> <Description>Business use for profit</Description> </Option> <Option> <ID>18</ID> <Value>P2</Value> <Title>Non-profit</Title> <Description>Non-profit business, club, association, religious organization, etc. </Description> </Option> . . . </Options> </Attribute> </Attributes> <Command>GETEXTATTRIBUTES</Command> <ErrCount>0</ErrCount> <Server>Reseller3</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done>

12/1/08

260

1999-2008 eNom, Inc.

API commands: GetExtAttributes

<debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
AddContact Contacts GetAddressBook GetContacts GetWhoisContact Preconfigure

12/1/08

261

1999-2008 eNom, Inc.

API commands: GetExtendInfo

GetExtendInfo
Description
Definition
Get extension (renewal) information.

Usage
Use this command to display information about the expiration date of a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

On the domain control panel page, the add years button calls the GetExtendInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

262

1999-2008 eNom, Inc.

API commands: GetExtendInfo

Returned parameters and values

Param name
RegistrarHold Expiration MaxExtension CCAuthorized Price Balance AvailableBalance DefPeriod AllowDNS ShowPopups AutoRenew RegLock AutoPakRenew UseDNS ResellerStatus RenewalSetting

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Current expiration date. Maximum # of years that can be added. Credit card transaction successfully authorized. Price for one-year extension for this type of TLD. Current balance in this account. Available balance in this account. Account-level setting for default renewal period for domain name registrations Account-level settingTrue allows domain name servers other than eNoms Account-level settingTrue shows popup menus Account-level settingTrue automatically renews the domain registration 30 days before it expires Account-level settingTrue requires the account holders permissiont to transfer the domain to another registrar Account-level settingTrue automatically renews POP paks 30 days before they expire Account-level settingTrue uses eNoms name servers Account-level settingReseller status of this account Account-level setting 0 Send no renewal reminder when domain expiration approaches 1 Send renewal reminder by email 2 Contact customer, renew registration, and charge account Account-level setting 1 Send blind carbon copy of renewal email to reseller 0 Do not send blind carbon copy to reseller Account-level settingTrue automatically renews URL forwarding 30 days before the subscription expires Account-level settingTrue automatically renews email forwarding 30 days before the subscription expires Account-level settingTrue automatically renews email forwarding 30 days before the subscription expires Account-level settingTrue automatically renews email forwarding 30 days before the subscription expires Account-level settingTrue automatically renews email forwarding 30 days before the subscription expires Account-level settingName of default host record Account-level settingDefault host record address Account-level settingDefault host record type Indicates whether this domain is associated with a Web hosting account Account-level settingBy default, does this account assign user-defined host records? Account-level settingBy default, does this account assign our DNS to domain names? Account-level settingDefault name servers True has signed a credit card processing agreement with eNom

RenewalBCC

RenewalURLForward RenewalEmailForward MailNumLimit IDProtect DefIDProtectRenew HostNameX AddressX RecordTypeX DefaultHostRecordOwn DefaultHostRecordOwn UseOurDNS DNSX AcceptTerms

12/1/08

263

1999-2008 eNom, Inc.

API commands: GetExtendInfo

Param name
URL Command ErrCount Err(x) Done

Definition
URL for reseller site, used in email notices Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests renewal information for resellerdocs.com and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getextendinfo& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Expiration>06/25/2004</Expiration> <MaxExtension>8</MaxExtension> <CCAuthorized>True</CCAuthorized> <Price>8.95</Price> <Balance>39.80</Balance> <AvailableBalance>39.80</AvailableBalance> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>GETEXTENDINFO</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

12/1/08

264

1999-2008 eNom, Inc.

API commands: GetExtendInfo

Related commands
Extend GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPassword SetRegLock SetRenew StatusDomain UpdateExpiredDomains ValidatePassword

12/1/08

265

1999-2008 eNom, Inc.

API commands: GetForwarding

GetForwarding
Description
Definition
Get email forwarding records for a domain name.

Usage
Use this command to display email forwarding records for a domain name. A similar command, GetPOPForwarding, displays both email forwarding and POP records for a single email address.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?domainnameid=152533676

On the domain control panel, if the e-mail settings service is set to e-mail forwarding, the configure button calls the GetForwarding 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. The domain must use eNoms domain name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD

Obligation Definition
Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com)

Max size
20 20 63

12/1/08

266

1999-2008 eNom, Inc.

API commands: GetForwarding

Param name
TLD GetDefaultOnly

Obligation Definition
Required Optional Top-level domain name (extension) If this is set to 1, extra blank input records are returned for user input on the email forwarding form. Primarily used in XML output. Format of response. Options are Text (default), HTML, or XML.

Max size
15 1

ResponseType

Optional

Returned parameters and values

Param name
RegistrarHold UserNameX Alias ForwardToX Forward-To StatusX

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Alias name to forward. Indexed X when ResponseType=Text or HTML. Alias name to forward. Present when ResponseType=XML Email address to forward the alias to. Indexed X when ResponseType=Text or HTML. Email address to forward the alias to. Present when ResponseType=XML Enabled status of email forwarding: 0 Email forwarding enabled 1 Email forwarding disabled Indexed X when ResponseType=Text or HTML. Number of email forwarding records currently configured Total number of email forwarding records permitted for this domain name True True Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

EmailCount MaxEmail EmailForwarding HostRecords Command ErrCount Err(x) Done

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
The following query requests e-mail forwarding information for resellerdocs.com and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getforwarding& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

12/1/08

267

1999-2008 eNom, Inc.

API commands: GetForwarding

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <eforward> <alias>jane.doe</alias> <forward-to>[email protected]</forward-to> </eforward> <eforward> <alias>john.doe</alias> <forward-to>[email protected]</forward-to> </eforward> <EmailCount>2</EmailCount> <Command>GETFORWARDING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetDotNameForwarding GetMailHosts GetPOP3 ModifyPOP3 PurchasePOPBundle SetDotNameForwarding SetUpPOP3User

12/1/08

268

1999-2008 eNom, Inc.

API commands: GetFraudScore

GetFraudScore
Description
Definition
Retrieve a fraud score.

Usage
Use this command to retrieve a fraud score. Fraud scores range from 0 to 100; 100 represents the highest risk of fraud (though note that it represents a probability, not a certainty, of fraud). As a rule of thumb, a fraud score of 50 or higher warrants review; a score of 75 or higher warrants a high level of scrutiny. You may want to adjust these guidelines based on your companys tolerance for risk.

Availability
This command is available to resellers who do not use our credit card processing services, and who subscribe to our fraud scoring service.

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. This account must subscribe to our fraud scoring service.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD EmailAddress CardNumber EndUserIP Country Required Required Optional Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) for which you want fraud score information

Max size
20 20 63

Email address about which you want fraud information, 130 in format [email protected] Credit card number, in 16-digit format IP address of the end user, in format NNN.NNN.NNN.NNN Country, in 2-letter country-code format 16 19 2

12/1/08

269

1999-2008 eNom, Inc.

API commands: GetFraudScore

Param name Obligation

ProductType Optional; if this parameter is not included, the fraud score returned reflects all products except domains and Web hosting

Definition

Max size

Product type, usually the product type this customer is 7 trying to purchase. Permitted values are: domain a domain name hosting Web hosting No value all products except domains and Web hosting

ChargeAmount Required Quantity ResponseType Required Optional

Amount this customer is trying to charge, in format DD.cc Quantity of this product that customer is trying to purchase

1000.00 2

Format of response. Options are Text (default), HTML, 4 or XML.

Returned parameters and values

Param name Definition
Score Fraud score, composited from the parameter values you supplied in the query string. Fraud scores range from 0 to 100; 100 represents the highest risk of fraud (though note that it represents a probability, not a certainty, of fraud). As a rule of thumb, a fraud score of 50 or higher warrants review; a score of 75 or higher warrants a high level of scrutiny. You may want to adjust these guidelines based on your companys tolerance for risk. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query retrieves a fraud score for the values provided, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getfraudscore& uid=resellid&pw=resellpw&CardNumber=4111111111111111&sld=thisdomain& EndUserIP=127.0.0.1&[email protected]&Country=US& ProductType=hosting&ChargeAmount=25&Quantity=1&responsetype=xml

In the response, a Score return value confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <Score>80</Score>

12/1/08

270

1999-2008 eNom, Inc.

API commands: GetFraudScore

<Command>GETFRAUDSCORE</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site /> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>2.351563</ExecTime> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
None

12/1/08

271

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatus

GetGlobalChangeStatus
Description
Definition
Retrieve a list of IDs for instances in which a global edit command was run on this account.

Usage
Use this command to retrieve ResponseIDs for global edits performed on domains in this account. Commonly, you will run this command to get a ResponseID in order to run the GetGlobalChangeStatusDetail command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/globaledit.asp

The Click here to view the status and history of your previous global edits link calls the GetGlobalChangeStatus 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
RequestID ReqDate ReqTypeDesc ID number of the request for the change described in this node Time-stamp for this request Description of the requested change

12/1/08

272

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatus

Param name Definition

ReqStatusDesc Status of the requested change Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query Retrieves the global changes that have been requested in account resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetGlobalChangeStatus& UID=resellid&PW=resellpw&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetGlobalChangeStatus> <GlobalStatusInfo> <RequestID>8332</RequestID> <ReqDate>9/2/2003 3:51:47 PM</ReqDate> <ReqTypeDesc>Registrar-lock on</ReqTypeDesc> <ReqStatusDesc>Open</ReqStatusDesc> </GlobalStatusInfo> <GlobalStatusInfo> <RequestID>8331</RequestID> <ReqDate>9/2/2003 3:51:47 PM</ReqDate> <ReqTypeDesc>Auto renew on</ReqTypeDesc> <ReqStatusDesc>Open</ReqStatusDesc> </GlobalStatusInfo> <GlobalStatusInfo> <RequestID>8326</RequestID> <ReqDate>8/29/2003 5:19:00 PM</ReqDate> <ReqTypeDesc>Auto renew on</ReqTypeDesc> <ReqStatusDesc>Open</ReqStatusDesc> </GlobalStatusInfo> <GlobalStatusInfo> <RequestID>8325</RequestID> <ReqDate>8/29/2003 5:19:00 PM</ReqDate> <ReqTypeDesc>Use Our DNS</ReqTypeDesc> <ReqStatusDesc>Open</ReqStatusDesc> </GlobalStatusInfo> <GlobalStatusInfo> <RequestID>8324</RequestID> <ReqDate>8/29/2003 5:18:59 PM</ReqDate> <ReqTypeDesc>Contact changes</ReqTypeDesc>

12/1/08

273

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatus

<ReqStatusDesc>Open</ReqStatusDesc> </GlobalStatusInfo> </GetGlobalChangeStatus> <Command>GETGLOBALCHANGESTATUS</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetGlobalChangeStatusDetail

12/1/08

274

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatusDetail

GetGlobalChangeStatusDetail
Description
Definition
Retrieve a list of the domains affected by the specified global update, and the success status for each.

Usage
Use this command to check the success of global changes.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/domains/globalaccountstatus.asp

Clicking any of the RequestID links calls the GetGlobalChangeStatusDetail command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The ResponseID must match a global update that was performed in this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW RequestID ResponseType Required Required Required Optional

Definition
Account login ID Account password ID number for the global change to one parameter. Use the GetGlobalChangeStatus command to retrieve this value. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 6 4

Returned parameters and values

Param name Definition
DomainName StatusDesc Domain name Status of this change to this domain

12/1/08

275

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatusDetail

Param name Definition

ErrorDesc Command ErrCount Err(x) Done Description of any error encountered during this change Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the status for each domain affected by global change RequestID=8331 and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetGlobalChangeStatusDetail& UID=resellid&PW=resellpw&RequestID=8331&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetGlobalChangeStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD1.biz</DomainName> <StatusDesc>Processed successfully</StatusDesc> <ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD2.com</DomainName> <StatusDesc>Processed successfully</StatusDesc> <ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD3.biz</DomainName> <StatusDesc>Processed successfully</StatusDesc> <ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD4.com</DomainName> <StatusDesc>Processed successfully</StatusDesc> <ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD5.com</DomainName> <StatusDesc>Processed successfully</StatusDesc> <ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> <GlobalStatusDetail> <DomainName>TestSLD6.us</DomainName> <StatusDesc>Processed successfully</StatusDesc>

12/1/08

276

1999-2008 eNom, Inc.

API commands: GetGlobalChangeStatusDetail

<ErrorDesc>none</ErrorDesc> </GlobalStatusDetail> </GetGlobalChangeStatusDetail> <Command>GETGLOBALCHANGESTATUSDETAIL</Command> <ErrCount>0</ErrCount> <Server>Reseller2</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetGlobalChangeStatus

12/1/08

277

1999-2008 eNom, Inc.

API commands: GetHomeDomainList

GetHomeDomainList
Description
Definition
Retrieve a list of registered and hosted domains in this account that use our domain name servers.

Usage
Use this command to retrieve a list of registered and hosted domains in this account that use our domain name servers. A typical use of this command is to retrieve domains that are eligible to use our DNS-dependent services.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. http://resellertest.enom.com/websitecreator/wscsignup.asp For accounts with 25 or fewer domain names that use our DNS, the Select a domain text box is a dropdown menu populated by the GetHomeDomainList 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW StartPosition Required Required Optional; default is 1 Optional; default is 25 Optional; default is SLD Optional

Definition
Account login ID Account password Return domain names beginning with this number. For example, if StartPosition=26&Display=25, display names 26 through 50 in the ordered list.

Max size
20 20 5

Display OrderBy ResponseType

How many domain names to include in response. Permitted 100 values are 1 to 100. Sort the response by this criterion. Permitted values are SLD, TLD, or RegStatus. Format of response. Options are Text (default), HTML, or XML. 9 4

12/1/08

278

1999-2008 eNom, Inc.

API commands: GetHomeDomainList

Returned parameters and values

Param name Definition
ID Name RegStatus Command ErrCount Err(x) Done Our numeric ID number for this domain Domain name Registration status Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of domains in this account that use our DNS servers, sorted by TLD, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETHOMEDOMAINLIST& uid=resellid&pw=resellpw&display=25&orderby=tld&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetHomeDomains> <StartPosition>1</StartPosition> <Display>25</Display> <OrderBy>TLD, SLD</OrderBy> <NewStartPosition>1</NewStartPosition> <DomainCount>16</DomainCount> <TotalDomains>16</TotalDomains> <Domains> <Domain> <ID>152542653</ID> <Name>bajadazoo.biz</Name> <RegStatus>Registered</RegStatus> </Domain> <Domain> <ID>152542655</ID> <Name>tomalotamous.biz</Name> <RegStatus>Registered</RegStatus> </Domain> <Domain> <ID>152544200</ID> <Name>apophyleti.com</Name> <RegStatus>Hosted</RegStatus> </Domain> <Domain>

12/1/08

279

1999-2008 eNom, Inc.

API commands: GetHomeDomainList

<ID>152542612</ID> <Name>pangolineament.com</Name> <RegStatus>Registered</RegStatus> </Domain> . . . <Domain> <ID>152542654</ID> <Name>terraforaminifer.net</Name> <RegStatus>Registered</RegStatus> </Domain> </Domains> </GetHomeDomains> <Command>GETHOMEDOMAINLIST</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.125</ExecTime> <Done>true</Done> </interface-response>

Related commands
AddToCart GetAllDomains GetDomains GetReport PurchaseServices

12/1/08

280

1999-2008 eNom, Inc.

API commands: GetHosts

GetHosts
Description
Definition
Get host records for a domain name.

Usage
Use this command to return all host records. GetRegHosts, a similar command, does not return mail host records.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

On the domain control panel, the DNS settings (zone file) box retrieves its information using the GetHosts command. Clicking the configure button brings up the GetHosts command in editable form.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name must belong to this account. The domain must use eNoms domain name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

281

1999-2008 eNom, Inc.

API commands: GetHosts

Returned parameters and values

Param name Definition
RegistrarHold Name Type MXPref Address The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Host name of record. Record Type. Returns A, URL, MX, MXE, CNAME or FRAME. Preference level: the lower this value, the higher priority this service. Default value is 10. Address. Can be an IP for record types A, MXE and FRAME only. Record types URL and FRAME can be a full URL. Record types MX, URL, FRAME and CNAME can be a fully qualified domain name. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query requests all host records, including mail hosts, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=gethosts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response lists the hosts:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Website>0</Website> <host> <name>www</name> <type>A</type> <address>127.0.0.1</address> </host> <host> <name>@</name> <type>A</type> <address>127.0.0.1</address> </host> <host> <name>mail</name> <type>MXE</type> <mxpref>10</mxpref> <address>127.0.0.1</address> </host> <Command>GETHOSTS</Command>

12/1/08

282

1999-2008 eNom, Inc.

API commands: GetHosts

<ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetMetaTag GetRegHosts GetSPFHosts SetDNSHost SetHosts SetSPFHosts UpdateMetaTag

12/1/08

283

1999-2008 eNom, Inc.

API commands: GetIPResolver

GetIPResolver
Description
Definition
Get IP Resolver settings.

Usage
Use this command to retrieve the NameMyComputer settings for a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

On the domain control panel page, the GetIPResolver command provides the content of the name my computer box.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

284

1999-2008 eNom, Inc.

API commands: GetIPResolver

Returned parameters and values

Param name Definition
RegistrarHold Host-Name Client-Service Client-User-ID ID Name Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Host name for the service. Currently only service type 1 for ICQ. Client ID (ICQ #). Option ID for the client service. Currently returns only ICQ. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully. IP-Resolver-ID Currently 1240 for ICQ.

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
The following query requests IP resolver information for the domain resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getipresolver& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response indicates that the IP resolver host name is home, and the client user ID is 12345678:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <GetIPResolver> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <configuration> <ipresolver> <ip-resolver-id>1243</ip-resolver-id> <host-name> <![CDATA[ home ] ]> </host-name> <client-service>1</client-service> <client-user-id> <![CDATA[ 12345678 ] ]> </client-user-id> </ipresolver> </configuration> <options> <clients>

12/1/08

285

1999-2008 eNom, Inc.

API commands: GetIPResolver

<client> <id>1</id> <name>ICQ</name> <short-name>icq</short-name> <description> <![CDATA[ ICQ ] ]> </description> </client> </clients> </options> </GetIPResolver> <Command>GETIPRESOLVER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA [ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetDomainPhone ServiceSelect SetDomainMap SetDomainPhone SetIPResolver

12/1/08

286

1999-2008 eNom, Inc.

API commands: GetMailHosts

GetMailHosts
Description
Definition
Get mail hosts (DNS information) only.

Usage
Use this command to retrieve the mail records associated with a domain name.

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 domain name must belong to this account. The domain must use eNoms domain name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name Definition
RegistrarHold HostNameX RecordTypeX The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Host name. For the GetMailHosts command, this is mail.DomainName.tld Record type. Permitted values are MXE (email forwarding) or MX (POP3 mail).

12/1/08

287

1999-2008 eNom, Inc.

API commands: GetMailHosts

Param name Definition

AddressX MXPrefX ServiceSelect IP address of eNoms mail forwarding service. Preference level: the lower this value, the higher priority this service. Default value is 10. The identification number of the email service for this domain. 1048 no email 1051 email forwarding ("easy" mail) 1054 user configured 1105 user simplified 1114 enable POP Mail Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query requests the mail host information for the domain resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getmailhosts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <EmailForwarding>True</EmailForwarding> <HostName11>mail</HostName11> <RecordType11>MXE</RecordType11> <Address11>209.19.56.20</Address11> <MXPref11>10</MXPref11> <ServiceSelect>1051</ServiceSelect> <Command>GETMAILHOSTS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

288

1999-2008 eNom, Inc.

API commands: GetMailHosts

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetForwarding GetPOP3 ModifyPOP3 PurchasePOPBundle SetUpPOP3User

12/1/08

289

1999-2008 eNom, Inc.

API commands: GetMetaTag

GetMetaTag
Description
Definition
Retrieve the metatags for one of a domains host records.

Usage
Use this command to retrieve the current metatags for one host record for a domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with login ID resellid, password resellpw.
http://resellertest.enom.com/domains/HostConfig.asp?DomainNameID=152533676

After you assign to a host record a record type of URL Frame, then click save changes, then in the DNS Settings (zone file) section click configure, the edit link calls the GetMetaTag 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD MetaTagHostID

Obligation
Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

Host record ID for this host record for this domain; our 8 internal tracking number. You can retrieve all host IDs for a domain using the GetRegHosts command. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

12/1/08

290

1999-2008 eNom, Inc.

API commands: GetMetaTag

Returned parameters and values

Param name
TitleBar SiteDescription Keywords DomainNameID Command ErrCount Err(x) Done

Definition
Metatag content for browser title bar Metatag content for search engine results Metatag content for search engine keywords ID number for this domain, our internal tracking number Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the HTML metatag contents for the specified host record, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getmetatag& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& MetaTagHostID=11415002&ResponseType=XML

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <metatags> <titlebar>MY COOL TITLE</titlebar> <sitedescription>MY SITE DESCRIPTION</sitedescription> <keywords>MY SITE KEYWORDS</keywords> <DomainNameID>152533676</DomainNameID> </metatags> <Command>GETMETATAG</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

291

1999-2008 eNom, Inc.

API commands: GetMetaTag

Related commands
GetHosts GetRegHosts SetHosts UpdateMetaTag

12/1/08

292

1999-2008 eNom, Inc.

API commands: GetOrderDetail

GetOrderDetail
Description
Definition
Get detailed information about an order.

Usage
Use this command to retrieve contents and details of an order when you know the order number. Use this command to monitor status when an order includes non-real-time domain names (names that, at the time you submit the order, have an RRPCode value of 1300 and an IsRealTimeTLD value of false).

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/ViewOrders.asp

On the view orders page, clicking a link in the Order # column calls the GetOrderDetail 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW OrderID Required Required Required Account login ID Account password The identification number of the order for which you want details. You can retrieve this number using the GetOrderList command. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10

ResponseType

Optional

12/1/08

293

1999-2008 eNom, Inc.

API commands: GetOrderDetail

Returned parameters and values

Param name
OrderID Result BillDate CCRefNum ProductType Description Status Quantity AmountPaid

Definition
9-digit order identification number. True/False -- True indicates that this order exists, and exists under this account. Time at which customers account was billed for the transaction amount. Credit card reference number for this transaction, generated by us. Description of this item. Description of the item. Return value is usually a domain name. Status for fulfilling the order for this item. Only a status Successful indicates that the Registry has registered this name to you. Number of years. Amount paid for this item. If the Registry has processed this name and has not registered it to you, the AmountPaid value is Not billed. If the value is Not billed, check the Status parameter for the reason for failure. Domain password, if one was assigned Order status. If OrderStatus is Open, check back later: the order is still being processed. If OrderStatus is Closed, check the Status parameter. If we registered the domain the Status value is Successful. Any other value indicates a failure. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

DomainPassword OrderStatus

Command ErrCount Err(x) Done

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
The following query requests the details of order 156062775, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetOrderDetail& uid=resellid&pw=resellpw&orderid=156062775&responsetype=xml

The response indicates that in this order, the account successfully purchased 2 products:
<?xml version="1.0" ?> <interface-response> <Order> <OrderID>156062775</OrderID> <Result>True</Result> <BillDate>7/19/2002 3:42:29 PM</BillDate> <CCRefNum /> <OrderBillAmount>$35.80</OrderBillAmount> <AdjustToAccount /> <Certs>False</Certs>

12/1/08

294

1999-2008 eNom, Inc.

API commands: GetOrderDetail

<OrderDetail> <ProductType>Register</ProductType> <Description>resellerdocs2.net</Description> <Status>Successful</Status> <Quantity>2</Quantity> <AmountPaid>$17.90</AmountPaid> </OrderDetail> <OrderDetail> <ProductType>Register</ProductType> <Description>resellerdocs3.info</Description> <Status>Successful</Status> <Quantity>2</Quantity> <AmountPaid>$17.90</AmountPaid> </OrderDetail> </Order> <Command>GETORDERDETAIL</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetDomainStatus GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences

12/1/08

295

1999-2008 eNom, Inc.

API commands: GetOrderList

GetOrderList
Description
Definition
Get a list of the orders placed through this account.

Usage
Use this command to retrieve a list of orders, identified by order number.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/myaccount/newreports.asp

In the Report Categories menu, select the view orders option. Clicking the view report button calls the GetOrderList 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Start Required Required Optional

Definition
Account login ID Account password Return sets of 25 records in reverse chronological order. For example, Start=26 returns the 26th through 50th most recent orders. Defaults to 1.

Max size
20 20 4

BeginDate

Optional; if omitted, six Beginning date of orders to return. Must be no more than six months before EndDate. Permitted months of orders are format is MM/DD/YYYY returned Optional; if omitted, EndDate is today Optional End date of orders to return. Must be no more than six months after BeginDate. Permitted format is MM/DD/YYYY Format of response. Options are Text (default), HTML, or XML.

10

EndDate

10

ResponseType

12/1/08

296

1999-2008 eNom, Inc.

API commands: GetOrderList

Returned parameters and values

Param name
OrderID OrderDate StatusDesc

Definition
Order identification number, in nine-digit format. Date on which the order was placed. Time stamp indicates the time at which our database received the order. Overall status of the order. Options are: 0 New 1 Authorization Succeeded 2 Authorization Failed 3 Processing 5 Ready for billing 6 Order complete 7 Order canceled True/False -- True indicates the order has been processed. Yes/No -- Yes gives user access to previous and next transactions. Yes/No -- Yes displays a link that calls the previous block of transactions. First transaction to include in the response, counting back from the most recent, if user clicks the Previous link. First transaction to include in the response, counting back from the most recent. Last transaction to include in the response, counting back from the most recent. Yes/No -- Yes displays a link that calls the next block of transactions. Total number of orders stored for this account. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

OrderProcessFlag ShowPreviousAndNext ShowPreviousLink PreviousStartPosition ShowStart ShowEnd ShowNextLink RecordCount Command ErrCount Err(x) Done

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
The following query requests a list of orders successfully submitted through account resellid. The optional Start=26 parameter specifies that the list should start with the 26th most recent order. The query requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetOrderList& uid=resellid&pw=resellpw&Start=26&responsetype=xml

The response gives an overview of orders starting with the 26th most recent. Normally, the response would include the 26th through 50th most recent orders; this response ends with the 37th because only 37 orders have been placed in the lifetime of the account:
<?xml version="1.0" ?> <interface-response>

12/1/08

297

1999-2008 eNom, Inc.

API commands: GetOrderList

<OrderList> <OrderDetail> <OrderID>156062752</OrderID> <OrderDate>7/19/2002 12:28:37 PM</OrderDate> <StatusDesc>Order complete</StatusDesc> <OrderProcessFlag>True</OrderProcessFlag> </OrderDetail> <OrderDetail> <OrderID>156062751</OrderID> <OrderDate>7/19/2002 12:15:27 PM</OrderDate> <StatusDesc>Order complete</StatusDesc> <OrderProcessFlag>True</OrderProcessFlag> </OrderDetail> <OrderDetail> <OrderID>156062750</OrderID> <OrderDate>7/19/2002 12:10:34 PM</OrderDate> <StatusDesc>Order complete</StatusDesc> <OrderProcessFlag>True</OrderProcessFlag> </OrderDetail> . . . <ShowPreviousAndNext>Yes</ShowPreviousAndNext> <ShowPreviousLink>Yes</ShowPreviousLink> <PreviousStartPosition>1</PreviousStartPosition> <ShowStart>26</ShowStart> <ShowEnd>37</ShowEnd> <ShowNextLink>No</ShowNextLink> <RecordCount>37</RecordCount> </OrderList> <Command>GETORDERLIST</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetReport GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences

12/1/08

298

1999-2008 eNom, Inc.

API commands: GetPasswordBit

GetPasswordBit
Description
Definition
Check to see if a password is set for a domain name.

Usage
Use this command to determine whether a password is set for a domain name, and what the password is.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

On the domain control panel, in the utilities box, the Domain Access Password link calls the GetPasswordBit 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

299

1999-2008 eNom, Inc.

API commands: GetPasswordBit

Returned parameters and values

Param name
RegistrarHold PasswordSet DomainPassword Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Returns 1 if a password is set, 0 otherwise. If PasswordSet=1, then a password is returned in this parameter. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the domain name password for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getpasswordbit& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

In the response, the password-set value of 1 indicates that a password is set. The DomainPassword value indicates that the domain password is userpw.
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <DomainPassword>userpw</DomainPassword> <password-set>1</password-set> <Command>GETPASSWORDBIT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

300

1999-2008 eNom, Inc.

API commands: GetPasswordBit

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

301

1999-2008 eNom, Inc.

API commands: GetPOP3

GetPOP3
Description
Definition
Gets all POP3 accounts for a domain name.

Usage
Use this command to generate a list of the POP mail accounts belonging to a domain name. Return information includes mailbox names and BundleID numbers for the domains POP paks.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the domain control panel, email settings box, if the current service is POP mail, clicking the configure button calls the GetPOP3 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. The domain must use eNoms domain name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) If this is set to 1, extra blank input records are returned for user input on the POP3 form. Primarily used in XML output. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 1 4

GetDefaultOnly Optional ResponseType Optional

12/1/08

302

1999-2008 eNom, Inc.

API commands: GetPOP3

Returned parameters and values

Param name
RegistrarHold EmailCount UsernameX PasswordX QuotaX ExpDateX BundleIDX AutoRenewX

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Number of email accounts on the domain name. POP user name for this email account (this mailbox). Indexed X = 1 to EmailCount if ResponseType=text or HTML. POP password name for the email account. Indexed X = 1 to EmailCount if ResponseType=text or HTML. Maximum storage capacity for each mailbox, in megabytes. Indexed X = 1 to EmailCount if ResponseType=text or HTML. Expiration date of the POP3 account. Indexed X = 1 to EmailCount if ResponseType=text or HTML. ID number of this POP pak. Indexed X = 1 to EmailCount if ResponseType=text or HTML. Auto-renewal setting for this POP3 account and its POP pak. 1 signifies that auto-renew is on, 0 off. Indexed X = 1 to EmailCount if ResponseType=text or HTML. Number of MB of storage space currently in use for this account. Indexed X = 1 to EmailCount if ResponseType=text or HTML. ID number of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Total number of POP accounts that have been purchased for this domain name. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Total number of POP accounts currently configured for this domain name. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Expiration date of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Auto-renewal setting for this POP pak. 1 signifies that auto-renew is on, 0 off. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Maximum storage capacity for each mailbox, in megabytes. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

QuotaUsedX [Pak]BundleIDX [Pak]QtyPurchasedX

[Pak]QtyAvailableX [Pak]ExpDateX [Pak]AutoRenewX [Pak]QuotaX Command ErrCount Err(x) Done

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.

12/1/08

303

1999-2008 eNom, Inc.

API commands: GetPOP3

Example
The following query requests a list of all POP mail accounts in resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getpop3& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response lists the five POP mail accounts that belong to resellerdocs.com. Four are part of bundle 5105 and one is from bundle 5134:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <pop> <username>jane</username> <password>janepw</password> <quota>1024</quota> <expdate>7/26/2003 3:48:15 PM</expdate> <AutoRenew>1</AutoRenew> <BundleId>5105</BundleId> </pop> <pop> <username>john</username> <password>johnpw</password> <quota>1024</quota> <expdate>7/26/2003 3:48:15 PM</expdate> <AutoRenew>1</AutoRenew> <BundleId>5105</BundleId> </pop> <pop> <username>john.doe</username> <password>johndoe</password> <quota>1024</quota> <expdate>7/26/2003 3:48:15 PM</expdate> <AutoRenew>1</AutoRenew> <BundleId>5105</BundleId> </pop> <pop> <username>test8</username> <password>test8</password> <quota>1024</quota> <expdate>7/26/2003 3:48:15 PM</expdate> <AutoRenew>1</AutoRenew> <BundleId>5105</BundleId> </pop> <pop> <username>james</username> <password>resellpw</password> <quota>1024</quota> <expdate>8/15/2003 11:01:30 AM</expdate> <AutoRenew>1</AutoRenew> <BundleId>5134</BundleId> </pop> <EmailCount>5</EmailCount> <Paks> <Pak> <BundleId>5105</BundleId> <QtyPurchased>10</QtyPurchased> <QtyAvailable>6</QtyAvailable> <ExpDate>7/26/2003 3:48:15 PM</ExpDate> <AutoRenew>1</AutoRenew> </Pak>

12/1/08

304

1999-2008 eNom, Inc.

API commands: GetPOP3

<Pak> <BundleId>5134</BundleId> <QtyPurchased>10</QtyPurchased> <QtyAvailable>9</QtyAvailable> <ExpDate>8/15/2003 11:01:30 AM</ExpDate> <AutoRenew>1</AutoRenew> </Pak> <Count>2</Count> </Paks> <Command>GETPOP3</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetForwarding GetMailHosts GetPOPExpirations GetPOPForwarding ModifyPOP3 PurchasePOPBundle RenewPOPBundle SetPakRenew SetPOPForwarding SetUpPOP3User

12/1/08

305

1999-2008 eNom, Inc.

API commands: GetPOPExpirations

GetPOPExpirations
Description
Definition
Retrieve a list of POP paks and their expiration dates, and the domains they are associated with.

Usage
Use this command to retrieve a list of POP paks and their expiration dates, and the domains they are associated with. This command allows you to synchronize your database with ours. In particular, you can use it to identify POP paks that are about to expire or have recently expired, update the expiration dates of POP paks that were renewed in a site other than yours, or retrieve the expiration date of POP paks associated with domains that were transferred or pushed into your 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.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the email settings section, the configure button returns expiration dates for POP mail paksone component of the information retrieved by the GetPOPExpirations 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

12/1/08

306

1999-2008 eNom, Inc.

API commands: GetPOPExpirations

Returned parameters and values

Param name Definition
DomainX BundleIDX Domain name with which this POP pak is associated. The response is indexed X if ResponseType=text or HTML. ID number of this POP pak, from our internal records. Use this ID number to renew the POP pak using the RenewPOPBundle command. The response is indexed X if ResponseType=text or HTML. Expiration date of this POP pak. The response is indexed X if ResponseType=text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

ExpDateX Command ErrCount Err(x) Done

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
The following query retrieves POP pak expiration dates, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetPOPExpirations& uid=resellid&pw=resellpw&responsetype=xml

In the response, the list of POP paks and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <popexpirations> <pop> <domain>resellerdocs.com</domain> <bundleid>5105</bundleid> <expdate>7/26/2003 3:48:15 PM</expdate> </pop> <pop> <domain>resellerdocs.com</domain> <bundleid>5134</bundleid> <expdate>8/15/2003 11:01:30 AM</expdate> </pop> <pop> <domain>resellerdocs.com</domain> <bundleid>5735</bundleid> <expdate>5/14/2004 4:20:40 PM</expdate> </pop> <count>3</count> </popexpirations> <Command>GETPOPEXPIRATIONS</Command> <Language>en</Language> <ErrCount>0</ErrCount>

12/1/08

307

1999-2008 eNom, Inc.

API commands: GetPOPExpirations

<ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>8.984375E-02</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
Extend GetPOP3 GetRenew Purchase PurchasePOPBundle RenewPOPBundle

12/1/08

308

1999-2008 eNom, Inc.

API commands: GetPOPForwarding

GetPOPForwarding
Description
Definition
Retrieve the email forwarding recordeither POP or our email forwardingfor a specified mailbox name.

Usage
Use this command to retrieve the email forwarding record for a specified mailbox user name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the Email Settings section, the configure button retrieves forwarding records in a manner similar to the GetPOPForwarding 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. The user name must be an existing email address for this domain name.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD UserName ResponseType Required Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Mailbox name (for example, john in [email protected]) 50

12/1/08

309

1999-2008 eNom, Inc.

API commands: GetPOPForwarding

Returned parameters and values

Param name
DomainName DomainNameID UserName ForwardTo Active Command ErrCount Err(x) Done

Definition
Domain SLD and TLD Numeric domain name ID, from our database Mailbox name Email forwarding address Is this forwarding address active? 1 indicates yes. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the email forwarding record for [email protected] and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETPOPFORWARDING& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&username=Jane.Doe& ResponseType=xml

In the response, the presence of the popforwarding node and the absence of an ErrString parameter confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <popforwarding> <domainname>resellerdocs.com</domainname> <domainnameid>152533676</domainnameid> <username>Y</username> <forwardto>[email protected]</forwardto> <active>1</active> </popforwarding> <Command>GETPOPFORWARDING</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD>

12/1/08

310

1999-2008 eNom, Inc.

API commands: GetPOPForwarding

<TimeDifference>+03.00</TimeDifference> <ExecTime>0.1132813</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
DeletePOP3 GetCatchAll GetPOP3 PurchasePOPBundle SetPOPForwarding SetUpPOP3User

12/1/08

311

1999-2008 eNom, Inc.

API commands: GetRegHosts

GetRegHosts
Description
Definition
Get hosts (DNS information) for a domain without mail host records.

Usage
Use this command to display DNS information for a domain. The response does not include mail host entries. GetHosts, a similar command, returns all host records including mail host records.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?domainnameid=152533676

In the domain control panel, DNS settings box, the configure button calls the GetRegHosts 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. The domain must use eNoms domain name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ExtFormat ResponseType Required Required Required Required Optional Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) ExtFormat=1 encloses the repeating host information in a separate tag so it is easier to parse. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 1 4

12/1/08

312

1999-2008 eNom, Inc.

API commands: GetRegHosts

Returned parameters and values

Param name Definition
RegistrarHold HostIDX HostNameX AddressX RecordTypeX Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Identification number of this individual host record Name of this individual host record Address of this individual host record Record type of this individual host record Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the DNS host records for a domain name, specifies ExtFormat=1 to enclose the host records in a separate tag, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getreghosts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ExtFormat=1& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <hostrecords> <host> <hostID /> <HostName>www</HostName> <Address /> <RecordType>CNAME</RecordType> </host> <host> <hostID>16139887</hostID> <HostName>@ (none)</HostName> <Address>66.150.5.189</Address> <RecordType>A</RecordType> </host> <host> <hostID>16139888</hostID> <HostName>photos</HostName> <Address>photos.msn.com.</Address> <RecordType>CNAME</RecordType> </host> .

12/1/08

313

1999-2008 eNom, Inc.

API commands: GetRegHosts

. . <host> <hostID /> <HostName>* (other)</HostName> <Address /> <RecordType>CNAME</RecordType> </host> </hostrecords> <ParkingEnabled>False</ParkingEnabled> <ServiceSelect>1114</ServiceSelect> <Command>GETREGHOSTS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.406</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
GetHosts GetMetaTag SetDNSHost SetHosts UpdateMetaTag

12/1/08

314

1999-2008 eNom, Inc.

API commands: GetRegistrationStatus

GetRegistrationStatus
Description
Definition
Get the registration and paid status of a domain name.

Usage
Use this command to get the registration status and paid status of domains in your 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.
http://resellertest.enom.com/domains/DomainManager.asp?tab=iown

This command is not implemented on enom.com; however, the registered tab of the my domains page returns similar information.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

315

1999-2008 eNom, Inc.

API commands: GetRegistrationStatus

Returned parameters and values

Param name
RegistrarHold RegistrationStatus PurchaseStatus Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Registration Status of the Domain name. Options are Processing, Registered, Hosted, Null. Purchase status of the Domain name. Options are Processing, Paid, Null. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves information on whether the domain name resellerdocs.com is registered and paid for, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getregistrationstatus& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <RegistrationStatus>Registered</RegistrationStatus> <Command>GETREGISTRATIONSTATUS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

316

1999-2008 eNom, Inc.

API commands: GetRegistrationStatus

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

317

1999-2008 eNom, Inc.

API commands: GetRegLock

GetRegLock
Description
Definition
Get the registrar lock setting for a domain name.

Usage
Use this command to determine whether one of your domain names is locked, that is, whether it is protected from being transferred to another registrar.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the domain control panel, utilities box, clicking the Set reg-lock/auto-renew options link calls the GetRegLock 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

318

1999-2008 eNom, Inc.

API commands: GetRegLock

Returned parameters and values

Param name Definition
RegistrarHold RegLock RRPCode RRPText Command ErrCount Err(x) IsLockable Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Returns 1 if locked, 0 otherwise if the responsetype is Text. Response code from Registry. Response text from Registry. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. Indicates whether this TLD can use the Registrar Lock feature. Return values are True or False. 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
The following query requests the lock status of a domain name, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getreglock& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

In the response, the reg-lock value of 1 indicates that the domain name is locked:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <reg-lock>1</reg-lock> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>GETREGLOCK</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

319

1999-2008 eNom, Inc.

API commands: GetRegLock

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

320

1999-2008 eNom, Inc.

API commands: GetRenew

GetRenew
Description
Definition
Get the auto-renew setting for a domain name.

Usage
Use this command to determine whether a domain in your account is set to renew automatically. If so, the renewal is charged to your account a month before the expiration date for the domain name. Fifteen days before that, you receive an email notifying you of the auto-renew charges.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the domain control panel, utilities box, the Set reg-lock/auto-renew options link calls the GetRenew 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

321

1999-2008 eNom, Inc.

API commands: GetRenew

Returned parameters and values

Param name
RegistrarHold RenewName PakExist AutoPakRenew EMailFwdExists EMailForwardRenew URLFwdExists URLForwardRenew Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Returns 1 if this domain is set to auto-renew, 0 otherwise. Returns 1 if there are POP paks associated with this domain, 0 otherwise. Returns 1 if the POP paks for this domain are set to auto-renew, 0 otherwise. Returns 1 if this domain subscribes to email forwarding, 0 otherwise. Returns 1 if the email forwarding for this domain is set to auto-renew, 0 otherwise. Returns 1 if this domain subscribes to URL forwarding, 0 otherwise. Returns 1 if the URL forwarding for this domain is set to auto-renew, 0 otherwise. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the auto-renew status of resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getrenew& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

In the response, the auto-renew value of 1 indicates that the domain is set to automatically renew:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <auto-renew>1</auto-renew> <Command>GETRENEW</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

322

1999-2008 eNom, Inc.

API commands: GetRenew

Related commands
Extend GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetPasswordBit GetPOPExpirations GetRegLock GetSubAccountPassword InsertNewOrder RenewPOPBundle SetPakRenew SetPassword SetRegLock SetRenew StatusDomain UpdateExpiredDomains ValidatePassword

12/1/08

323

1999-2008 eNom, Inc.

API commands: GetReport

GetReport
Description
Definition
Get a report on a users account.

Usage
Use this command to retrieve an overview of the domains in an account: domain names, name server status, registration status, and expiration date.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enomson/domains/DomainManager.asp?tab=iown

The GetReport command works in the background of the my domains page. Each of the four tabs on the page displays one category of domain names returned by the GetReport query.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
FName LName

Definition
First (use) name of the account registrant. Last (family) name of the account registrant.

12/1/08

324

1999-2008 eNom, Inc.

API commands: GetReport

Param name
Party DN DomName NSStatus RegistrationStatus

Definition
Party identification number. Format is 32 hexadecimal digits, hyphenated. Domain name parameter. Domain name attribute. Name server status. Value yes indicates our name servers. Value no indicates not our name servers. Registration status in this account. Return values are: Deleted Domain has been deleted from registrars database. Expired Domain registration has expired but has not been deleted from registrars database (domain is within grace period for reactivaton). Expired Transfers Domain that is being transferred to another registrar in expired state. Hosted Domain that is hosted by us but registered with another registrar. Hosted Deleted Domain that was hosted by us but registered elsewhere, its registration has expired, and it has been deleted from our database. Hosted Expired Domain that is hosted by us but registered elsewhere, its registration has expired, but it is still present in our database. Hosted Transfers Domain that is hosted by us but registered elsewhere, and the registration is transferring to another registrar. Keyword Keyword, an obsolete feature. Registered Domain that is registered by us. Transferred away Hosted and Registered Domain that was registered and hosted by us, and both the registration and hosting services are transferring away from us. Date on which this domain registration expires. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

ExpirationDate Command ErrCount Err(x) Done

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
The following query requests a report on account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getreport& uid=resellid&pw=resellpw&responsetype=xml

In the response, the ReportDetail section lists the domains in account resellid:
<?xml version="1.0" ?> <interface-response> <GetReport> <FName>John</FName> <LName>Doe</LName> <Party>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</Party> <ReportDetail> <dn DomName="resellerdocs.com" nsstatus="No" registrationstatus="Hosted"

12/1/08

325

1999-2008 eNom, Inc.

API commands: GetReport

ExpirationDate="07/15/03" /> <dn DomName="resellerdocs2.net" nsstatus="Yes" registrationstatus="Registered" ExpirationDate="06/25/04" /> <dn DomName="resellerdocs3.info" nsstatus="Yes" registrationstatus="Registered" ExpirationDate="06/25/04" /> </ReportDetail> </GetReport> <Command>GETREPORT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAllAccountInfo GetAccountPassword GetAllAccountInfo GetHomeDomainList GetOrderDetail GetOrderList GetSubAccountDetails GetSubAccounts GetTransHistory RPT_GetReport UpdateAccountInfo UpdateCusPreferences

12/1/08

326

1999-2008 eNom, Inc.

API commands: GetResellerInfo

GetResellerInfo
Description
Definition
Retrieve the contact information for the account holder.

Usage
Use this command to retrieve contact information for a reseller 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.
http://resellertest.enom.com/myaccount/EditContact.asp

On the my info page, the Organization (or Individual) Information box displays the results of the GetResellerInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

327

1999-2008 eNom, Inc.

API commands: GetResellerInfo

Returned parameters and values

Param name
OrganizationName FName LName Address1 Address2 City StateProvince StateProvinceChoice PostalCode Country Phone Fax EMailAddress PhoneExt Command ErrCount Err(x) Done

Definition
Reseller organization name Reseller first name Reseller last name Address first line Address second line City Name of state or province S indicates StateProvince is a state; P, a province Postal code Two-letter country code Phone number Fax number Email address Phone extension Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves reseller contact information for the specified account and domain, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetResellerInfo& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <ResellerInfo> <OrganizationName>Reseller Documents Inc.</OrganizationName> <FName>John</FName> <LName>Doe</LName> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <StateProvinceChoice>S</StateProvinceChoice> <PostalCode>99999</PostalCode>

12/1/08

328

1999-2008 eNom, Inc.

API commands: GetResellerInfo

<Country>US</Country> <Phone>5555555555</Phone> <Fax>5555555556</Fax> <EmailAddress>[email protected]</EmailAddress> <PhoneExt /> </ResellerInfo> <Command>GETRESELLERINFO</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AddContact GetAccountInfo GetAddressBook GetAllAccountInfo GetContacts GetWhoisContact

12/1/08

329

1999-2008 eNom, Inc.

API commands: GetSPFHosts

GetSPFHosts
Description
Definition
Retrieve Sender Policy Framework (SPF) host records for a domain.

Usage
Use this command to retrieve SPF host records for a domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the DNS settings (zone file) section, the test record shows the SPF host record.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

330

1999-2008 eNom, Inc.

API commands: GetSPFHosts

Returned parameters and values

Param name Definition
Name Type A-Radio MX-Radio PTR-Radio ALL-Radio A-Records MX-Records IP-Records INC-Records HostID Command ErrCount Err(x) Done Name of this SPF record Type of this SPF record Setting for A-radio Setting for MX-radio Setting for PTR-radio Setting for ALL-radio Value for A records Value for MX records Value for IP records Value for INC record Host ID number Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the SPF hosts for a domain and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=getspfHosts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

In the response, host values confirm that the query was successful and that SPF records have been configured for this domain:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <host> <name>test</name> <type>TXT</type> <a-radio>off</a-radio> <mx-radio>on</mx-radio> <ptr-radio>on</ptr-radio> <all-radio>on</all-radio> <a-records>regular hostnames po</a-records> <mx-records>mx servers to</mx-records> <ip-records>127.0.0.1</ip-records> <inc-records>myisp.net mydomain.com</inc-records> <hostid>15195981</hostid>

12/1/08

331

1999-2008 eNom, Inc.

API commands: GetSPFHosts

</host> <Command>GETSPFHOSTS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.171875</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetHosts SetHosts SetSPFHosts

12/1/08

332

1999-2008 eNom, Inc.

API commands: GetServiceContact

GetServiceContact
Description
Definition
Retrieve the customer service contact information for a domain name account.

Usage
Use this command to retrieve customer service contact information for an account. If there is a PDQ subscription associated with this account, this command can return the PDQ contact information. Otherwise, this command returns the Billing contact information.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. http://resellertest.enom.com/pdq/RE_Default.asp?maintab=overview Clicking the my site tab calls the GetServiceContact 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Service Required Required Optional

Definition
Account login ID Account password Use Service=PDQ to return the contact information for this accounts PDQ subscription. If the Service parameter is omitted, the Billing contact information is returned. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 20

ResponseType

Optional

12/1/08

333

1999-2008 eNom, Inc.

API commands: GetServiceContact

Returned parameters and values

Param name Definition
Organization Address1 Address2 City StateProvince PostalCode Country Phone Fax EmailAddress URL ResellerKey Command ErrCount Err(x) Done Name of contacts organization Contact address, line 1 Contact address, line 2 Contacts city Contacts state or province Contacts postal code Contacts country Contacts phone number Contacts fax number Contacts email address URL of PDQ site, if any Reseller key of PDQ site, if any Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the customer service contact information for resellid and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GETSERVICECONTACT& uid=resellid&pw=resellpw&responsetype=xml

In the response, the presence of contact information, and the ErrCount value 0, indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <ServiceContact> <Organization>Reseller Documents Inc.</Organization> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>+1.5555555555</Phone> <Fax>+1.5555555556</Fax> <EmailAddress>[email protected]</EmailAddress>

12/1/08

334

1999-2008 eNom, Inc.

API commands: GetServiceContact

<URL /> <ResellerKey /> </ServiceContact> <Command>GETSERVICECONTACT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>8.203125E-02</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AddContact Contacts GetAddressBook GetContacts GetWhoisContact

12/1/08

335

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

GetSubAccountDetails
Description
Definition
Get the wholesale prices and enabled settings for one subaccount.

Usage
Use this command to list prices for one subaccount. This command can be used to change TLD prices for one subaccount, but we recommend using the SetResellerTLDPricing command instead. SetResellerTLDPricing has fewer requirements than GetSubaccountDetails, and as a result is easier to use.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-List.asp

On the sub-account page, clicking a link in the LoginID column calls the GetSubAccountDetails command without the Action=Manage parameter.
http://resellertest.enom.com/resellers/SubAccount-Manage.asp?Account=154-dz-5567

On the Sub-account configuration page, clicking the save changes button calls the GetSubAccountDetails command with the Action=Manage parameter.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The account must be a reseller account. The subaccount must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Account

Obligation
Required Required Required

Definition
Account login ID Account password Subaccount ID number, in NNN-aa-NNNN format. You can retrieve this number using the GetSubAccounts command.

Max size
20 20 20

12/1/08

336

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

Param name
Action

Obligation
Optional; default value is List

Definition
Action to take. Permitted values are List, Info, and Manage. Action=List returns a long list of current price settings. Action=Info returns a short list of information about the subaccount and parent account. Action=Manage updates product prices when this query executes. If the query does not include the Action parameter, the product prices do not change. Year-bracket to retrieve prices for. For example, UseQtyEngine=2 retrieves the annual price for domain name registrations of 2 to 4 years; UseQtyEngine=5 retrieves the annual price for 5 to 9 years. Permitted values are 1, 2, 5, and 10. You can use only one UseQtyEngine parameter per query. Use this parameter with Action=List and Action=Manage. Account type. Permitted values are Reseller or Retail. Price for registering a .com domain. Permitted format is DD.cc

Max size
20

UseQtyEngine

Optional

AcctType TLDPrice

Required if Action=Manage Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails. Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails. Required for every TLD we offer if Action=Manage. If any TLDs are missing, the query fails. Required if Action=Manage Required if Action=Manage Required if Action=Manage Required if Action=Manage

20 20

TLDRenew

Price for renewing a TLD domain. Permitted format is DD.cc

20

TLDTransfer

Price for transferring a TLD domain. Permitted format is DD.cc

20

POP3 WPPS WBL DotNameBundle

Price for a POP Email pak. Permitted format is DD.cc Price for ID Protect. Permitted format is DD.cc Price for Business Listing. Permitted format is DD.cc

20 20 20

Price for a dot-name bundle (the domain 20 name with email provided by the dotname Registry). Permitted format is DD.cc Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

12/1/08

337

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

Returned parameters and values

Param name
Action SubAccount PartyID LoginID DomainCount Account TLD RegisterPrice RegisterEnabled RenewPrice RenewEnabled TransferPrice TransferEnabled POP3 DotNameBundle DNSHosting WPPS Certificate-GeoTrust-QuickSSL-Premium Certificate-GeoTrust-TrueBizID Certificate-RapidSSL-RapidSSL Certificate-GeoTrust-TrueBizID-EV Certificate-GeoTrust-QuickSSL Certificate-GeoTrust-TrueBizID-Wildcard Certificate-SBS-Secure Certificate-SBS-Secure-Plus Certificate-SBS-Instant Certificate-SBS-EV Certificate-SBS-SGC-EV

Definition
If <Action>MANAGE</Action> is in the response, prices have been changed to those listed. Subaccount ID number, in NNN-aa-NNNN format. Party identification number expressed as 32 hexadecimal characters, hyphenated. Account ID of the subaccount. Number of domains in this subaccount. Subaccount ID number, in NNN-aa-NNNN format. Top-level domain; for example, com for .com domains. Price for registering a domain of this type for one year. True/FalseTrue indicates that this subaccount allows customers to register domain names. Price for renewing a domain of this type for one year. True/False -- True indicates that this subaccount allows customers to renew domain names. Price for transferring a domain of this type, and paying for one year of registration. True/False -- True indicates that this subaccount allows customers to transfer domain names. Price for one 10-mailbox POP pak, per year, in $US Price for a one-year registration of a .name domain, with the .name Registrys email forwarding Price for one year of DNS hosting Price for one year of ID Protect Price for one year registration of a GeoTrust QuickSSL Premium SSL certificate Price for one year registration of a GeoTrust True BusinessID SSL certificate Price for one year registration of a RapidSSL certificate Price for one year registration of a GeoTrust True BusinessID EV certificate Price for one year registration of a GeoTrust QuickSSL certificate Price for one year registration of a GeoTrust True BusinessID Wildcard SSL certificate Price for one year registration of a Secure Business Services Secure SSL certificate Price for one year registration of a Secure Business Services Secure Plus SSL certificate Price for one year registration of a Secure Business Services Instant SSL certificate Price for one year registration of a Secure Business Services Extended Validation certificate Price for one year registration of a Secure Business Services Server Gated Crypto Extended Validation certificate

12/1/08

338

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

Param name
LWSC-Basic LWSC-Full LWSC-Ecommerce Hosted-Exchange-Mailbox Hosted-Exchange-Extra-Storage

Definition
Price for one month of Web Site Creator Basic Price for one month of Web Site Creator Full Price for one month of Web Site Creator eCommerce Price for one Hosted Microsoft Exchange mailbox, per month Price for 100MB of extra storage pooled among all mailboxes in this Hosted Microsoft Exchange account, per month Price for delivery to one BlackBerry device, per month One-time charge for setting up BlackBerry service for one device Price for delivery to one Good Mobile Messaging device, per month One-time charge for setting up Good Mobile Messaging service for one device Price for delivery to one ActiveSync device, per month Price to renew one year of DNS hosting Price to redeem one domain name that is in Redemption Grace Period (RGP) status. Once redeemed, you must also pay the registration renewal fee for this name. Price to redeem one domain name that is in Extended RGP status. Once redeemed, you must also pay the registration renewal fee for this name. Price for one unit of extra POP storage, for one year Price to renew one year of extra POP storage, for one year Price to renew POP service for one year, for one 10mailbox POP pak Price for one year of email forwarding by the .name Registry, for one domain name Price to renew one year of registration and email forwarding by the .name Registry Price to renew our email forwarding service, for one year and one domain name Price to renew our URL forwarding service, for one year and one domain name Price for one year subscription to our PDQ instant domain-selling site Price to renew PDQ for one year Price to renew ID Protect for one year, for one domain Price for Business Listing for one year, for one domain Product ID number Product name Enabled status of this product Price of this product. Both Email Forwarding and URL Forwarding are yearly subscriptions. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

Hosted-Exchange-BlackBerry Hosted-Exchange-BlackBerry-Setup-Fee Hosted-Exchange-GoodLink Hosted-Exchange-GoodLink-Setup-Fee Hosted-Exchange-ActiveSync DNSHostingRenew RGP

ExtendedRGP

POPStorage POPStorageRenew POPRenew DotNameEmail DotNameRegMailRenew EmailForwardingRenew URLForwardingRenew PDQ PDQRenewal WPPSRenew WBL ProductType Product ProductEnabled Price Command ErrCount

12/1/08

339

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests for a subaccount of resellid, subaccount 154-dz-5567. The query specifies prices for all domain name products and, by using the Action=Manage parameter, specifies that the prices for the subaccount should be updated. Finally, the query requests the response in XML format:
http://resellertest.enom.com/interface.asp?Command=GETSUBACCOUNTDETAILS& uid=resellid&pw=resellpw&Account=154-dz-5567&action=manage&AcctType=retail& comprice=19&comrenew=20&comtransfer=21&netprice=19&netrenew=20&nettransfer=21& orgprice=19&orgrenew=20&orgtransfer=21&infoprice=19&inforenew=20&infotransfer=21& ccprice=69&ccrenew=69&cctransfer=69&bizprice=19&bizrenew=20&biztransfer=21& tvprice=69&tvrenew=69&tvtransfer=69&wsprice=19&wsrenew=20&wstransfer=21& usprice=19&usrenew=20&ustransfer=21&bzprice=69&bzrenew=69&bztransfer=69& nuprice=69&nurenew=69&nutransfer=69&responsetype=xml

The response lists the prices given in the query for each of the domain name products, and then lists identification information and the updated prices for subaccount 154-dz-5567:
<?xml version="1.0" ?> <interface-response> <SubAccountsManage> <Action>MANAGE</Action> <Set> <SubAccount>154-dz-5567</SubAccount> <AcctType>retail</AcctType> <Prices> <price tld="com" id="0" prod="10">19</price> <price tld="com" id="0" prod="16">20</price> <price tld="com" id="0" prod="19">21</price> <price tld="net" id="1" prod="10">19</price> <price tld="net" id="1" prod="16">20</price> <price tld="net" id="1" prod="19">21</price> <price tld="org" id="2" prod="10">19</price> <price tld="org" id="2" prod="16">20</price> <price tld="org" id="2" prod="19">21</price> . . . </Prices> <data-errors /> </Set> <Get> <PartyID>{8D504DD5-C773-41C4-83F6-4495CA479103}</PartyID> <LoginID>olerud</LoginID> <DomainCount>3</DomainCount>

12/1/08

340

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

<Account>154-dz-5567</Account> <Reseller>0</Reseller> <pricestructure> <product> <tld>com</tld> <registerprice>19</registerprice> <registerenabled>True</registerenabled> <renewprice>20</renewprice> <renewenabled>True</renewenabled> <transferprice>21</transferprice> <transferenabled>True</transferenabled> </product> <product> <tld>net</tld> <registerprice>19</registerprice> <registerenabled>True</registerenabled> <renewprice>20</renewprice> <renewenabled>True</renewenabled> <transferprice>21</transferprice> <transferenabled>True</transferenabled> </product> <product> <tld>org</tld> <registerprice>19</registerprice> <registerenabled>True</registerenabled> <renewprice>20</renewprice> <renewenabled>True</renewenabled> <transferprice>21</transferprice> <transferenabled>True</transferenabled> </product> . . . </pricestructure> </Get> </SubAccountsManage> <Command>GETSUBACCOUNTDETAILS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

341

1999-2008 eNom, Inc.

API commands: GetSubAccountDetails

Related commands
CheckLogin CreateAccount CreateSubAccount DeleteSubaccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccounts GetSubaccountsDetailList GetTransHistory GetWebHostingAll SetResellerServicesPricing SetResellerTLDPricing SubAccountDomains UpdateAccountInfo UpdateCusPreferences

12/1/08

342

1999-2008 eNom, Inc.

API commands: GetSubAccountPassword

GetSubAccountPassword
Description
Definition
Get the password for a domain name.

Usage
Use this command to retrieve the password for a domain name that belongs to your account. The password is emailed to the Registrant contact address.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/help/

On the help page, the Password recovery link calls the GetSubAccountPassword 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

343

1999-2008 eNom, Inc.

API commands: GetSubAccountPassword

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the password for domain resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetSubAccountPassword& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The 0 value for ErrCount indicates that the request has been processed successfully. The password is e-mailed to the registrant almost instantly.
<?xml version="1.0" ?> <interface-response> <Command>GETSUBACCOUNTPASSWORD</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

344

1999-2008 eNom, Inc.

API commands: GetSubAccountPassword

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew SetPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

345

1999-2008 eNom, Inc.

API commands: GetSubAccounts

GetSubAccounts
Description
Definition
List subaccounts.

Usage
Use this command to list subaccounts for 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.
http://resellertest.enom.com/resellers/SubAccount.asp

On the subaccount page,clicking the List/Manage link calls the GetSubAccounts 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ListBy StartLetter StartPosition Required Required Optional Optional Optional Account login ID Account password Sorting parameter. Options are LName, EMailAddress, LoginID. First letter of the ListBy value First return value in the list generated with the ListBy and StartLetter parameters. Maximum number of subaccounts returned per query is 25. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 12 1 7

ResponseType

Optional

12/1/08

346

1999-2008 eNom, Inc.

API commands: GetSubAccounts

Returned parameters and values

Param name Definition
PartyID LoginID DomainCount Account Reseller Count Command ErrCount Err(x) Done Party identification number expressed as 32 hexadecimal characters, hyphenated Login ID of the subaccount Number of domains in this subaccount Subaccount ID number in NNN-aa-NNNN format. Reseller=0 indicates that this subaccount is a retail account; Reseller=1 indicates this subaccount is a reseller account Number of subaccounts in this account that fit the ListBy and StartLetter criteria Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a list of subaccounts for account resellid. It specifies that the return values should be listed by last name, starting with the letter D, and starting with the seventh subaccount in that list. Finally, the string requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getsubaccounts& uid=resellid&pw=resellpw&ListBy=LName&StartLetter=D&StartPosition=7& responsetype=xml

The response indicates that account resellid has 12 subaccounts that fit the parameters, and returns the seventh through twelfth subaccounts in that list:
<?xml version="1.0" ?> <interface-response> <SubAccounts> <SubAccount> <PartyID>{AFCFAEC0-2FB6-4512-B043-EE6653618E1F}</PartyID> <LoginID>resellsub</LoginID> <DomainCount>0</DomainCount> <Account>030-hi-7080</Account> <Reseller>0</Reseller> <FName>john</FName> <LName>doe</LName> <EmailAddress>[email protected]</EmailAddress> </SubAccount> . . . <SubAccount> <PartyID>{C5D65CB8-1522-422A-9B78-D004AF13ADF0}</PartyID>

12/1/08

347

1999-2008 eNom, Inc.

API commands: GetSubAccounts

<LoginID>testok</LoginID> <DomainCount>0</DomainCount> <Account>850-tn-1053</Account> <Reseller>0</Reseller> </SubAccount> <Count>1</Count> </SubAccounts> <Command>GETSUBACCOUNTS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount DeleteContact DeleteSubaccount GetAccountInfo GetAccountPassword GetAccountValidation GetAllAccountInfo GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubaccountsDetailList GetTransHistory GetWebHostingAll SendAccountEmail SetResellerServicesPricing SetResellerTLDPricing SubAccountDomains UpdateAccountInfo UpdateCusPreferences

12/1/08

348

1999-2008 eNom, Inc.

API commands: GetSubaccountsDetailList

GetSubaccountsDetailList
Description
Definition
Retrieve a list of subaccounts, and contact information for their owners.

Usage
Use this command to retrieve contact information for your subaccounts.

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.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
LoginID FName LName EMailAddress OrganizationName URL JobTitle Address1

Definition
Subaccount ID First name of the subaccount owner Last name of the subaccount owner Email address of the subaccount owner Organization of the subaccount owner URL of the subaccount owners business Job title of the subaccount owner Street address of the subaccount owners address, first line

12/1/08

349

1999-2008 eNom, Inc.

API commands: GetSubaccountsDetailList

Param name
Address2 City StateProvince PostalCode Country Phone Fax PhoneExt Reseller Password Command ErrCount Err(x) Done

Definition
Street address of the subaccount owners address, second line Subaccount owners city Subaccount owners state or province Subaccount owners postal code Subaccount owners country Subaccount owners phone number Subaccount owners fax number Extension of subaccount owners phone number Reseller status. 1 indicates this is a reseller subaccount; 0 indicates retail. If this is a retail account, the account password Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a list of the subaccounts of account resellid, with owners contact information, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetSubaccountsDetailList& uid=resellid&pw=resellpw&ResponseType=xml

The response is a list of subaccounts with the owner information:

<?xml version="1.0" ?> <interface-response> <SubAccountDetailList> <SubAccount> <LoginID /> <FName>john</FName> <LName>doe</LName> <EmailAddress>[email protected]</EmailAddress> <OrganizationName>Reseller Documents Inc.</OrganizationName> <URL /> <JobTitle>Tester</JobTitle> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>9995559999</Phone> <Fax>9995559998</Fax> <PhoneExt />

12/1/08

350

1999-2008 eNom, Inc.

API commands: GetSubaccountsDetailList

</SubAccount> <SubAccount> <LoginID>olerud</LoginID> <FName>John</FName> <LName>Doe</LName> <EmailAddress>[email protected]</EmailAddress> <OrganizationName>Reseller Documents Inc.</OrganizationName> <URL /> <JobTitle>Tester</JobTitle> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>9995559999</Phone> <Fax>9995559998</Fax> <PhoneExt /> </SubAccount> . . . <SubAccount> <LoginID>testok</LoginID> <FName>John</FName> <LName>Doe</LName> <EmailAddress>[email protected]</EmailAddress> <OrganizationName>Reseller Documents Inc.</OrganizationName> <URL /> <JobTitle>Tester</JobTitle> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>9995559999</Phone> <Fax>9995559998</Fax> <PhoneExt /> </SubAccount> <SubAccounts>15</SubAccounts> </SubAccountDetailList> <Command>GETSUBACCOUNTSDETAILLIST</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetSubAccountDetails GetSubAccounts GetAccountValidation GetWebHostingAll SubAccountDomains

12/1/08

351

1999-2008 eNom, Inc.

API commands: GetTLDList

GetTLDList
Description
Definition
Retrieve a list of the TLDs that you offer.

Usage
Use this command to retrieve a list of the TLDs that you offer. If you have not specifically authorized TLDs then this command returns all TLDs offered by us. Use the AuthorizeTLD command to authorize TLDs and the RemoveTLD command to remove TLDs from authorized status for your 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.
http://resellertest.enom.com/myaccount/Settings.asp

Clicking the TLD pricing tab shows a table that includes all TLDs offered by this account (although the contents of this particular table are retrieved by a different command than GetTLDList).

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

12/1/08

352

1999-2008 eNom, Inc.

API commands: GetTLDList

Returned parameters and values

Param name Definition
TLDX TLDCount Command ErrCount Err(x) Done Top-level domain name (extension). If ResponseType=text or html, each entry is indexed X. Number of TLDs listed in this response (that is, the number of TLDs authorized by this account) Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of TLDs authorized for this account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=gettldlist& uid=resellid&pw=resellpw&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <tldlist> <tld> <tld>com</tld> </tld> <tld> <tld>net</tld> </tld> <tld> <tld>org</tld> </tld> <tld> <tld>us</tld> </tld> <tld> <tld>info</tld> </tld> <tld> <tld>biz</tld> </tld> <tld> <tld>co.uk</tld> </tld> <tld> <tld>org.uk</tld>

12/1/08

353

1999-2008 eNom, Inc.

API commands: GetTLDList

</tld> <tld> <tld>de</tld> </tld> <tldcount>9</tldcount> </tldlist> <Command>GETTLDLIST</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site /> <IsLockable /> <IsRealTimeTLD /> <ExecTime>0.140625</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AuthorizeTLD PE_SetPricing RemoveTLD SetResellerTLDPricing

12/1/08

354

1999-2008 eNom, Inc.

API commands: GetTransHistory

GetTransHistory
Description
Definition
Return a list of up to 25 transactions in an account.

Usage
Use this command to retrieve an overview of transactions.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/

When the my enom submenu is open on the left side of the Web page, clicking the transactions link calls the GetTransHistory 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW StartPosition Required Required Optional; default is 1

Definition
Account login ID Account password

Max size
20 20

Return sets of 25 records in reverse chronological 4 order. For example, StartPosition=26 returns the 26th through 50th most recent transactions. Defaults to 1.

12/1/08

355

1999-2008 eNom, Inc.

API commands: GetTransHistory

Param name Obligation

StartDate

Definition

Max size
10

Optional; if omitted, six Beginning date of transactions to return. Must be no more than six months before EndDate. months of orders are Permitted format is MM/DD/YYYY returned Optional; default is todays date Optional End date of transactions to return. Must be no more than six months after StartDate. Permitted format is MM/DD/YYYY Format of response. Options are Text (default), HTML, or XML.

EndDate

10

ResponseType

Returned parameters and values

Param name
AdjustedBeginDate AdjustedEndDate FName LName PartyID CurrentStartPosition RecordCount NewStartPosition OldStartPosition Trans-Date Amount TransDescription

Definition
Start date for this response End date for this response First (given) name Last (family) name Party identification number. Format is 32 hexadecimal characters, hyphenated, in curly braces Start position of this response, in the reverse chronological list of transactions Number of transactions in the transaction history Start position of the next response, in the reverse chronological list of transactions Start position of the previous response, in the reverse chronological list of transactions Time stamp indicates when the transaction was submitted to our accounting system Amount of the transaction, $US Word description of this transaction

12/1/08

356

1999-2008 eNom, Inc.

API commands: GetTransHistory

Param name
TransType

Definition
Identification number of this transaction type. Values are: 1 Order 2 Debit Credit Card 3 Credit Credit Card 4 Refill Reseller Account 5 Check Refill 7 Credit Reseller Balance 6 Debit Reseller Balance 8 Transfer Order 9 Reverse Refill 10 Refund and Reverse Commissions 11 Transfer from commission account 12 Commission account cashout 16 Sales Commission 17 CCTransaction Fee 20 Refund and Reverse Commissions with Charge Back 21 Charge Back 19 Club Drop 22 Reverse Commission 23 Reverse Commission with Charge Back 25 Preregistration Fee 26 Activation Fee 28 Refill Service Convenience Charge 30 PDQ Annual Fee 32 Refill Reseller Account (No Service Charge) Used in XML to build links to individual orders. Order identification number, a nine-digit number True indicates the order has been successfully processed. Balance in the account following this transaction. Commission balance following this transaction. Status of the transaction. Options are: 1 Ready for billing (Processing in UI) 2 Transaction failed (Failed in UI) 3 Transaction successful (Successful in UI) 6 Void (Voided in UI) Name of command executed Language The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. Response count Minimum registration period, for domain name purchases Maximum registration period, for domain name purchases Name of server Name of site Is this a lockable domain name? Is this a TLD that supports real-time purchase? Time difference between end user and our server Time to execute this API query True indicates this entire response has reached you successfully.

LinkValue OrderID OrderProcessFlag Balance ComBalance TransStatus

Command Language ErrCount Err(x) ResponseCount MinPeriod MaxPeriod Server Site IsLockable IsRealTimeTLD TimeDifference ExecTime Done

12/1/08

357

1999-2008 eNom, Inc.

API commands: GetTransHistory

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
The following query requests the transaction history for account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetTransHistory& uid=resellid&pw=resellpw&responsetype=xml

By default, the response gives a summary of the 25 most recent transactions:

<?xml version="1.0" ?> <interface-response> <GetTransHistory> <AdjustedBeginDate /> <AdjustedEndDate /> <FName>John</FName> <LName>Doe</LName> <PartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</PartyID> <CurrentStartPosition>1</CurrentStartPosition> <RecordCount>396</RecordCount> <NewStartPosition>26</NewStartPosition> <OldStartPosition>0</OldStartPosition> <TransHistory> <Transaction> <Trans-Date>7/18/2007 1:25:11 PM</Trans-Date> <Amount>-$4.40</Amount> <TransDescription>Order</TransDescription> <TransType>1</TransType> <LinkValue> OrderDetail.asp?OrderID=157385793&OrderProcess=Successful </LinkValue> <OrderID>157385793</OrderID> <OrderProcessFlag>True</OrderProcessFlag> <Balance>$7,028.39</Balance> <ComBalance /> <TransStatus>Successful</TransStatus> </Transaction> <Transaction> <Trans-Date>7/16/2007 2:05:01 AM</Trans-Date> <Amount>-$8.95</Amount> <TransDescription>Order</TransDescription> <TransType>1</TransType> <LinkValue> OrderDetail.asp?OrderID=157385407&OrderProcess=Successful </LinkValue> <OrderID>157385407</OrderID> <OrderProcessFlag>True</OrderProcessFlag> <Balance>$7,032.79</Balance> <ComBalance /> <TransStatus>Successful</TransStatus> </Transaction> . . .

12/1/08

358

1999-2008 eNom, Inc.

API commands: GetTransHistory

</TransHistory> </GetTransHistory> <Command>GETTRANSHISTORY</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.750</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts RefillAccount RPT_GetReport UpdateAccountInfo UpdateCusPreferences

12/1/08

359

1999-2008 eNom, Inc.

API commands: GetWebHostingAll

GetWebHostingAll
Description
Definition
Retrieve reseller keys for Registry Rocket accounts.

Usage
Use this command to retrieve reseller keys for Registry Rocket accounts. Do not use this command to retrieve prices, because the prices returned here may be obsolete. Instead, use one of the PE_Get* pricing commands.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/Settings.asp

In the Registry Rocket Settings box at the bottom of the page, the ResellerKey line posts the return value from the GetWebHostingAll 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
ResellerKey HostPrice Registry Rocket reseller key Price when this Registry Rocket account was created; likely to be obsolete. For current pricing, use one of the PE_Get* commands.

12/1/08

360

1999-2008 eNom, Inc.

API commands: GetWebHostingAll

Param name Definition

CCPrice InfoPrice Command ErrCount Err(x) Done Price when this Registry Rocket account was created; likely to be obsolete. For current pricing, use one of the PE_Get* commands. Price when this Registry Rocket account was created; likely to be obsolete. For current pricing, use one of the PE_Get* commands. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of the reseller keys for account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetWebhostingAll& uid=resellid&pw=resellpw&responsetype=xml

In the response, the results for ResellerKey and the ErrCount of 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <RocketLink> <ResellerKey>0CYF3Z5HBBVLBJSAP1RU7BAY6</ResellerKey> <HostPrice>17.95</HostPrice> <CCPrice>27.95</CCPrice> <InfoPrice>27.95</InfoPrice> <PictureURL /> <ContactEmail>[email protected]</ContactEmail> <CompanyName>Reseller Documents Inc.</CompanyName> <Referrer>http://www.resellerdocs.com</Referrer> </RocketLink> <Command>GETWEBHOSTINGALL</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response
>

12/1/08

361

1999-2008 eNom, Inc.

API commands: GetWebHostingAll

Related commands
GetSubAccountDetails GetSubAccounts GetSubaccountsDetailList PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice PE_SetPricing Purchase

12/1/08

362

1999-2008 eNom, Inc.

API commands: GetWhoisContact

GetWhoisContact
Description
Definition
Get whois contact information for a domain name.

Usage
Use this command to get contact information for any domain name registered through eNom or its resellers.

Availability
All resellers have access to this command.

Implementation on eNom.com
http://resellertest.enom.com

On the enom.com home page, the Whois link at the top of the page calls the GetWhoisContact 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name
RegistrarHold ContactType

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Type of contact data being returned

12/1/08

363

1999-2008 eNom, Inc.

API commands: GetWhoisContact

Param name
RegistrantOrganization RegistrantFName RegistrantLName RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantStateProvince RegistrantPostalCode RegistrantCountry RegistrantPhone RegistrantFax RegistrantEmailAddress Whoisregistrar Whoisupdated-by Whoisstatus Whoisupdated-date Whoiscreated-date Whoisregistration-expiration-date Whoiscreated-by WhoisnameserverCount WhoisnameserverX Command ErrCount Err(x) Done

Definition
Organization information First name Last name Address line 1 Address line 2 City State or province Postal Code Country Phone number Fax number Email address Registrar for the name Registrar that last updated the Whois info Status of the name Date of last update Creation date for the name Current expiration date Registrar that created the information for the name Number of name servers associated with this name Name servers. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. If additional contact types are returned other than Registrant they will be "ContactType" Technical, Administrative or Billing.

Example
The following query requests the whois contact information for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=getwhoiscontact& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

12/1/08

364

1999-2008 eNom, Inc.

API commands: GetWhoisContact

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <GetWhoisContacts> <domainname sld="resellerdocs" tld="com">resellerdocs.com</domainname> <contacts> <contact ContactType="Registrant"> <Organization>'Reseller Documents Inc.'</Organization> <FName>John</FName> <LName>Doe</LName> <Address1>'111 Main St.'</Address1> <Address2 /> <City>'Hometown'</City> <StateProvince /> <PostalCode /> <Country>'UNITED STATES'</Country> <Phone>'555-555-5555'</Phone> <Fax /> <EmailAddress>[email protected]</EmailAddress> </contact> <contact ContactType="Administrative"> . . . </contact> <contact ContactType="Billing"> . . . </contact> <contact ContactType="Technical"> . . . </contact> </contacts> <epp-info> . . . </epp-info> <StatusValues>True</StatusValues> </GetWhoisContacts> . . . </interface-response>

Related commands
AddContact Contacts GetAddressBook GetContacts GetExtAttributes GetResellerInfo GetServiceContact Preconfigure

12/1/08

365

1999-2008 eNom, Inc.

API commands: GetWPPSInfo

GetWPPSInfo
Description
Definition
Retrieve the ID Protect (Whois privacy protection) status and contact information for a domain name.

Usage
Use this command to retrieve ID Protect status for a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enomson/domains/DomainDetail.asp?DomainNameID=152533676

In the id protect section, the configure button calls the GetWPPSInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

366

1999-2008 eNom, Inc.

API commands: GetWPPSInfo

Returned parameters and values

Param name
DomainName SLD TLD DomainNameID WPPSAllowed WPPSExists WPPSEnabled WPPSExpDate WPPSAutoRenew WPPSPrice ContactType Organization FName LName Address1 Address2 City StateProvince PostalCode Country Phone Fax EmailAddress Command ErrCount Err(x) Done

Definition
Domain name Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Domain name ID number, from our database Whether ID Protect is available for this TLD Whether this domain has an ID Protect subscription Whether ID Protect is enabled for this domain Expiration date for this domains ID Protect subscription Whether auto-renew is enabled for this domains ID Protect subscription Yearly fee for this domains ID Protect subscription The contact type for this set of contact information The organization name for this contact First name for this contact Last name for this contact Address, first line, for this contact Address, second line, for this contact City for this contact State or province for this contact Postal code for this contact Country for this contact Phone number for this contact Fax number for this contact Email address for this contact Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests ID Protect settings for resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=GetWPPSInfo& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ResponseType=XML

In the response, the ID Protect status information, and the ErrCount value 0, confirm that the query was successful:

12/1/08

367

1999-2008 eNom, Inc.

API commands: GetWPPSInfo

<?xml version="1.0" ?> <interface-response> <GetWPPSInfo> <domainname sld="resellerdocs" tld="com" domainnameid="152533676"> resellerdocs.com </domainname> <WPPSAllowed>1</WPPSAllowed> <WPPSExists>1</WPPSExists> <WPPSEnabled>1</WPPSEnabled> <WPPSExpDate>Nov 26, 2004</WPPSExpDate> <WPPSAutoRenew>No</WPPSAutoRenew> <WPPSPrice>$6.00</WPPSPrice> <contacts> <contact ContactType="Administrative"> <Organization>Reseller Documents Inc.</Organization> <FName>John</FName> <LName>Doe</LName> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>+1.5555555555</Phone> <Fax>+1.5555555556</Fax> <EmailAddress>[email protected]</EmailAddress> </contact> . . . <contact ContactType="WPPS"> <Organization>Whois Privacy Protection Service, Inc.</Organization> <FName>Whois</FName> <LName>Agent</LName> <Address1>PMB 368, 14150 NE 20th St - F1</Address1> <Address2>C/O resellerdocs.com</Address2> <City>Hometown</City> <StateProvince>WA</StateProvince> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>+1.4252740657</Phone> <Fax>+1.4256960234</Fax> <EmailAddress>[email protected]</EmailAddress> </contact> </contacts> </GetWPPSInfo> <Command>GETWPPSINFO</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>0.140625</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]>

12/1/08

368

1999-2008 eNom, Inc.

API commands: GetWPPSInfo

</debug> </interface-response>

Related commands
DisableServices EnableServices PurchaseServices ServiceSelect

12/1/08

369

1999-2008 eNom, Inc.

API commands: HE_CancelAccount

HE_CancelAccount
Description
Definition
Flag a Hosted Microsoft Exchange account for deactivation at the end of the current billing cycle.

Usage
Use this command to cancel a Hosted Microsoft Exchange account. Cancellation is effective at the end of the current billing cycle.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to www.enom.com with your own Login ID and password.
http://www.enom.com/pop-email/hosted_exchange/manage.asp

Click any account name. The cancel button calls the HE_CancelAccount command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Hosted Microsoft Exchange account must belong to this domain name account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Account Enable

Obligation
Required Required Required Optional; default is True Optional; default is False

Definition
Account login ID Account password

Max size
20 20

Name of Hosted Microsoft Exchange account to be 10 deleted. Permitted format is HXNNNNN 1 Should this Hosted Microsoft Exchange account remain active? Permitted values are False (disable immediately) or True (leave enabled). Should this Hosted Microsoft Exchange account be 5 cancelled at the end of the current billing period? Permitted values are: True Delete at the end of current bill cycle False Do not delete at the end of bill cycle

Delete

12/1/08

370

1999-2008 eNom, Inc.

API commands: HE_CancelAccount

Param name

Obligation

Definition
Reason for cancelling. Permitted values are: 1 No longer needed 2 Not as expected 3 Price/value 4 Technical issue 5 Support issue 6 Unsupported functionality 7 Other reason not listed User-supplied text explaining cancellation Format of response. Options are Text (default), HTML, or XML.

Max size
1

DropDownReason Required if Delete=True

FreeFormReason ResponseType

Required if Delete=True Optional

250 4

Returned parameters and values

Param name Definition
AccountStatus Status of this Hosted Microsoft Exchange account. Possible values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason Is this account now flagged for deletion at the end of the current billing period? Was this query successful? Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Cancel Success Command ErrCount Err(x) Done

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
The following query flags an account so that it will be cancelled at the end of the current billing period, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_CANCELACCOUNT& uid=resellid&pw=resellpw&Account=HX69635&delete=true& dropdownreason=1&freeformreason=finished&ResponseType=XML

In the response, a Success value True and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <AccountStatus>1</AccountStatus> <cancel>True</cancel> <success>true</success>

12/1/08

371

1999-2008 eNom, Inc.

API commands: HE_CancelAccount

<Command>HE_CANCELACCOUNT</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.391</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount

12/1/08

372

1999-2008 eNom, Inc.

API commands: HE_ChangePassword

HE_ChangePassword
Description
Definition
Change the password for your Hosted Microsoft Exchange account.

Usage
Use this command to change the password for your Hosted Microsoft Exchange account.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to www.enom.com with your own login ID and password.
http://www.enom.com/pop-email/hosted_exchange/manage.asp

Click the account ID of any of your Hosted Microsoft Exchange accounts. In the Hosted Exchange Password section, the save changes button calls the HE_ChangePassword command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Hosted Microsoft Exchange account must belong to this domain name account. The password must contain at least one letter, and one number or special character.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Account

Obligation
Required Required Required

Definition
Account login ID Account password Hosted Microsoft Exchange account name. Permitted format is HXNNNNN

Max size
20 20 12

12/1/08

373

1999-2008 eNom, Inc.

API commands: HE_ChangePassword

Param name
NewPW

Obligation
Required

Definition
New password for your Hosted Microsoft Exchange account name. Permitted passwords contain 6 to 14 characters, including at least one letter, and at least one number or non-alphanumeric character. Permitted nonalphanumeric characters are ! @ $ ^ * ( ) _ = - [ ] | Repeat the new password for your Hosted Microsoft Exchange account name Format of response. Options are Text (default), HTML, or XML.

Max size
14

ConfirmNewPW ResponseType

Required Optional

14 4

Returned parameters and values

Param name Definition
AccountStatus Status of this Hosted Microsoft Exchange account. Possible values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason True indicates that the query was successful. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Success Command ErrCount Err(x) Done

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
The following query changes the password for a Hosted Microsoft Exchange account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_ChangePassword& uid=resellid&pw=resellpw&Account=HX57904&NewPW=tester1& ConfirmNewPW=tester1&responsetype=xml&

In the response, a Success value True and an ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <AccountStatus>0</AccountStatus> <success>True</success> <Command>HE_CHANGEPASSWORD</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod />

12/1/08

374

1999-2008 eNom, Inc.

API commands: HE_ChangePassword

<MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.469</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount

12/1/08

375

1999-2008 eNom, Inc.

API commands: HE_CreateAccount

HE_CreateAccount
Description
Definition
Create a Hosted Microsoft Exchange account using our real-time order processing.

Usage
Use this command to create a Hosted Microsoft Exchange account using our real-time order processing. To upgrade an existing Hosted Microsoft Exchange account in real time, use the HE_UpgradeAccount command. To purchase or upgrade a Hosted Microsoft Exchange account using our shopping cart, use the AddToCart command. To downgrade a Hosted Microsoft Exchange account, use the HE_UpgradeAccount command.

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. Subscription fees for Hosted Microsoft Exchange come from your reseller balance; we do not support credit card payments for this product.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD MailboxQty ExtraStorageQty

Obligation
Required Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name to associate with this Hosted Microsoft Exchange account. Top-level domain name (extension)

Max size
20 20 63 15

Number of mailboxes to support. Permitted values are 1 3 to 255. Number of units of extra storage to purchase. Each unit 3 is 100MB and is shared among all mailboxes in this Hosted Microsoft Exchange account. Permitted values are 0 to 255.

12/1/08

376

1999-2008 eNom, Inc.

API commands: HE_CreateAccount

Param name
BlackBerryQty GoodLinkQty ActiveSyncQty ResponseType

Obligation
Required Required Required Optional

Definition
Number of BlackBerry devices to support. Permitted values are 0 to 255. Number of Good Mobile Messaging devices to support. Permitted values are 0 to 255. Number of Microsoft ActiveSync devices to support. Permitted values are 0 to 255.

Max size
3 3 3

Format of response. Options are Text (default), HTML, 4 or XML.

Returned parameters and values

Param name
Mailboxes BlackBerrys GoodLinks ActiveSyncs ExtraStorage TotalPrice SMTPProxy AccountID HostedExchangeLoginID HostedExchangePassword OrderID Success Command ErrCount Err(x) Done

Definition
Number of Hosted Microsoft Exchange mailboxes purchased in this order Number of BlackBerry subscriptions purchased in this order Number of Good Mobile Messaging subscriptions purchased in this order Number of ActiveSync subscriptions purchased in this order Number of extra storage units purchased in this order Total charges for this order SMTP proxy address for this Hosted Microsoft Exchange account Hosted Microsoft Exchange account identification number, used by the Exchange servers to identify this account Login ID for this Hosted Microsoft Exchange account, used for most management and access tasks Login password for this Hosted Microsoft Exchange account, used for most management and access tasks Order ID for this purchase Success status for this purchase Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

377

1999-2008 eNom, Inc.

API commands: HE_CreateAccount

Example
The following query purchases Hosted Microsoft Exchange and add-ons, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_CreateAccount& uid=resellid&pw=resellpw&SLD=resellerdocs&TLD=com&MailboxQty=7& ExtraStorageQty=6&BlackBerryQty=3&GoodLinkQty=2&ActiveSyncQty=1&responsetype=xml

In the response, a Hosted Microsoft Exchange account name, and an ErrCount value 0, confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <Mailboxes>7</Mailboxes> <BlackBerrys>3</BlackBerrys> <GoodLinks>2</GoodLinks> <ActiveSyncs>1</ActiveSyncs> <ExtraStorage>6</ExtraStorage> <TotalPrice>363</TotalPrice> <SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy> <HostedExchangeID>1234567</HostedExchageID> <HostedExchangeLoginID>HX01234</HostedExchangeLoginID> <HostedExchangePassword>F13EC56</HostedExchangePassword> <OrderID>102534897</OrderID> <Success>True</Success> <Command>HE_CREATEACCOUNT</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.766</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_ChangePassword HE_GetAccountDetails HE_GetAccounts HE_GetPricing HE_UpgradeAccount

12/1/08

378

1999-2008 eNom, Inc.

API commands: HE_GetAccountDetails

HE_GetAccountDetails
Description
Definition
Retrieve details for one Hosted Microsoft Exchange account.

Usage
Use this command to retrieve details for one Hosted Microsoft Exchange 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.
http://enom.staging.local/pop-email/hosted_exchange/details.asp?Account=HX57904

If you reduce the numbers in any of the boxes, the save changes button calls the HE_GetAccountDetails command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Hosted Microsoft Exchange account must belong to this domain name account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Account ResponseType Required Required Required Optional

Definition
Account login ID Account password Hosted Microsoft Exchange account name. Permitted format is HXNNNNN Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10 4

12/1/08

379

1999-2008 eNom, Inc.

API commands: HE_GetAccountDetails

Returned parameters and values

Param name
HostedExchangeID AccountID LoginID Password SignupDate TerminateDate Terminate Status

Definition
Hosted Microsoft Exchange identification number, used by us to identify this account Hosted Microsoft Exchange account identification number, used by the Exchange servers to identify this account Account name of this Hosted Microsoft Exchange account, used by the customer to retrieve mail and manage this account Hosted Microsoft Exchange password Date on which this Hosted Microsoft Exchange account was created Date on which this Hosted Microsoft Exchange account is flagged for deletion Is this Hosted Microsoft Exchange flagged for deletion? Status of this Hosted Microsoft Exchange account. Possible values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason Hosted Microsoft Exchange plan represented by this account Number of mailboxes in this Hosted Microsoft Exchange account Number of BlackBerry devices currently subscribed in this Hosted Microsoft Exchange account Number of Good Mobile Messaging devices currently subscribed in this Hosted Microsoft Exchange account Number of ActiveSync devices currently subscribed in this Hosted Microsoft Exchange account Number of 100MB units of extra storage currently subscribed in this Hosted Microsoft Exchange account. Extra storage space is shared among all your mailboxes. Billing cycle identification number. 1 represents a one-month billing cycle Primary domain name for this account. Next billing date Next billing period, in months Current billing period, in months Amount that will be billed to your account on the next bill date Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Plan Mailboxes BlackBerry GoodLink ActiveSync ExtraStorage

BillCycleID SMTPProxy NextBillingDate NextBillingPeriod CurrentBillingPeriod BillingAmount Command ErrCount Err(x) Done

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.

12/1/08

380

1999-2008 eNom, Inc.

API commands: HE_GetAccountDetails

Example
The following query retrieves account details for one Hosted Microsoft Exchange account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_GetAccountDetails& uid=resellid&pw=resellpw&Account=HX57904&ResponseType=XML

In the response, the presence of account information and an ErrCount value 0 indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <Account> <HostedExchangeID>24</HostedExchangeID> <AccountID>1056747</AccountID> <loginid>HX57904</loginid> <password>3932293</password> <SignupDate>1/8/2007 9:33:13 AM</SignupDate> <TerminateDate /> <Terminate>False</Terminate> <status>1</status> <Plan>MSExchange_PLR (Gold) Copy</Plan> <MailBoxes>100</MailBoxes> <BlackBerry>2</BlackBerry> <GoodLink>2</GoodLink> <ActiveSync>2</ActiveSync> <ExtraStorage>2</ExtraStorage> <BillCycleID>1</BillCycleID> <SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy> <NextBillingDate>2/8/2007</NextBillingDate> <NextBillingPeriod>1</NextBillingPeriod> <CurrentBillingPeriod>1</CurrentBillingPeriod> <BillingAmount>870</BillingAmount> </Account> <Command>HE_GETACCOUNTDETAILS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.094</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccounts HE_GetPricing HE_UpgradeAccount

12/1/08

381

1999-2008 eNom, Inc.

API commands: HE_GetAccounts

HE_GetAccounts
Description
Definition
Retrieve a list of Hosted Microsoft Exchange accounts in this domain name account.

Usage
Use this command to retrieve a list of the Hosted Microsoft Exchange accounts in this domain name 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://enom.staging.local/pop-email/hosted_exchange/manage.asp

This page displays the results of the HE_GetAccounts 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
LoginID Password SignupDate TerminateDate Terminate

Definition
Login ID for this Hosted Microsoft Exchange account Password for this Hosted Microsoft Exchange account Date on which this Hosted Microsoft Exchange account was created If this Hosted Microsoft Exchange account has been tagged for cancellation, the date on which service will terminate Has this Hosted Microsoft Exchange account been tagged for cancellation?

12/1/08

382

1999-2008 eNom, Inc.

API commands: HE_GetAccounts

Param name
Status

Definition
Status of this Hosted Microsoft Exchange account. Return values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason Hosted Microsoft Exchange plan represented by this account Number of mailboxes in this Hosted Microsoft Exchange account Number of BlackBerry devices currently supported in this Hosted Microsoft Exchange account Number of Good Mobile Messaging devices currently supported in this Hosted Microsoft Exchange account Number of ActiveSync devices currently supported in this Hosted Microsoft Exchange account Number of 100MB units of extra storage currently subscribed in this Hosted Microsoft Exchange account. Extra storage space is shared among all your mailboxes. Billing cycle identification number. 1 represents a one-month billing cycle Primary domain name for this account. Next billing date Number of Hosted Microsoft Exchange accounts in this domain name account. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Plan Mailboxes BlackBerry GoodLink ActiveSync ExtraStorage

BillCycleID SMTPProxy NextBillingDate Count Command ErrCount Err(x) Done

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
The following query retrieves Hosted Microsoft Exchange accounts in a domain name account, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_GETAccounts& uid=resellid&pw=resellpw&responsetype=xml

In the response, a list of Hosted Microsoft Exchange accounts and an ErrCount value 0, indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <ExchangeAccounts> <Account> <LoginID>HX60270</LoginID> <Password>6DF9968</Password> <SignupDate>1/17/2007 5:55:39 PM</SignupDate> <TerminateDate /> <Terminate>False</Terminate> <Status>1</Status>

12/1/08

383

1999-2008 eNom, Inc.

API commands: HE_GetAccounts

<Plan>MSExchange_PLR (Gold) Copy</Plan> <Mailboxes>1</Mailboxes> <Blackberry>1</Blackberry> <goodlink>1</goodlink> <Activesync>1</Activesync> <Extrastorage>1</Extrastorage> <BillcycleID>1</BillcycleID> <SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy> <NextBillingDate>2/17/2007</NextBillingDate> </Account> <Account> <LoginID>HX04967</LoginID> <Password>C2EA47A</Password> <SignupDate>1/23/2007 5:26:26 PM</SignupDate> <TerminateDate /> <Terminate>False</Terminate> <Status>1</Status> <Plan>MSExchange_PLR (Gold) Copy</Plan> <Mailboxes>1</Mailboxes> <Blackberry>2</Blackberry> <goodlink>3</goodlink> <Activesync>4</Activesync> <Extrastorage>1</Extrastorage> <BillcycleID>1</BillcycleID> <SMTPProxy>smtp14.msoutlookonline.net</SMTPProxy> <NextBillingDate>2/23/2007</NextBillingDate> </Account> . . . </ExchangeAccounts> <Count>8</Count> <Command>HE_GETACCOUNTS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.172</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetPricing HE_UpgradeAccount

12/1/08

384

1999-2008 eNom, Inc.

API commands: HE_GetPricing

HE_GetPricing
Description
Definition
Retrieve the wholesale pricing that this account pays for Hosted Microsoft Exchange email services.

Usage
Use this command to retrieve the wholesale subscription rates and setup fees that this account pays for Hosted Microsoft Exchange Mail and its supported devices.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/pop-email/hosted_exchange/default.asp

The Get Started button calls the HE_GetPricing 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW ShowAll

Obligation
Required Required Optional; default is 1

Definition
Account login ID Account password

Max size
20 20

Show pricing for all quantities of mailboxes? Permitted 1 values are: 0 Show pricing for one quantity (GetQty value) 1 Show prices for all mailbox quantities Return the per-mailbox price for this number of mailboxes. Permitted values are 1 to 255 Format of response. Options are Text (default), HTML, or XML. 3 4

GetQty ResponseType

Required if ShowAll=0 Optional

12/1/08

385

1999-2008 eNom, Inc.

API commands: HE_GetPricing

Returned parameters and values

Param name
Qty Price AdditionalStorage BlackBerry GoodLink ActiveSync BlackBerrySetup GoodLinkSetup Command ErrCount Err(x) Done

Definition
Number of Hosted Exchange mailboxes in this package Price per mailbox in this package Price for 100MB extra storage. When you purchase 1 unit of extra storage, 100MB is shared among all mailboxes. Monthly fee for BlackBerry support, per mailbox Monthly fee for GoodLink support, per mailbox Monthly fee for ActiveSync support, per mailbox One-time setup fee for BlackBerry support, per mailbox One-time setup fee for GoodLink support, per mailbox Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the prices this account pays for Hosted Microsoft Exchange, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_GETPRICING& uid=resellid&pw=resellpw&ShowAll=1&responsetype=xml&

In the response, a list of Hosted Microsoft Exchange components and their prices, and an ErrCount value 0, indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <MailBoxes> <MailBox> <QTY>1</QTY> <Price>8.5</Price> </MailBox> <MailBox> <QTY>3</QTY> <Price>8</Price> </MailBox> <MailBox> <QTY>5</QTY> <Price>8</Price> </MailBox> <MailBox> <QTY>10</QTY> <Price>8</Price>

12/1/08

386

1999-2008 eNom, Inc.

API commands: HE_GetPricing

</MailBox> <MailBox> <QTY>25</QTY> <Price>8</Price> </MailBox> <MailBox> <QTY>50</QTY> <Price>8</Price> </MailBox> <MailBox> <QTY>100</QTY> <Price>8</Price> </MailBox> </MailBoxes> <Addons> <AdditionalStorage>5</AdditionalStorage> <Blackberry>9</Blackberry> <Goodlink>19</Goodlink> <ActiveSync>2</ActiveSync> </Addons> <SetupFees> <BlackberrySetup>50</BlackberrySetup> <GoodlinkSetup>30</GoodlinkSetup> </SetupFees> <Command>HE_GETPRICING</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.344</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_UpgradeAccount

12/1/08

387

1999-2008 eNom, Inc.

API commands: HE_UpgradeAccount

HE_UpgradeAccount
Description
Definition
Upgrade or downgrade an existing Hosted Microsoft Exchange account in real time.

Usage
Use this command to upgrade or downgrade an existing Hosted Microsoft Exchange account in real time. If you use our shopping cart, you can upgrade an existing Hosted Microsoft Exchange account using the AddToCart command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/pop-email/hosted_exchange/details.asp?Account=HX57904

If you reduce the numbers in one or more of the boxes, the save changes or add to cart button calls the HE_UpgradeAccount command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Hosted Microsoft Exchange account must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Account Required Required Required

Definition
Account login ID Account password Hosted Microsoft Exchange login ID. Permitted format is HXNNNNN

Max size
20 20 12

12/1/08

388

1999-2008 eNom, Inc.

API commands: HE_UpgradeAccount

Param name Obligation

ItemNameX X = 1 to maximum 5

Definition

Max size
12

Permitted values are: At least one Mailboxes ItemNameX is ExtraStorage (1 unit of storage is 100MB, shared Required among all mailboxes in this Hosted Microsoft Exchange account) BlackBerry GoodLink ActiveSync Required New number of mailboxes, storage units, or devices to subscribe to (this is the number you will have after this query string is processed). Permitted values are: 1 through 255 for Mailboxes 0 through 255 for other items Format of response. Options are Text (default), HTML, or XML.

ItemLimitX X = 1 to maximum 5

ResponseType

Optional

Returned parameters and values

Param name Definition
AccountStatus Status of this Hosted Microsoft Exchange account. Possible values are: 1 Active 4 Disabled for nonpayment 5 Disabled for other reason Final number of mailboxes in this Hosted Microsoft Exchange account, after the changes in this query string Final number of BlackBerry devices supported, after changes Final number of Good Mobile Messenger devices supported, after changes Final number of ActiveSync devices supported, after changes Final number of 100MB units of extra storage, after changes Order ID number for the upgrades in this query string Amount, in $US, charged for this order, including one-time setup fees New monthly billing rate, in $US, for this Hosted Microsoft Exchange account. This number includes monthly subscription fees for all services, but not one-time setup fees. This new amount will apply starting on the next monthly billing date. True indicates that this query was successful True indicates that the query string included upgrades, and that they were successful True indicates that the query string included downgrades, and that they were successful Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Mailboxes BlackBerry GoodLink ActiveSync ExtraStorage OrderID UpgradePrice NewPrice

Success Upgrade Downgrade Command ErrCount Err(x) Done

12/1/08

389

1999-2008 eNom, Inc.

API commands: HE_UpgradeAccount

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
The following query downgrades the ActiveSync subscription, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=HE_UPGRADEACCOUNT& uid=resellid&pw=resellpw&Account=HX57904& ItemName1=ActiveSync&ItemLimit1=2&DoAll=1&responsetype=xml

In the response, a Success value True and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <AccountStatus>0</AccountStatus> <upgraded>true</upgraded> <success>True</success> <Command>HE_UPGRADEACCOUNT</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>1.063</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
HE_CancelAccount HE_ChangePassword HE_CreateAccount HE_GetAccountDetails HE_GetAccounts HE_GetPricing

12/1/08

390

1999-2008 eNom, Inc.

API commands: InsertNewOrder

InsertNewOrder
Description
Definition
Insert a checkout order of items in the shopping cart.

Usage
Use this command if you use our shopping cart technology. This command checks out the items in a shopping cart that are in A (active) status, and puts the order in a queue.
Purchase, a similar command, completes the purchase of selected products in real time, without using our

shopping cart or waiting for the order processing queue.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/Checkout.asp

On the checkout page, the purchase button calls the InsertNewOrder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. If the shopping cart is empty, ItemCount must equal 1 or the query will return an error message.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW EndUserIP

Obligation Definition
Required Required Required Account login ID Account password

Max size
20 20

End users IP address. This is used in fraud checking, as part 15 of our order processing service. Use format NNN.NNN.NNN.NNN. Number of items ready to purchase. All with a status of A (active) Format of response. Options are Text (default), HTML, or XML. 4 4

ItemCount ResponseType

Optional Optional

12/1/08

391

1999-2008 eNom, Inc.

API commands: InsertNewOrder

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests purchase of the contents of the shopping cart, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=insertneworder& uid=resellid&pw=resellpw&EndUserIP=127.0.0.1&responsetype=xml

The response confirms a successful checkout by sending an order ID number

<?xml version="1.0" ?> <interface-response> <OrderID>156062745</OrderID> <ProdType10>10</ProdType10> <Command>INSERTNEWORDER</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

392

1999-2008 eNom, Inc.

API commands: InsertNewOrder

Related commands
AddBulkDomains AddToCart Check DeleteFromCart Extend Extend_RGP ExtendDomainDNS GetDomainExp GetExtendInfo GetRenew Purchase PurchasePreview SetRenew UpdateCart UpdateExpiredDomains

12/1/08

393

1999-2008 eNom, Inc.

API commands: ME_AddChannelReseller

ME_AddChannelReseller
Description
Definition
Add a ChannelME.TV Social Networking Channel to a .tv domain name.

Usage
Use this command to enable a ChannelME.TV Social Networking Channel for a .tv domain name. This command does the following: Creates a Social Networking Channel for the specified domain name Records a password for accessing this channel, a display name, and other profile information Allocates space for this channel on the ChannelME.TV Social Networking servers Points the domain names www and @ host records to the channel

Once you establish a ChannelME.TV Social Networking channel, any profile information and content remains on our servers as long as the domain is registered or hosted by us.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to www.enom.com with your own Login ID and password. List your .tv domains and click any name that uses our name servers. Click the Social Networking link. The save button calls a command similar to ME_AddChannelReseller.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name must belong to this account. The domain must be a .tv domain name. The domain must use our name servers.

12/1/08

394

1999-2008 eNom, Inc.

API commands: ME_AddChannelReseller

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD ME_Password

Obligation
Required Required Required Required Required

Definition
Login ID for this domain name account Password for this domain name account

Max size
20 20

Second-level domain name (for example, enom 63 in enom.com) Top-level domain name (extension). Required value is tv 2

Access password for logging on to the 60 ChannelME.TV management console for this .tv domain name. Permitted values are 6 to 60 alphanumeric characters Name or nickname you want to display in your profile. Permitted values are alphanumeric characters, spaces, and some special characters. Unique user name. If ME_UserName is not supplied, one will be created based on the value supplied in ME_Display_Name. Permitted values are alphanumeric characters, spaces, and some special characters Your name. Permitted values are alphanumeric characters Email address for your user profile. Permitted format is [email protected] URL of your domain sales home page or ChannelME.TV marketing page, to display in this channel. Required format is http://host.sld.tld/path Format of response. Options are Text (default), HTML, or XML. 26

ME_Display_Name

Required

ME_UserName

Optional

26

ME_Name ME_Email ME_HomeURL

Optional Required Required

30 128 255

ResponseType

Optional

Returned parameters and values

Param name
ChannelCreated ChannelReconnected ChannelID ChannelDateCreated ChannelOwnerID ChannelUserName ChannelDisplayName DomainCNAMEUpdate URL Command

Definition
Success status of this query, if creating a new channel Success status of this query, if reconnecting a channel Identification number of this channel Date on which this channel was originally created Identification number for the owner of this channel User name for this channel Display name for this channel Success status of updating the host record for this channel URL for accessing this channel. Name of command executed

12/1/08

395

1999-2008 eNom, Inc.

API commands: ME_AddChannelReseller

Param name
ErrCount Err(x) Done

Definition
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets up a ChannelME.TV Social Networking Channel for a .tv domain name, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=ME_ADDCHANNELRESELLER& uid=resellid&pw=resellpw&sld=resellerdocs&tld=tv& ME_password=BrandNewPassword&[email protected]& ME_display_name=CreativeDisplayName&ME_name=PlainOldMEName& ME_HomeURL=http://www.example.com&responsetype=xml

In the response, the ChannelCreated or ChannelReconnected value True indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <ChannelCreated>True</ChannelCreated> <ChannelID>287</ChannelID> <ChannelDateCreated>4/24/2007 2:28:17 PM</ChannelDateCreated> <ChannelOwnerID>8296</ChannelOwnerID> <ChannelUserName>creativedisplayname</ChannelUserName> <ChannelDisplayName>CreativeDisplayName</ChannelDisplayName> <DomainCnameUpdate>OK</DomainCnameUpdate> <URL>http://resellerdocs-tv.me.tv</URL> <Command>ME_ADDCHANNELRESELLER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>1.531</ExecTime> <Done>true</Done> <debug></debug> </interface-response>

12/1/08

396

1999-2008 eNom, Inc.

API commands: ME_AddChannelReseller

Related commands
AddToCart AuthorizeTLD Purchase SetHosts

12/1/08

397

1999-2008 eNom, Inc.

API commands: ModifyNS

ModifyNS
Description
Definition
Modify name servers for a domain name.

Usage
Use this command if you want to use name servers that are different than the name servers currently set for a domain. ModifyNS updates DNS records at the Registry and in the registrars database. ModifyNSHosting, a similar command, redirects to another set of name servers without updating the Registry records.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DNSConfig.asp?DomainNameID=152533676

On the Domain Name Maintenance page, the save changes button calls the ModifyNS 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. The query must pass name servers that are registered at NSI. Name servers for .us names must be located in the United States.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

12/1/08

398

1999-2008 eNom, Inc.

API commands: ModifyNS

Param name Obligation Definition

UseDNS Either UseDNS or NSX is Required Either UseDNS or NSX is Required Optional Which name servers a domain is using. Supply UseDNS=Default to use eNoms name servers

Max size
4

NSX

Name server Xmaximum of 12 can be set. Permitted value 60 is the use name of the name server, for example, NS1=ns1.name-services.com Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. To set name servers to eNoms set the UseDNS=ours param and don't pass NS(x) name servers. To set name servers to your name servers, set NSX=YourNameServerX and don't pass UseDNS=default. You can set up to 12 of your own name servers.

Example
The following query changes the name servers for resellerdocs.com to ns1.name-services.com and ns2.name-services.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=modifyns& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& ns1=ns1.name-services.com&ns2=ns2.name-services.com&responsetype=xml

The reponse confirms that the change of name servers was successful:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <reg-lock>1</reg-lock> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>MODIFYNS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server>

12/1/08

399

1999-2008 eNom, Inc.

API commands: ModifyNS

<Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNSHosting RegisterNameServer UpdateNameServer

12/1/08

400

1999-2008 eNom, Inc.

API commands: ModifyNSHosting

ModifyNSHosting
Description
Definition
Modify the name-server redirect settings for a domain name.

Usage
ModifyNSHosting redirects to another set of name servers without updating the Registry records. ModifyNS, a similar command, updates name server records at the Registry and in the registrars database.

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 domain name must belong to this account. The name server cited in the query must exist.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD NSX X=1 to 12 ResponseType Required Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

Name servermaximum of 12 can be set. Permitted value is 60 the use name of the name server, for example, NS1=ns1.name-services.com Format of response. Options are Text (default), HTML, or XML. 4

Optional

12/1/08

401

1999-2008 eNom, Inc.

API commands: ModifyNSHosting

Returned parameters and values

Param name
RegistrarHold Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query designates ns1.name-services.com as the name server for resellerdocs.com, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=modifynshosting& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& ns1=ns1.name-services.com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> - <interface-response> <RegistrarHold>False</RegistrarHold> <Command>MODIFYNSHOSTING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> - <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS RegisterNameServer UpdateNameServer

12/1/08

402

1999-2008 eNom, Inc.

API commands: ModifyPOP3

ModifyPOP3
Description
Definition
Modify POP account password.

Usage
Use this command to change the password of one or more POP3 mail accounts in a domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/POPConfig.asp?DomainNameID=152533676

On the Domain Name Maintenance page, in the Edit POP mail accounts box, typing a new password and clicking the add to cart button to save modifications calls the ModifyPOP3 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. The POP3 service need not be active for the password change to be successful. The values of UserName in the query must exist for the domain. The value for EmailCount must match the number of UserNames and Passwords in the query.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD EmailCount UserNameX X=1 to EmailCount Required Required Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Number of accounts on this domain to update. POP3 user name to update the password on.

Max size
20 20 63 15 2 30

12/1/08

403

1999-2008 eNom, Inc.

API commands: ModifyPOP3

Param name Obligation Definition

IsAdminX X=1 to EmailCount Either IsAdminX or PasswordX is Required. They may be used together.

Max size

Should UserNameX have administrative privileges over all 1 mailboxes associated with this domain name? Administrative privileges allow this user to reset the password for mailboxes, and delete mailboxes. Permitted values are: 0 Regular user (can change the password for their own mailbox but no one elses) 1 Administrator (when this user logs on to Webmail and goes to the admin page, he or she can see all mailboxes for this domain name, can reset passwords for any or all mailboxes, and can delete any or all mailboxes) 50

PasswordX X=1 to EmailCount

New password for UserNameXs mailbox. Either IsAdminX or PasswordX is Required. They may be used together. Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that two POP3 passwords change in resellerdocs.com: user name john should now have password johnpw and user name jane should now have password janepw. The query also requests that the response be in XML format:
http://resellertest.enom.com/interface.asp?command=modifypop3& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&emailcount=2& username1=john&password1=johnpw&username2=jane&password2=janepw&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response>

12/1/08

404

1999-2008 eNom, Inc.

API commands: ModifyPOP3

<RegistrarHold>False</RegistrarHold> <Command>MODIFYPOP3</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetForwarding GetMailHosts GetPOP3 PurchasePOPBundle SetUpPOP3User

12/1/08

405

1999-2008 eNom, Inc.

API commands: NameSpinner

NameSpinner
Description
Definition
Generate variations of a domain name that you specify, for .com, .net, .tv, and .cc TLDs.

Usage
Use this command to generate variations of the domain name you specify. This command will return TLDs .com, .net, .tv, and .cc.

Availability
All resellers have access to this command.

Implementation on eNom.com
http://resellertest.enom.com/domains/default.asp Type an SLD into the Register A New Domain box and click GO. The results in the We also recommend section are generated by the NameSpinner 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD SensitiveContent

Obligation
Required Required Required Required Optional; default is False Optional; default is 63 Optional; default is 20

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Block potentially offensive content? Permitted values are True or False. True filters out offensive content.

Max size
20 20 63 15 5

MaxLength MaxResults

Maximum length of SLD to return. Permitted values are 2 numbers 2 to 63. Maximum number of suggested names to return in addition to your input. The number actually returned may be lower because of the spinning algorithm developed by the Registry. Permitted values are numbers 0 to 99. 2

12/1/08

406

1999-2008 eNom, Inc.

API commands: NameSpinner

Param name
UseHyphens

Obligation
Optional; default is False

Definition
Return domain names that include hyphens? Permitted values are True or False.

Max size
5

UseNumbers Basic

Optional; Return domain names that include numbers? Permitted default is True values are True or False. Optional; default is Medium Higher values return suggestions that are built by adding prefixes, suffixes, and words to the original input. Permitted values are Off, Low, Medium, and High.

5 6

Related

Optional; Higher values return domain names by interpreting the 6 default is High input semantically and construct suggestions with a similar meaning. Related=High will find terms that are synonyms of your input. Permitted values are Off, Low, Medium, and High. Optional; default is Medium Higher values return suggestions that are similar to the 6 customers input, but not necessarily in meaning. Similar=High will generate more creative terms, with a slightly looser relationship to your input, than Related=High. Permitted values are Off, Low, Medium, and High. Higher values return suggestions that reflect current topics and popular words. Permitted values are Off, Low, Medium, and High. 6

Similar

Topical

Optional; default is Medium Optional

ResponseType

Format of response. Options are Text (default), HTML, 4 or XML.

Returned parameters and values

Param name Definition
SpinCount TLDList Domain name Com ComScore Net NetScore Tv TvScore Cc CcScore OriginalSLD Command ErrCount Number of SLDs returned in this response TLDs returned in this response SLD for this set of results Is this SLD available from the .com Registry? Y indicates yes; N indicates no. The Registrys score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000. Is this SLD available from the .net Registry? Y indicates yes; N indicates no. The Registrys score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000. Is this SLD available from the .tv Registry? Y indicates yes; N indicates no. The Registrys score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000. Is this SLD available from the .cc Registry? Y indicates yes; N indicates no. The Registrys score of how closely this SLD matches the SLD input you supplied in the query string. Highest possible score is 1000. The SLD value you supplied in the input query string Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

407

1999-2008 eNom, Inc.

API commands: NameSpinner

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves 8 domains that resemble the input SLD hand, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=NameSpinner& UID=resellid&PW=resellpw&SLD=hand&TLD=com&MaxResults=8& Similar=High&ResponseType=XML

In the response, the presence of spun names and the ErrCount value 0 indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <namespin> <spincount>8</spincount> <TLDList /> <domains> <domain name="handsewncurtains" com="n" comscore="835" net="y" netscore="864" tv="y" tvscore="797" cc="y" ccscore="762" /> <domain name="handicappingclub" com="n" comscore="821" net="y" netscore="851" tv="y" tvscore="784" cc="y" ccscore="749" /> <domain name="handingok" com="y" comscore="837" net="y" netscore="810" tv="y" tvscore="783" cc="y" ccscore="757" /> <domain name="handsofjustice" com="n" comscore="870" net="n" netscore="844" tv="y" tvscore="834" cc="y" ccscore="799" /> <domain name="handoki" com="n" comscore="794" net="y" netscore="824" tv="y" tvscore="757" cc="y" ccscore="722" /> <domain name="handinghand" com="y" comscore="820" net="y" netscore="793" tv="y" tvscore="767" cc="y" ccscore="740" /> <domain name="handcrafthouselogs" com="y" comscore="810" net="y" netscore="783" tv="y" tvscore="757" cc="y" ccscore="730" /> <domain name="handloser" com="n" comscore="844" net="n" netscore="817" tv="y" tvscore="807" cc="y" ccscore="773" /> </domains> </namespin> <originalsld>hand</originalsld> <Command>NAMESPINNER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD>

12/1/08

408

1999-2008 eNom, Inc.

API commands: NameSpinner

<TimeDifference>+03.00</TimeDifference> <ExecTime>0.719</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart Check Purchase

12/1/08

409

1999-2008 eNom, Inc.

API commands: ParseDomain

ParseDomain
Description
Definition
Separate the domain name into its host, SLD, and TLD.

Usage
Use this command to separate a domain name into its constituent parts.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW PassedDomain ResponseType Required Required Required Optional

Definition
Account login ID Account password Full name to parse, including the third level if appropriate Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 70 4

Returned parameters and values

Param name Definition
Host SLD TLD Command ErrCount Host name Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

410

1999-2008 eNom, Inc.

API commands: ParseDomain

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query separates the domain name www.resellerdocs.com into its Host, SLD, and TLD, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=parsedomain& uid=resellid&pw=resellpw&passeddomain=www.resellerdocs.com& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <ParseDomain> <Host>www</Host> <SLD>resellerdocs</SLD> <TLD>com</TLD> </ParseDomain> <Command>PARSEDOMAIN</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
None

12/1/08

411

1999-2008 eNom, Inc.

API commands: PE_GetCustomerPricing

PE_GetCustomerPricing
Description
Definition
Get retail prices that this account charges to consumers. These are also the prices that this accounts subaccounts will be charged, unless you change them for each individual subaccount.

Usage
Use this command to retrieve prices that you have changed from their default values.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-List.asp

If you click a Login ID of a retail subaccount, the link calls the PE_GetCustomerPricing command. If you click a Login ID of a reseller subaccount, the link calls the PE_GetResellerPrice 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name
CPID

Definition
Pricing engine index, for use by eNoms database.

12/1/08

412

1999-2008 eNom, Inc.

API commands: PE_GetCustomerPricing

Param name
ProductType

Definition
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal 413

12/1/08

1999-2008 eNom, Inc.

API commands: PE_GetCustomerPricing

Param name
ProductDescription TLDID TLD RetailPrice ResellerPrice RocketPrice Enabled Command ErrCount Err(x) Done

Definition
Product description. Values are listed under ProductType, above. Top-level-domain ID number. Top-level domain name. Retail price. Response contains a value only if price overrides the default value. Reseller price. Registry Rocket price. Response contains a value only if price overrides the default value. Enabled state for this TLD. Options are True or False. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the price that subaccount olerud charges for transferring a .org domain name, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETCUSTOMERPRICING& uid=olerud&pw=olerudpw&ProductType=19&tld=org&responsetype=xml

The response indicates that the price for transferring a .org name is $8.95, and .org transfers are enabled in this subaccount:
<?xml version="1.0" ?> <interface-response> <productstructure> <product> <cpid>256759</cpid> <producttype>19</producttype> <productdescription>Transfer</productdescription> <tldid>2</tldid> <tld>org</tld> <retailprice /> <resellerprice>8.95</resellerprice> <rocketprice /> <enabled>True</enabled> </product> </productstructure> <Command>PE_GETCUSTOMERPRICING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug>

12/1/08

414

1999-2008 eNom, Inc.

API commands: PE_GetCustomerPricing

<![CDATA[ ] ]> </debug> </interface-response>

Related commands
CommissionAccount GetBalance PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRocketPrice PE_SetPricing

12/1/08

415

1999-2008 eNom, Inc.

API commands: PE_GetDomainPricing

PE_GetDomainPricing
Description
Definition
Get the retail pricing that this account charges for registrations, renewals, and transfers, by top-level domain.

Usage
Use this command when you want a list of retail prices for one top-level domain, for registrations, renewals, and transfers. To get a list of retail prices for all products offered by this account, use PE_GetRetailPricing.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-Manage.asp?Account=850-tn-1053

PE_GetDomainPricing is not implemented on enom.com. The sub-account configuration page displays similar information, but for all top-level domains.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW UseQtyEngine Years ResponseType Required Required Optional; default is 0 Optional; default is 1 Optional Account login ID Account password Return prices for multiple-year registrations? Permitted values are 0 and 1. Number of years for multiple-year registrations. Permitted values are 1, 2, 5, and 10. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 1 2 4

12/1/08

416

1999-2008 eNom, Inc.

API commands: PE_GetDomainPricing

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the pricing for account resellid for the various top-level domains, with the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETDOMAINPRICING& uid=resellid&pw=resellpw&responsetype=xml

The response indicates that the price of .com domains is $8.95 per year, .net is $8.95 per year, and so on:
<?xml version="1.0" ?> <interface-response> <pricestructure> <product> <tld>com</tld> <registerprice>8.95</registerprice> <registerenabled>True</registerenabled> <renewprice>8.95</renewprice> <renewenabled>True</renewenabled> <transferprice>8.95</transferprice> <transferenabled>True</transferenabled> </product> <product> <tld>net</tld> <registerprice>8.95</registerprice> <registerenabled>True</registerenabled> <renewprice>8.95</renewprice> <renewenabled>True</renewenabled> <transferprice>8.95</transferprice> <transferenabled>True</transferenabled> </product> <product> <tld>org</tld> <registerprice>8.95</registerprice> <registerenabled>True</registerenabled> <renewprice>8.95</renewprice> <renewenabled>True</renewenabled> <transferprice>8.95</transferprice> <transferenabled>True</transferenabled> </product>

12/1/08

417

1999-2008 eNom, Inc.

API commands: PE_GetDomainPricing

. . . </pricestructure> <Command>PE_GETDOMAINPRICING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CommissionAccount GetBalance PE_GetCustomerPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRocketPrice PE_SetPricing

12/1/08

418

1999-2008 eNom, Inc.

API commands: PE_GetPOPPrice

PE_GetPOPPrice
Description
Definition
Retrieve the wholesale price that this account pays for POP mail 10-paks.

Usage
Use this command to retrieve the wholesale price that this account pays for POP mail 10-paks.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/ProductPricing.asp?tab=domainaddons

In the POP3 email paks row, the value in the Your cost column is supplied by the PE_GetPOPPrice 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
Pop Command ErrCount Wholesale price this account pays per POP 10-pak Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

419

1999-2008 eNom, Inc.

API commands: PE_GetPOPPrice

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the wholesale price that account resellid pays for a POP 10-pak, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETPOPPRICE& uid=resellid&pw=resellpw&responsetype=xml

In the response, a pop pricing value and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <pricing> <pop>18.4015</pop> </pricing> <Command>PE_GETPOPPRICE</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>8.203125E-02</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetPOP3 PE_GetCustomerPricing PE_GetDomainPricing PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice PE_SetPricing PurchasePOPBundle

12/1/08

420

1999-2008 eNom, Inc.

API commands: PE_GetProductPrice

PE_GetProductPrice
Description
Definition
Retrieve the wholesale cost that this account pays for a product.

Usage
Use this command to retrieve wholesale pricing information for a single product.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/RenewalPricing.asp?tab=1

Each value in the Your Cost column could be retrieved using one call to the PE_GetProductPrice 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

421

1999-2008 eNom, Inc.

API commands: PE_GetProductPrice

Param name Obligation

ProductType Required

Definition
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal

Max size
63

12/1/08

422

1999-2008 eNom, Inc.

API commands: PE_GetProductPrice

Param name Obligation

TLD Required if ProductType is 10, 16, or 19

Definition
Top-level domain name (extension)

Max size
15

Years

Optional; Year bracket for which to retrieve prices. Permitted values default value is are 1, 2, 5, and 10. For example, Years=2 retrieves 1 prices for registrations of 2 to 4 years. Optional Format of response. Options are Text (default), HTML, or XML.

20

ResponseType

Returned parameters and values

Param name
Price ProductEnabled Command ErrCount Err(x) Done

Definition
Wholesale price that the UID pays for this product Enabled status of this product Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves the price for registering a .com domain, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETPRODUCTPRICE& uid=resellid&pw=resellpw&ProductType=10&tld=com&responsetype=xml

In the response, a price and an enabled status for the product confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <productprice> <price>8.95</price> <productenabled>True</productenabled> </productprice> <Command>PE_GETPRODUCTPRICE</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable>

12/1/08

423

1999-2008 eNom, Inc.

API commands: PE_GetProductPrice

<IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.1015625</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice PE_SetPricing

12/1/08

424

1999-2008 eNom, Inc.

API commands: PE_GetResellerPrice

PE_GetResellerPrice
Description
Definition
Get the wholesale price that this account pays for one product, and tell whether that product is enabled.

Usage
Use this command to retrieve the price of one product. For example, you can use this command to retrieve the price you pay for registering a .com name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-List.asp

On the home > pricing info page, each individual price can be retrieved using PE_GetResellerPrice.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

425

1999-2008 eNom, Inc.

API commands: PE_GetResellerPrice

Param name Obligation

ProductType Required

Definition
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal

Max size
3

12/1/08

426

1999-2008 eNom, Inc.

API commands: PE_GetResellerPrice

Param name Obligation

TLD Required for ProductType 10, 16, or 19 Optional; default is 1

Definition
If the ProductType is 10, 16, or 19, specify the TLD for which you want pricing information. Retrieve quantity discount information. For some products like domains, this value represents the price break for multi-year registrations. For other products like Hosted Exchange, it represents the price for multiple units of the product. Format of response. Options are Text (default), HTML, or XML.

Max size
20

Years

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the price for registration of a .org domain name, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETRESELLERPRICE& uid=resellid&pw=resellpw&tld=org&ProductType=10&responsetype=xml

The response indicates that a .org domain name is $8.95 per year:
<?xml version="1.0" ?> <interface-response> <productprice> <price>8.95</price> <productenabled>True</productenabled> </productprice> <Command>PE_GETRESELLERPRICE</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]>

12/1/08

427

1999-2008 eNom, Inc.

API commands: PE_GetResellerPrice

</debug> </interface-response>

Related commands
CommissionAccount GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetRetailPrice PE_GetRocketPrice PE_SetPricing

12/1/08

428

1999-2008 eNom, Inc.

API commands: PE_GetRetailPrice

PE_GetRetailPrice
Description
Definition
Get the Retail pricing for a specified product, and tell whether the product is enabled. The Retail price is the price you charge to your retail customers; it is also the price you charge your subaccounts unless you set prices specifically for each subaccount using commands such as UpdateAccountPricing, GetSubAccountDetails, or PE_SetPricing.

Usage
Use this command to retrieve pricing for a single product. For example, you can use this command to retrieve the price for renewing a .org name that you currently have set for one retail subaccount.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-Manage.asp?Account=850-tn-1053

PE_GetRetailPrice is not implemented on enom.com. The sub-account configuration page displays similar information, but for all top-level domains and for registering, renewing, and transferring domains.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW Required Required Account login ID Account password

Max size
20 20

12/1/08

429

1999-2008 eNom, Inc.

API commands: PE_GetRetailPrice

Param name Obligation Definition

ProductType Required Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal

Max size
3

12/1/08

430

1999-2008 eNom, Inc.

API commands: PE_GetRetailPrice

Param name Obligation Definition

TLD Years Optional Optional If ProductType is 10, 16, or 19, include the TLD for which you want the retail price setting.

Max size
15

Retrieve prices for bulk discounts. In some cases like 3 domains, this value represents the price for multi-year registrations. In other cases like Hosted Microsoft Exchange, this value represents the price for multiple units subscribed concurrently. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the price for registering a .org name, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETRETAILPRICE& uid=resellid&pw=resellpw&ProductType=10&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <productprice> <price>29.95</price> <productenabled>True</productenabled> </productprice> <Command>PE_GETRETAILPRICE</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

431

1999-2008 eNom, Inc.

API commands: PE_GetRetailPrice

Related commands
CommissionAccount GetBalance PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRocketPrice PE_SetPricing

12/1/08

432

1999-2008 eNom, Inc.

API commands: PE_GetRetailPricing

PE_GetRetailPricing
Description
Definition
Retrieve the retail prices that this account charges for all products, and their enabled status. Retail prices apply to retail customers of this account. They also apply to any subaccounts in which the prices the subaccount pays have not been set for that individual subaccount using a command such as UpdateAccountPricing, GetSubAccountDetails, or PE_SetPricing.

Usage
Use this command to display the full list of retail prices for this 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.
http://resellertest.enom.com/myaccount/Settings.asp

On the my enom > settings page, the Default Account/Sub-Account Pricing section displays the query results for PE_GetRetailPricing.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW TLDOnly Required Required Optional; default is 0 Optional; default value is 1 Optional Account login ID Account password Use TLDOnly=1 if you want only domain name prices; otherwise this command returns prices for domain names and all other products and services.

Max size
20 20 20

Years

20 Beginning of year range for which to retrieve prices. Permitted values are 1, 2, 5, and 10. For example, Years=2 retrieves prices for registrations of 2 to 4 years. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

12/1/08

433

1999-2008 eNom, Inc.

API commands: PE_GetRetailPricing

Returned parameters and values

Param name Definition
TLD TLDID Top-level domain name (extension) Our ID number for this TLD

12/1/08

434

1999-2008 eNom, Inc.

API commands: PE_GetRetailPricing

Param name Definition

ProductType Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal 435

12/1/08

1999-2008 eNom, Inc.

API commands: PE_GetRetailPricing

Param name Definition

Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the prices that account resellid is charging for all products, and whether the products are enabled. It also requests the response in XML format:
http://resellertest.enom.com/interface.asp?uid=resellid&pw=resellpw& command=PE_GetRetailPricing&responsetype=xml

The response lists the prices for all products, and tells whether they are offered in this account:
<?xml version="1.0" ?> <interface-response> <pricestructure> <tld> <tld>com</tld> <tldid>0</tldid> <minimumregistration>1</minimumregistration> <registerprice>29.95</registerprice> <registerenabled>True</registerenabled> <renewprice>29.95</renewprice> <renewenabled>True</renewenabled> <transferprice>29.95</transferprice> <transferenabled>True</transferenabled> </tld> <tld> <tld>net</tld> <tldid>1</tldid> <minimumregistration>1</minimumregistration> <registerprice>29.95</registerprice> <registerenabled>True</registerenabled> <renewprice>29.95</renewprice> <renewenabled>True</renewenabled> <transferprice>29.95</transferprice> <transferenabled>True</transferenabled> </tld> . . . <product> <price>29.95</price> <productenabled>True</productenabled> <producttype>45</producttype> </product>

12/1/08

436

1999-2008 eNom, Inc.

API commands: PE_GetRetailPricing

<product> <price>29.95</price> <productenabled>True</productenabled> <producttype>47</producttype> </product> </pricestructure> <Command>PE_GETRETAILPRICING</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRocketPrice PE_SetPricing UpdateAccountPricing

12/1/08

437

1999-2008 eNom, Inc.

API commands: PE_GetRocketPrice

PE_GetRocketPrice
Description
Definition
Get the pricing and enabled state for a Registry Rocket key.

Usage
Use this command to get the price for one product, for one top-level domain. For example, you can use this command to retrieve the price for renewing a .org name. This command is most useful to resellers who offer a restricted set of top-level domains.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/CCProcessingSignUp.asp

This command is not implemented on enom.com. However, on the registry rocket page, the create link button returns similar information.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW TLD ProductType Required Required Required Required Account login ID Account password Top-level domain (extension, e.g. com) for which you want information. Product type. Options are: 10 register 13 hosting 14 host renew 16 renew 19 transfer Unique key created for each Registry Rocket site. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 15 3

ResellerKey ResponseType

Required Optional

40 4

12/1/08

438

1999-2008 eNom, Inc.

API commands: PE_GetRocketPrice

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. Product types are: 10=register, 13=hosting, 14=hosting renew, 16=renew, 19=transfer.

Example
The following query requests the Registry Rocket price for .org domain names, with response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GetRocketPrice& uid=resellid&pw=resellpw&tld=org&ProductType=10&responsetype=xml

The response indicates that the price for .org names is $29.95 per year, and sales of .org are enabled:
<?xml version="1.0" ?> <interface-response> <productprice> <price>29.95</price> <productenabled>True</productenabled> </productprice> <Command>PE_GETROCKETPRICE</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CommissionAccount GetBalance GetWebHostingAll PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_SetPricing

12/1/08

439

1999-2008 eNom, Inc.

API commands: PE_GetTLDID

PE_GetTLDID
Description
Definition
Retrieve the ID number for a TLD.

Usage
Use this command to retrieve the ID number for a TLD.

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.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW TLD ResponseType Required Required Required Optional

Definition
Account login ID Account password Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 15 4

Returned parameters and values

Param name Definition
TLDID Command ErrCount Err(x) Done ID number for the TLD specified in the query string. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

440

1999-2008 eNom, Inc.

API commands: PE_GetTLDID

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
The following query requests the ID number for the .org TLD, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_GETTLDID& uid=resellid&pw=resellpw&tld=org&responsetype=xml

In the response, a value for the TLDID parameter confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <productid> <tldid>2</tldid> </productid> <Command>PE_GETTLDID</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+07.00</TimeDifference> <ExecTime>0.1015625</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PE_SetPricing SetResellerTLDPricing

12/1/08

441

1999-2008 eNom, Inc.

API commands: PE_SetPricing

PE_SetPricing
Description
Definition
Set retail prices that this account charges for all products, or set the wholesale price for a single product for a single subaccount.

Usage
Use this command to set retail pricing for all products that this account offers. You can also set the wholesale price for a single product for a single subaccount.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/renewalpricing.asp

On the my enom > settings page, scroll to the Default Account/Sub-Account Pricing section and click change. You can use PE_SetPricing to set the price of any or all products.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW TLD Required Required Required for ProductType 10, 13, 14, 16, 19 If setting subaccount prices, either PartyID or LoginID is Required

Definition
Account login ID Account password Top-level domain name (extension) to set pricing for

Max size
20 20 15

PartyID

Party ID of the subaccount to set pricing for

40

12/1/08

442

1999-2008 eNom, Inc.

API commands: PE_SetPricing

Param name Obligation

LoginID If setting subaccount prices, either PartyID or LoginID is Required Optional; default is 1

Definition
Login ID of the subaccount to set pricing for

Max size
20

Years

Year-bracket to set prices for. For example, Years=2 sets 2 the annual price for domain name registrations of 2 to 4 years; Years=5 sets the annual price for 5 to 9 years. Permitted values are 1, 2, 5, and 10. You can use only one Years parameter per query.

12/1/08

443

1999-2008 eNom, Inc.

API commands: PE_SetPricing

Param name Obligation

ProductTypeX X=1, 2, 3, . . . Required

Definition
Product type. Permitted values are: 10 Domain registration 13 DNS hosting 14 DNS hosting renew 16 Domain renewal 17 Domain redemption grace period (RGP) 18 Domain Extended RGP (available at our discretion, and decided by us on a name-by-name basis) 19 transfer 20 SSL certificate - GeoTrust QuickSSL Premium 21 SSL certificate - GeoTrust True BusinessID 23 SSL certificate - RapidSSL 24 SSL certificate - GeoTrust True BusinessID with EV 26 SSL certificate - GeoTrust QuickSSL 27 SSL certificate - GeoTrustTrueBizID Wildcard 35 Additional storage for POP pak - renewal - 512MB/box 36 Additional storage for POP pak - 512MB per mailbox 38 POP mail 10-pak 39 POP mail 10-pak renewal 41 .name registration and email forwarding by the .name Registry 42 .name email forwarding by the .name Registry 44 .name registration and email forwarding renewal 45 Email forwarding by us 46 Email forwarding by us - renewal 47 URL forwarding 48 URL forwarding - renewal 50 Web hosting account with Access database 51 Web hosting component - 20GB bandwidth 52 Web hosting component - 1GB Web storage 53 Web hosting component - 250MB SQL database storage 54 Web hosting component - 10 POP mailboxes 55 Web hosting setup fee 56 Web hosting bandwidth overage, at per-1GB overage protection rate 57 Web hosting bandwidth overage fee, with upgrade 58 Web hosting component - 100MB POP storage 65 Private label annual subscription 66 Private label annual renewal 72 ID Protect (Whois Privacy Protection) 73 ID Protect - renewal 86 Web Site Creator without Web hosting - Basic 87 Web Site Creator without Web hosting - Full 88 Web Site Creator without Web hosting - eCommerce 90 Web Site Creator added to Web hosting - Basic 91 Web Site Creator added to Web hosting - Full 92 Web Site Creator added to Web hosting - eCommerce 111 SSL certificate - SBS Secure 112 SSL certificate - SBS Secure Plus 113 SSL certificate - SBS Instant 114 SSL certificate - SBS EV (Powered by COMODO) 115 SSL certificate - SBS SGC EV (Powered by COMODO) 125 Hosted Exchange mailbox 126 Hosted Exchange 100MB extra storage 127 Hosted Exchange BlackBerry 128 Hosted Exchange BlackBerry setup fee 129 Hosted Exchange Good Mobile Messaging (GoodLink) 130 Hosted Exchange Good Mobile Messaging setup fee 131 Hosted Exchange ActiveSync 140 Business Listing 141 Business Listing renewal

Max size
3

12/1/08

444

1999-2008 eNom, Inc.

API commands: PE_SetPricing

Param name Obligation

EnabledX X=1, 2, 3, . . . PriceX X=1, 2, 3, . . . Optional

Definition

Max size

Enable or disable the product type. Set =1 to enable or =0 1 to disable. 1000. 00

Optional; use Set the product price. Use format DD.cc when setting retail prices for this UID Optional; use when setting one wholesale price for one subaccount Optional; use when setting one retail price for this UID Optional Reseller price for this product type. If you use this parameter, you can reset the reseller price for only one product per query. If you use this parameter, use parameters ProductType and Enabled rather than ProductTypeX and EnabledX.

ResellerPrice

1000. 00

RetailPrice

Retail price for this product type. If you use this parameter, 1000. you can reset the retail price for only one product per 00 query. If you use this parameter, use parameters ProductType and Enabled rather than ProductTypeX and EnabledX. Registry Rocket price for this product type 1000. 00 40

RocketPrice ResellerKey

Required if Registry Rocket key setting a Registry Rocket price Optional Format of response. Options are Text (default), HTML, or XML.

ResponseType

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. Either LoginID or PartyID is required. If LoginID is passed in then it will override the PartyID if it is also passed in. At least one Price must be supplied.

12/1/08

445

1999-2008 eNom, Inc.

API commands: PE_SetPricing

Example
The following query requests that the retail price for registering .org names be set at $44.00 and for renewing .org names $45.00, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=PE_SetPricing& uid=resellid&pw=resellpw&ProductType1=10&TLD1=org& Enabled1=1&Price1=44&ProductType2=16&TLD2=org&Enabled2=1& Price2=45&responsetype=xml

In the response, the Status Successful and Errcount 0 confirm that the query successfully reset 2 prices:
<?xml version="1.0" ?> <interface-response> <Count>2</Count> <Status>Successful</Status> <Command>PE_SETPRICING</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AuthorizeTLD CommissionAccount GetBalance GetTLDList GetWebHostingAll PE_GetCustomerPricing PE_GetDomainPricing PE_GetPOPPrice PE_GetProductPrice PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice PE_GetTLDID RemoveTLD SetResellerServicesPricing SetResellerTLDPricing UpdateAccountPricing

12/1/08

446

1999-2008 eNom, Inc.

API commands: Preconfigure

Preconfigure
Description
Definition
Configure the extended attributes for the Active domains in a shopping cart. Most commonly, extended attributes are added for certain country codes, including .us, .ca, .co.uk, and .org.uk.

Usage
Use this command when registering domains that require extended attributes. To retrieve extended attributes, use the GetExtAttributes command. This command operates only if you use our shopping cart, and only on the domains in the cart that have status Active. If you use the Purchase command instead of our shopping cart, supply the extended attributes in the Purchase command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/PreConfigure.asp

With a configurable domain in the cart, click the configure button below the list of cart contents. On the Pre-configure page, one or more specific information boxes contain text boxes that set values for the Preconfigure command when you click save changes.

Constraints
The query must meet the following requirements: This command operates only if you use our shopping cart, and only on the domains in the cart that have status Active. The login ID and password must be valid. There must be at least one configurable domain in the cart. The extended attributes (configuration parameters) you provide in the query must match those required for the current TLD. For example, configuring a .us name requires that you provide the attributes for .us, not those for .ca.

12/1/08

447

1999-2008 eNom, Inc.

API commands: Preconfigure

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Load

Obligation
Required Required Required for .us, .ca, .co.uk, and .org.uk

Definition
Account login ID Account password 1 use the previously configured values for all preconfiguration information 2 submit new preconfiguration information (contacts, name servers, extended attributes)

Max size
20 20 1

ExtendedAttributes

Required for some country codes

varie Data required by the Registry for s some country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes. If extended attributes are required, the GetExtAttributes return supplies parameter names tagged as <Name> and permitted values tagged as <Value> Set to auto-renew? Permitted values are: 1 Set the preconfigured domains to renew automatically (recommended) 0 Set the domains to not auto-renew 1

AutoRenew

Required

RegLock

Required

Set registrar lock? Permitted values 1 are: 1 Set the preconfigured domains to registrar lock (recommended, to prevent unauthorized transfers) 0 Do not lock the domains International Domain Name code for each language used by a domain in the cart that has status Active. To retrieve the Active domains in the cart, use command GetCartContent. For a list of IDN codes, go to http:// www.enom.com/resellers/ newdocumentation.asp 3

IDNX X = 1 to NumberOfLanguages

Required for PUNYencoded names that use characters other than the English alphabet, numbers, and hyphen

PreConfigDNS

Required

7 Which name servers this domain uses: default our name servers other name servers specified in this query using the NSX parameter 63

NSX X=1 . . . 12

Required if you want Names of the name servers a to use name servers domain is using. Maximum of 12 other than ours name servers.

12/1/08

448

1999-2008 eNom, Inc.

API commands: Preconfigure

Param name
UseHostRecords

Obligation
Optional

Definition

Max size

1 Use host records provided in this query string. Permitted values are: 0 Use this accounts default host records 1 Store the host records provided in this string Name of host record X, for example, www Record type of host record X. Permitted values are: A Address CNAME Alias record type, to associate a host name with another host URL URL redirect FRAME Frame redirect MX Mail. Can be a host name under this domain name or the name of a mail server MXE Mail Easy (email forwarding) TXT Text (SPF) record 60 5

HostNameX RecordTypeX

Optional Optional

AddressX

Optional

Address to redirect to. 260 If RecordTypeX=A, AddressX must be an IP address If RecordTypeX=CNAME, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=URL, AddressX must be the exact URL of the page you redirect to, or an IP address, or a fully qualified domain name (see Note) If RecordTypeX=FRAME, AddressX is the actual URL, or the IP address, or the fully qualified domain name (see Note) of the page you want to display when someone types Your_Domain.com If RecordTypeX=MX, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=MXE, AddressX must be an IP address If RecordTypeX=TXT, AddressX is a text (SPF) record. For help writing an SPF record, go to http://spf.pobox.com/wizard.html Domain name password Domain name password. Must be identical to AccessPassword1. 50 50

AccessPassword1 AccessPassword2

Optional Optional

12/1/08

449

1999-2008 eNom, Inc.

API commands: Preconfigure

Param name
ExpressCheckout

Obligation
Either ExpressCheckout or all four OptX parameters are Required Either ExpressCheckout or all four OptX parameters are Required

Definition

Max size

1 If ExpressCheckout=1, the accounts default contacts will be applied. If ExpressCheckout=0 or is not used, supply contact information using the OptX and ContactTypeX parameters below. Permitted values are: 1 UseBilling Use the account billing contact as the Registrant contact for this domain UseRegistrant Use the account default Registrant contact as the Registrant contact for this domain UseExisting Use the Registrant contact information supplied in this query string 1 Permitted values are: UseBilling Use the account billing contact as the Technical contact for this domain UseRegistrant Use the account default Registrant contact as the Technical contact for this domain UseExisting Use the Technical contact information supplied in this query string Permitted values are: 1 UseBilling Use the account billing contact as the Administrative contact for this domain UseRegistrant Use the account default Registrant contact as the Administrative contact for this domain UseExisting Use the Administrative contact information supplied in this query string 1 Permitted values are: UseBilling Use the account billing contact as the Auxiliary Billing contact for this domain UseRegistrant Use the account default Registrant contact as the Auxiliary Billing contact for this domain UseExisting Use the Auxiliary Billing contact information supplied in this query string Name of Contacts organization. 60 ContactType can be REGISTRANT, AUXBILLING, TECH, ADMIN. Supply ContactType parameters for any contact type where you supplied OptX=UseExisting. Contacts job title Contacts first name 60 60

OptContactReg

OptTechnical

Either ExpressCheckout or all four OptX parameters are Required

OptAdministrative

Either ExpressCheckout or all four OptX parameters are Required

OptContactAux

Either ExpressCheckout or all four OptX parameters are Required

ContactTypeOrg

Optional

ContactTypeJobTitle ContactTypeFName

Optional Optional

12/1/08

450

1999-2008 eNom, Inc.

API commands: Preconfigure

Param name
ContactTypeLName ContactTypeAddress ContactTypeAddress2 ContactTypeCity ContactTypeState ContactTypeProvince ContactTypeStateProvinceChoice

Obligation
Optional Optional Optional Optional Optional Optional Optional

Definition
Contacts last name Contacts address Contacts address, second line Contacts city Contacts state Contacts province Contacts state or province choice. Use value S if Contact is located in a state; use P if a province. Contacts postal code

Max size
60 60 60 60 60 60 1

ContactTypeZip

Optional for most TLDs; Required for .org Optional Optional

16

ContactTypeCountry ContactTypePhone

Contacts country. Permitted format 60 is 2-letter country code Contacts phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Contacts phone extension Contacts fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Contacts email address Format of response. Options are Text (default), HTML, or XML. 17

ContactTypePhoneExt ContactTypeFax

Optional Optional

6 17

ContactTypeEmail ResponseType

Optional Optional

128 4

Returned parameters and values

Param name
PreConfigSuccess Count Command ErrCount Err(x) IsLockable IsRealTimeTLD Done

Definition
1 indicates no extended attributes required. 2 indicates query failed at Registry. Number of TLDs affected Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 0 indicates the domain is not lockable; 1 indicates the domain is lockable Indicates whether this is a TLD that registers in real time. 0 indicates no; 1 indicates yes. True indicates this entire response has reached you successfully.

12/1/08

451

1999-2008 eNom, Inc.

API commands: Preconfigure

Notes
A fully qualified domain name is expressed in the format hostname.SLD.TLD.. Note that the period at the end is an essential component of a fully qualified domain name. 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
The following query supplies the extended attributes for resellerdocs.us and requests the response in XML format: http://resellertest.enom.com/interface.asp?command=preconfigure&uid=resellid&pw=resellpw& sld=resellerdocs&tld=us&Load=2&us_nexus=c11&us_purpose=p3&PreConfigDNS=default& ExpressCheckout=1&responsetype=xml The response is as follows: <?xml version="1.0" ?> <interface-response> <PreConfigBillingInfo> <BillingOrganizationName>Reseller Documents Inc.</BillingOrganizationName> <BillingJobTitle>President</BillingJobTitle> <BillingFirstName>John</BillingFirstName> <BillingLastName>Doe</BillingLastName> <BillingAddress1>111 Main St.</BillingAddress1> <BillingAddress2 /> <BillingCity>Hometown</BillingCity> <BillingStateProvince>WA</BillingStateProvince> <BillingStateProvinceChoice>S</BillingStateProvinceChoice> <BillingPostalCode>99999</BillingPostalCode> <BillingCountry>United States</BillingCountry> <BillingPhone>5555555555</BillingPhone> <BillingFax>5555555556</BillingFax> <BillingEmailAddress>[email protected]</BillingEmailAddress> </PreConfigBillingInfo> <PreConfigSuccess>2</PreConfigSuccess> . . . <Command>PRECONFIGURE</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

452

1999-2008 eNom, Inc.

API commands: Preconfigure

Related commands
AddContact Contacts GetContacts GetExtAttributes GetWhoisContact

12/1/08

453

1999-2008 eNom, Inc.

API commands: PreRegAddList

PreRegAddList
Description
Definition
Add a list of names to preregister.

Usage
Use this command to reserve a domain name before a top-level domain is open for real-time registrations. For example, if a new top-level domain .store had been approved but not opened yet, registrars might establish a queue -- a time-stamped waiting list -- for domain names using the .store TLD. Domain names on this list are preregistered.

Availability
All resellers have access to this command.

Implementation on eNom.com
This feature is implemented on enom.com only during preregistration periods for new TLDs.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The preregistration queue must be open. The domain name to preregister must meet the requirements for a valid domain name (see the requirements under the Check command).

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW DomainList Price SubmitTimes ResponseType Required Required Required Required Required Optional Account login ID Account password Space-separated list of names. Price for each name. Set to 1 at all times. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 1000 8 3 4

12/1/08

454

1999-2008 eNom, Inc.

API commands: PreRegAddList

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that the domain name resellmydocs.biz be added to the preregistration queue for the .biz top-level domain, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=preregaddlist& uid=resellid&pw=resellpw& domainlist=resellmydocs.biz&price=30&submittimes=1&responsetype=xml

The response indicates that the .biz preregistration queue is closed:

<?xml version="1.0" ?> <interface-response> <Command>PREREGADDLIST</Command> <ErrCount>1</ErrCount> <errors> <Err1>The queue is now closed.</Err1> </errors> <Server>Dev</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AddBulkDomains

12/1/08

455

1999-2008 eNom, Inc.

API commands: Purchase

Purchase
Description
Definition
Purchase a domain name in real time.

Usage
The Purchase command enables direct real-time purchases. The Purchase command bypasses the shopping cart and the queuing delay associated with it. The Purchase command is typically used for a single-name purchase and returns an immediate success/failure response. Most commonly, the Purchase command is used by resellers who maintain their own databases. The Purchase command does not support Club Drop, auction, or backordered names. If you win names of these types, our system automatically generates an order and charges according to the terms set out in our auction agreement.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/Checkout.asp

The Purchase command is not implemented on www.enom.com. However, on the checkout page, the purchase button calls InsertNewOrder, a similar command that initiates checkout. The difference is that InsertNewOrder acquires contents of the shopping cart and puts them in a queue for checkout; the Purchase command bypasses the shopping cart and the queue.

Constraints
The query must meet the following requirements: The login ID and password must be valid. To use our credit card processing, this must be a reseller account directly under eNom, and must have signed a credit card agreement with us. The domain name(s) to be purchased must be valid. (See requirements under the Check command.) eNom must be licensed to sell the names you attempt to register (eNom is not licensed with the Registries for all TLDs). Name servers for .us names must be located in the United States. .co.uk and .org.uk names must have at least two name servers.

12/1/08

456

1999-2008 eNom, Inc.

API commands: Purchase

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD ExtendedAttributes

Obligation
Required Required Required Required Required for some country code TLDs Optional for PUNY-encoded names that use characters other than the English alphabet, Arabic numbers, and hyphen Either UseDNS or NSX is Required Either UseDNS or NSX is Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

Data required by the Registry for some varies country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes. International Domain Name code for 3 each language used by a domain in the cart that has status Active. To retrieve the Active domains in the cart, use command GetCartContent. For a list of IDN codes, go to http:// www.enom.com/resellers/ newdocumentation.asp Specify UseDNS=default to use our name servers (most of the services that we provide require our name servers). See Note. 7

IDNCode

UseDNS

NSX

60 Use this parameter to assign userspecified name servers. Permitted values are the use names of registered name servers, for example, NS1=ns1.name-services.com See Note. 1 1 60

UnLockRegistrar RenewName DomainPassword EmailNotify

Optional; default Set to 1 to unlock or 0 to lock the value is 0 name. Optional; default Set to 1 to renew the name value is 0 automatically before it expires. Optional; default Set a password on the domain name. value is 0

Optional; default Set to 1 to receive email notification of 1 is 0 customer orders, set to 0 or don't use it otherwise. Optional Number of years to register the name. 2

NumYears

12/1/08

457

1999-2008 eNom, Inc.

API commands: Purchase

Param name
QueueOrder

Obligation
Optional

Definition
If QueueOrder=1, register the domain at the Registry and return an order ID, then put this order in our order queue instead of processing in real time. This option reduces the risk of the order timing out when our system is under stress. This option is suitable for real-time TLDs like .com and .net but less relevant for manually processed TLDs like .de and .co.uk. The slight delay associated with this option makes it unsuitable if your processes immediately execute secondary calls like setting host recordsthey must be done after the order completes.

Max size
6

IgnoreNSFail

Optional; default Continue processing even if name is No servers cannot be applied? If IgnoreNSFail=Yes, this purchase request will succeed even if the Registry does not recognize the name servers listed in this query. If you use IgnoreNSFail=Yes and failures are returned, you should confirm the status of name servers with the Registry. Optional If UseCreditCard=yes, use our credit-card-processing services. This service is available only to resellers who have entered into a credit card processing agreement with us.

UseCreditCard

ChargeAmount

Required if using Amount to charge per year for the our credit card registration (this value will be processing multiplied by NumYears to calculate the total charge to the credit card). Required format is DD.cc Required if using End users IP address. This is used in fraud checking, as part of our order our credit card processing service. Use format processing NNN.NNN.NNN.NNN. Required if using Type of credit card our credit card processing Required if using Cardholder's name our credit card processing Required if using Customer's credit card number our credit card processing Required if using Credit card expiration month our credit card processing

EndUserIP

15

CardType

20

CCName

60

CreditCardNumber

128

CreditCardExpMonth

12/1/08

458

1999-2008 eNom, Inc.

API commands: Purchase

Param name
CreditCardExpYear

Obligation

Definition

Max size
4

Required if using Credit card expiration year our credit card processing Required if using Credit card verification code our credit card processing Required if using Credit card billing address our credit card processing Required if using Credit card billing postal code our credit card processing Required if using Credit card billing country our credit card processing Required if using Registrant first name our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Required if using Registrant last name our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Optional Registrant organization Required if Registrant job title param RegistrantOrga nizationName is used

CVV2

CCAddress

60

CCZip

15

CCCountry

60

RegistrantFirstName

60

RegistrantLastName

60

RegistrantOrganizationName RegistrantJobTitle

60 60

12/1/08

459

1999-2008 eNom, Inc.

API commands: Purchase

Param name
RegistrantAddress1

Obligation

Definition

Max size
60

Required if using Registrant Address our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Optional Registrant additional address info Required if using Registrant city our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Optional Registrant state or province choice: S state P province Registrant state or province

RegistrantAddress2 RegistrantCity

60 60

RegistrantStateProvinceChoice

RegistrantStateProvince

Optional if using our credit card processing

60

RegistrantPostalCode

Required if using Registrant postal code our credit card processing OR for .org names when you supply one of the other core Registrant attributes Required if using Registrant country, expressed as the two-character country code our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note)

16

RegistrantCountry

60

12/1/08

460

1999-2008 eNom, Inc.

API commands: Purchase

Param name
RegistrantEmailAddress

Obligation

Definition

Max size
128

Required if using Registrant email address our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Required if using our credit card processing OR if extended attributes are required OR if you supply one of the other core Registrant attributes (see Note) Required if RegistrantOrga nizationName is used Optional Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

RegistrantPhone

20

RegistrantFax

Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. ContactType first name. Replace ContactType in the parameter names with Tech, Admin or AuxBilling. Use these parameters if you want the Technical, Administrative, or Auxiliary Billing contact information to be different from the Billing contact. You can also supply or change contact information later using the Contacts API command.

20

ContactTypeFirstName

60

ContactTypeLastName

Required if you ContactType last name supply one of the other core attributes for this ContactType (see Note) Optional ContactType organization Required if you ContactType job title supply one of the other core attributes for this ContactType (see Note)

60

ContactTypeOrganizationName ContactTypeJobTitle

60 60

12/1/08

461

1999-2008 eNom, Inc.

API commands: Purchase

Param name
ContactTypeAddress1

Obligation

Definition

Max size
60

ContactType address, line 1 Required if you supply one of the other core attributes for this ContactType (see Note) Optional ContactType additional address info ContactType city Required if you supply one of the other core attributes for this ContactType (see Note) ContactType state or province choice: S state P province ContactType state or province

ContactTypeAddress2 ContactTypeCity

60 60

ContactTypeStateProvinceChoice Optional

ContactTypeStateProvince ContactTypePostalCode

Optional

60 16

Optional; ContactType postal code Required for .org names if you supply one of the other core attributes for this ContactType

ContactTypeCountry

ContactType country, expressed as the 60 Required if you supply one of the two-character country code other core attributes for this ContactType (see Note) Required if you ContactType email address supply one of the other core attributes for this ContactType (see Note) Required if you supply one of the other core attributes for this ContactType (see Note) Optional 128

ContactTypeEmailAddress

ContactTypePhone

ContactType phone. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

ContactTypeFax

ContactType fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Format of response. Options are Text (default), HTML, or XML.

20

ResponseType

Optional

12/1/08

462

1999-2008 eNom, Inc.

API commands: Purchase

Returned parameters and values

Param name Definition
OrderID RRPCode RRPText Command ErrCount Err(x) Done Order number if successful. We recommend that you store this number for future use. Success code. Only a 200 indicates success. Text which accompanies and describes the RRPCode value. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
If using our credit card option ALL registrant and credit card information is required. For most TLDs (those that dont require extended attributes), Registrant contact information is optional: if not supplied, it is inherited from the Billing contact. However, if you supply any one of the core Registrant values, you must supply them all. The core Registrant values are:
RegistrantFirstName RegistrantLastName RegistrantAddress1 RegistrantCity PostalCode (for .org names) RegistrantCountry RegistrantEmailAddress RegistrantPhone

Additional parameters for contact information can be passed by replacing Registrant in the parameter names above with Tech, Admin or AuxBilling. To set name servers to eNoms, set the UseDNS=default param and don't pass NS(x) name servers. To set name servers to your name servers, set NSX=YourNameServerX and don't pass UseDNS=default. You can set up to 12 of your own name servers. Some TLDs, including .de, require you to specify name servers. The Registry will automatically delete the domain name if no name servers are specified. 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. We recommend that you store the OrderID valueat least the most recent one for each domainfrom the return. Several other commands use this value as a required input parameter. In the return, an RRPCode of 200 indicates a successful registration. Otherwise, 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. In the return, if the RRPCode value is 1300 and the IsRealTimeTLD value is false, then this is a nonreal-time TLD. For these names, use the GetOrderDetail command roughly every 24 hours to check the progress of the registration.

12/1/08

463

1999-2008 eNom, Inc.

API commands: Purchase

Example
The following query requests the purchase of domain name resellerdocs2.net, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=Purchase& uid=resellid&pw=resellpw& sld=resellerdocs2&tld=net&RegistrantOrganizationName=Reseller%20Documents%20Inc.& RegistrantFirstName=john&RegistrantLastName=doe&RegistrantAddress1=111%20Main%20St.& RegistrantCity=Hometown&RegistrantStateProvince=WA&RegistrantStateProvinceChoice=S& RegistrantPostalCode=98003&RegistrantCountry=United+States& RegistrantEmailAddress=john%2Edoe%40resellerdocs%2Ecom&RegistrantPhone=+1.5555555555& RegistrantFax=+1.5555555556&ResponseType=XML

The response includes the three components that indicate a successful transaction: an order ID indicates success at the registrar level, and the RRPCode value of 200 and RRP text with a success message indicate success at the Registry level:
<?xml version="1.0" ?> <interface-response> <OrderID>156094996</OrderID> <RRPCode>200</RRPCode> <RRPText>Command completed successfully - 156094996</RRPText> <Command>PURCHASE</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AddBulkDomains Check InsertNewOrder PurchaseServices

12/1/08

464

1999-2008 eNom, Inc.

API commands: PurchaseHosting

PurchaseHosting
Description
Definition
Subscribe to our domain name hosting services, while leaving the registration of the domain name at another registrar. This is a real-time command.

Usage
Use this command to purchase domain name hosting services in real time, while leaving the registration of a domain name at another registrar. To purchase DNS hosting using the shopping art and order queue, use the AddToCart command.

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. To use our credit card processing, this must be an ETP reseller account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD DomainPassword NumYears Renewname ChargeAmount

Obligation
Required Required Required Required Optional Optional Optional Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Set a password on the domain name Number of years to register the name Set =1 to auto-renew the name Amount to charge per year for the registration

Max size
20 20 63 15 60 2 1 6

12/1/08

465

1999-2008 eNom, Inc.

API commands: PurchaseHosting

Param name
UseCreditCard

Obligation
Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Required if UseCreditCard =yes Optional Required if UseCreditCard =yes Required if UseCreditCard =yes

Definition

Max size

Permitted values are yes and no. The 3 credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information.

EndUserIP

End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Registrant organization Registrant first name

15

RegistrantOrganizationName RegistrantFirstName

60 60

RegistrantLastName

Registrant last name

60

RegistrantJobTitle

Registrant job title Required if RegistrantOrga nizationName is used Required if UseCreditCard =yes Optional Required if UseCreditCard =yes Required if UseCreditCard =yes Optional Registrant Address

60

RegistrantAddress1

60

RegistrantAddress2 RegistrantCity

Registrant additional address info Registrant city

60 60

RegistrantStateProvince

Registrant state or province

60

RegistrantStateProvinceChoice

Registrant state or province choice: S state P province Registrant postal code

RegistrantPostalCode

Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes

16

RegistrantCountry

Registrant country

60

RegistrantPhone

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

20

12/1/08

466

1999-2008 eNom, Inc.

API commands: PurchaseHosting

Param name
RegistrantFax

Obligation
Required if RegistrantOrga nizationName is used Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Required if UseCreditCard =yes Optional

Definition

Max size

Registrant fax numbe. Required format 20 is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant email address 128

RegistrantEmailAddress

CardType

Type of credit card

20

CCName

Cardholder's name

60

CreditCardNumber

Customer's credit card number

128

CreditCardExpMonth

Credit card expiration month

CreditCardExpYear

Credit card expiration year

CVV2

Credit card verification code

CCAddress

Credit card billing address

60

CCZip

Credit card billing postal code

15

CCCountry

Credit card billing country

60

EmailNotify

Set =1 to receive email notification for 1 orders, set =0 or omit this parameter otherwise. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

Returned parameters and values

Param name Definition
OrderID RRPCode RRPText Command ErrCount Order number if successful. Success code. Only a 200 indicates success. Text which accompanies and describes the RRPCode. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

467

1999-2008 eNom, Inc.

API commands: PurchaseHosting

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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. Additional params for contact information can be passed by replacing Registrant in the param names above with Tech, Admin or AuxBilling. If using our credit card option ALL registrant and credit card information is required.

Example
The following query orders and pays for one year of DNS hosting for the site resellerdocs.com, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=purchasehosting& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&numyears=1& RegistrantAddress1=111+Main+St.+&RegistrantCity=Hometown&RegistrantCountry=USA& [email protected]&RegistrantFirstName=John&RegistrantLastName=Doe& RegistrantPhone=+1.5555555555&RegistrantPostalCode=99999&Renewname=1& UseCreditCard=yes&EndUserIP=127.0.0.1&CreditCardNumber=4111111111111111& CreditCardExpMonth=05&CreditCardExpYear=2005&CCName=John+Doe&CardType=visa& ChargeAmount=12&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <OrderID>156062635</OrderID> <Command>PURCHASEHOSTING</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
ExtendDomainDNS DeleteHostedDomain GetHosts SetHosts

12/1/08

468

1999-2008 eNom, Inc.

API commands: PurchasePOPBundle

PurchasePOPBundle
Description
Definition Purchase, in real time, a pak of 10 POP Email accounts for the specified domain name. Usage
Use this command to purchase, in real time, a pak of 10 POP Email accounts for the specified domain name. We recommend the POP3 mail service for parties who want to be able to send mail from their domain name (instead of, for example, a yahoo or hotmail senders address), and for parties who want to manage multiple email accounts as a body (rather than having everyones email forwarded to scattered locations). After you sell a POP Email bundle, you can set up users with the SetUpPOP3User command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/POPConfig.asp?DomainNameID=152533676

On the POP3 Mail page, the add an Email Pak button calls the PurchasePOPBundle command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. To use our credit card processing, this must be an ETP reseller account. The domain name must belong to this account. This command can be used only for purchasing POP paks for reseller accounts. Retail accounts must use a queue-based shopping cart process.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD

Obligation Definition
Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com)

Max size
20 20 63

12/1/08

469

1999-2008 eNom, Inc.

API commands: PurchasePOPBundle

Param name
TLD Quantity ResponseType

Obligation Definition
Required Required Top-level domain name (extension) Number of 10-address paks.

Max size
15 10 4

Optional in all Format of response. Options are Text (default), cases HTML, or XML.

Returned parameters and values

Param name Definition
RegistrarHold OrderID BundleID BundleCount Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Identification number of the order Identification number of each POP3 10-pak Number of POP 10-paks sold in this transaction, if more than 1 Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests 1 pak of 10 POP3 mailboxes for resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=PurchasePOPBundle& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&Quantity=1&responsetype=xml

In the response, the return of an orderid value and a bundleid value confirm a successful query:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <orderid>156133590</orderid> <bundleid>5134</bundleid> <Command>PURCHASEPOPBUNDLE</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

470

1999-2008 eNom, Inc.

API commands: PurchasePOPBundle

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 GetPOPExpirations GetPOPForwarding ModifyPOP3 PurchaseHosting PurchaseServices RenewPOPBundle SetDotNameForwarding SetPOPForwarding SetUpPOP3User

12/1/08

471

1999-2008 eNom, Inc.

API commands: PurchasePreview

PurchasePreview
Description
Definition
Preview a shopping cart order.

Usage
Use this command to view the items that will be purchased if you check out now.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/Cart.asp

On the cart page, the checkout button calls the PurchasePreview command. It creates the list of items on the checkout page.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW ResponseType Required Required Optional Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
ItemID Description Years NameID Shopping cart item ID, from our internal records Description of shopping cart item Number of time units customer wants to subscribe Domain name ID, from our internal records

12/1/08

472

1999-2008 eNom, Inc.

API commands: PurchasePreview

Param name Definition

Name StatusID ItemPrice ExtPrice NeedsConfig ProductType FreeTrial ParentItemID ICANNFees BasePrice Command ErrCount Err(x) Done Name the customer has requested for this item Status ID Price for one unit of this item ItemPrice multiplied by Years (number of time units) Flag that marks domains requiring pre-configuration Product type ID number, from our internal records Is this product being offered as a free trial? Parent item ID number, from our internal records Fees charged by ICANN for this product Price of this product before the ICANN fee Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following requests a preview of account resellid and an inventory of its shopping cart, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=purchasepreview& uid=resellid&pw=resellpw&responsetype=xml

The response gives some general information about the account, plus the current contents of the shopping cart:
<?xml version="1.0" ?> <interface-response> <Purchase-Summary> <Reseller>True</Reseller> <Balance>3627.65</Balance> <AvailableBalance>3587.85</AvailableBalance> <DomainCount>1</DomainCount> <DotComPrice>8.95</DotComPrice> <DotNetPrice>8.95</DotNetPrice> <DotOrgPrice>8.95</DotOrgPrice> <DotCcPrice>24.95</DotCcPrice> <DotTvPrice>39.95</DotTvPrice> <CartItem> <ItemID>365635</ItemID> <Description>Register</Description> <Years>2</Years> <NameID>152534050</NameID> <Name>resellerdocs.com</Name> <StatusID>A</StatusID> <ItemPrice>8.95</ItemPrice>

12/1/08

473

1999-2008 eNom, Inc.

API commands: PurchasePreview

<ExtPrice>20.00</ExtPrice> <NeedsConfig /> </CartItem> <TotalPrice>20.00</TotalPrice> </Purchase-Summary> <Command>PURCHASEPREVIEW</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AddBulkDomains AddToCart DeleteFromCart GetCartContent InsertNewOrder UpdateCart

12/1/08

474

1999-2008 eNom, Inc.

API commands: PurchaseServices

PurchaseServices
Description
Definition
Purchase, in real time, ID Protect, SSL certificates, POP Email, Web Site Creator, Web hosting, or DNS hosting, services. The PurchaseServices command allows you to purchase one service each time you run the query.

Usage
Use this command to puchase one value-added service in real time, as opposed to going through a shopping cart and our order queue. Most commonly, real-time commands are used by resellers who maintain their own databases. Our credit card services are available for ID Protect and DNS hosting.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/Checkout.asp

The PurchaseServices command is not implemented on www.enom.com. However, on the checkout page, the purchase button calls InsertNewOrder, a similar command that initiates checkout for all selected items in the cart. The difference is that InsertNewOrder acquires contents of the shopping cart and puts them in a queue for checkout; the PurchaseServices command bypasses the queue and purchases a single item.

Constraints
The query must meet the following requirements: The login ID and password must be valid. Some products are available to only some TLDs. For example, ID Protect is not available for .us; Business Listing is available only for .com, .net, and .tv. To use our credit card processing (available only for ID Protect and DNS hosting in the PurchaseServices suite of products), this must be an ETP reseller account that has signed a credit card agreement with us.

Input parameters
Click a link in the table below to go directly to a specific product:

Product
Input parameters for ID Protect Input parameters for SSL Certificates Input parameters for Business Listing Input parameters for POP Email

12/1/08

475

1999-2008 eNom, Inc.

API commands: PurchaseServices

Product
Input parameters for Web Site Creator Input parameters for Web hosting Input parameters for DNS hosting

Input parameters for ID Protect

The table below lists input parameters for ID Protect. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service SLD TLD NumYears

Obligation
Required Required Required Required for WPPS Required for WPPS Optional for WPPS; default is 1 Optional for WPPS; default is 0 Optional; default is 0

Definition
Account login ID Account password Permitted value for ID Protect is WPPS Second-level domain name (for example, enom in enom.com). Top-level domain name (extension). Number of years to subscribe to ID Protect. Permitted values are 1 to 10. Use RenewName=1 to automatically renew ID Protect 30 days before it expires Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command.

Max size
20 20 15 63 15 2

RenewName

EmailNotify

UseCreditCard

Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Available for WPPS. Required for our credit card processing Required for our CC processing

Permitted values are yes and no. 3 The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information.

EndUserIP

End users IP address. This is used in 15 fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Amount to charge for each year; 6 ChargeAmount will be multiplied by NumYears. Required format is DD.cc

ChargeAmount

12/1/08

476

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
CardType

Obligation
Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing, if printed on the card Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing

Definition
Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Credit card number Expiration month of the credit card, in format MM Expiration year of the credit card, in format YYYY Credit card verification value

Max size
20

CreditCardNumber CreditCardExpMonth CreditCardExpYear CVV2

128 2 4 4

CCName CCAddress CCZip CCPhone

Cardholders name Credit card billing street address Credit card billing postal code Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant first name Registrant last name First line of Registrant address Second line of Registrant address Registrant city Registrant state or province, if applicable Is the RegistrantStateProvince value a state or a province? Permitted values are S for state, P for province. Registrant postal code Registrant country. Two-letter country code is a permitted format.

60 60 60 20

RegistrantFirstName RegistrantLastName RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantStateProvince RegistrantStateProvinceChoice

Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Required for our CC processing Optional for our CC processing Optional for our CC processing

60 60 60 60 60 60 60

RegistrantPostalCode RegistrantCountry RegistrantPhone

Required for our CC processing Required for our CC processing Required for our CC processing

16 60

Registrant phone. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant phone extension 60

RegistrantPhoneExt

Optional for our CC processing

12/1/08

477

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
RegistrantFax

Obligation
Optional for our CC processing

Definition
Registrant fax. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant email address

Max size
60

RegistrantEmailAddress ResponseType

Required for our CC processing

128 4

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Input parameters for SSL Certificates

The table below lists input parameters for SSL certificates. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service

Obligation
Required Required Required

Definition
Account login ID Account password Service to purchase. Permitted values for certs are: Certificate-GeoTrust-QuickSSL Certificate-GeoTrust-QuickSSL-Premium Certificate-GeoTrust-TrueBizID Certificate-GeoTrust-TrueBizID-Wildcard Certificate-GeoTrust-TrueBizID-EV Certificate-RapidSSL-RapidSSL Certificate-SBS-Instant Certificate-SBS-Secure Certificate-SBS-Secure-Plus Certificate-SBS-EV Certificate-SBS-SGC-EV Number of years to subscribe to this cert. Permitted values are 1 to 10.

Max size
20 20 15

NumYears ResponseType

Optional for certs; default is 1

2 4

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Input parameters for Business Listing

The table below lists input parameters for Business Listing.

12/1/08

478

1999-2008 eNom, Inc.

API commands: PurchaseServices

Build the query string using this syntax:

http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service SLD TLD

Obligation
Required Required Required Required for BusListing Required for BusListing

Definition
Account login ID Account password Permitted value for Business Listing is BusListing Second-level domain name (for example, enom in enom.com). Top-level domain name (extension). Permitted values for BusListing are com, net, and tv

Max size
20 20 15 63 15

NumYears

Number of years to subscribe to ID Optional for BusListing; default Protect. Permitted values are 1 to 10. is 1 Optional for Use RenewName=1 to BusListing; default automatically renew Business Listing is 0 30 days before it expires Optional; default is 0 Permitted values are 0 and 1. 1 sends you an email confirmation when a customer makes a purchase using this command.

RenewName

EmailNotify

UseCreditCard

Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Available for BusListing. Required for our credit card processing Required for our CC processing

Permitted values are yes and no. 3 The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information.

EndUserIP

End users IP address. This is used in 15 fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Amount to charge for each year; 6 ChargeAmount will be multiplied by NumYears. Required format is DD.cc Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Credit card number Expiration month of the credit card, in format MM 20

ChargeAmount

CardType

Required for our CC processing Required for our CC processing Required for our CC processing

CreditCardNumber CreditCardExpMonth

128 2

12/1/08

479

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
CreditCardExpYear CVV2

Obligation
Required for our CC processing Required for our CC processing, if printed on the card Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing

Definition
Expiration year of the credit card, in format YYYY Credit card verification value

Max size
4 4

CCName CCAddress CCZip CCPhone

Cardholders name Credit card billing street address Credit card billing postal code Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant first name Registrant last name First line of Registrant address Second line of Registrant address Registrant city Registrant state or province, if applicable Is the RegistrantStateProvince value a state or a province? Permitted values are S for state, P for province. Registrant postal code Registrant country. Two-letter country code is a permitted format.

60 60 60 20

RegistrantFirstName RegistrantLastName RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantStateProvince RegistrantStateProvinceChoice

Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Required for our CC processing Optional for our CC processing Optional for our CC processing

60 60 60 60 60 60 60

RegistrantPostalCode RegistrantCountry RegistrantPhone

Required for our CC processing Required for our CC processing Required for our CC processing

16 60

Registrant phone. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant phone extension Registrant fax. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant email address 60 60

RegistrantPhoneExt RegistrantFax

Optional for our CC processing Optional for our CC processing

RegistrantEmailAddress ResponseType

Required for our CC processing

128 4

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

12/1/08

480

1999-2008 eNom, Inc.

API commands: PurchaseServices

Input parameters for POP Email

The table below lists input parameters for POP Email. Using the PurchaseServices command, you can purchase POP Email for 1 year. You can renew in real time using the RenewPOPBundle command, or set auto-renew preferences with the SetPakRenew or SetRenew commands. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service SLD TLD Quantity EmailNotify

Obligation
Required Required Required Required for POP3 Required for POP3 Required for POP3 Optional; default is 0

Definition
Account login ID Account password Type of service to purchase. For POP Email, Service=POP3. Second-level domain name (for example, enom in enom.com). Top-level domain name (extension). For POP3, number of 10-address POP paks.

Max size
20 20 15 63 15 10

Permitted values are 0 and 1. 1 sends you an 3 email confirmation when a customer makes a purchase using this command. 4

ResponseType

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Input parameters for Web Site Creator

The table below lists input parameters for Web Site Creator (WSC). Using the PurchaseServices command, you can subscribe to WSC with a monthly billing cycle. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service

Obligation
Required Required Required

Definition
Account login ID Account password Type of service to purchase. For WSC, use Service=LWSCBasic, LWSCFull, or LWSCECom. Second-level domain name (for example, enom in enom.com). For LWSC*, this is the domain WSC will be associated with.

Max size
20 20 15

SLD

Required for LWSCBasic, LWSCFull, and LWSCECom

63

12/1/08

481

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
TLD

Obligation
Required for LWSCBasic, LWSCFull, and LWSCECom Optional; default is 0

Definition
Top-level domain name (extension). For LWSC*, this is the domain WSC will be associated with.

Max size
15

EmailNotify

Permitted values are 0 and 1. 1 sends you an 3 email confirmation when a customer makes a purchase using this command. 4

ResponseType

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Input parameters for Web hosting

The table below lists input parameters for Web hosting. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service SLD

Obligation
Required Required Required Optional for WebHosting

Definition
Account login ID Account password

Max size
20 20

Type of service to purchase. For Web hosting, 15 use Service=WebHosting Second-level domain name (for example, enom in enom.com). For WebHosting, this is the domain the Web hosting package will be associated with. Top-level domain name (extension). For WebHosting, this is the domain the Web hosting package will be associated with. 63

TLD

Optional for WebHosting Required for WebHosting

15

HostAccount

Name for this Web hosting account. Permitted 14 values are 6 to 14 characters in length, begin with a letter, and the remaining characters are alphanumeric. Password for this Web hosting account; must be alphanumeric and 6 to 14 characters in length. First and last name of the contact person for this Web hosting account, for example, John Doe Email address for communications from us regarding this Web hosting account, for example, [email protected] Package name. To retrieve currently defined packages, use the WebHostGetPackages command from the Web hosting API catalog. 14

HostPassword

Required for WebHosting Required for WebHosting Optional for WebHosting Required for WebHosting

FullName

44

HostAccountEmail

78

Package

11

12/1/08

482

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
OverageOption

Obligation
Required for WebHosting

Definition
Your instructions for how we should handle bandwidth overages, measured on a permonth basis. Permitted values are: 1 Upgrade to the next bandwidth package 2 Charge on a per-GB basis on my next monthly bill 3 Disable the account until the beginning of the next monthly billing cycle

Max size
1

EmailNotify

Optional; default is 0

Permitted values are 0 and 1. 1 sends you an 3 email confirmation when a customer makes a purchase using this command. 4

ResponseType

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Input parameters for DNS hosting

The table below lists input parameters for DNS hosting. Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service NumYears SLD TLD DomainPassword RenewName RegistrantLastName RegistrantAddress1 RegistrantPostalCode

Obligation
Required Required Required Required for DNSHosting Required for DNSHosting Required for DNSHosting Optional for DNSHosting Optional for DNSHosting Required for DNSHosting Required for DNSHosting Required for DNSHosting

Definition
Account login ID Account password

Max size
20 20

Type of service to purchase. For DNS hosting, 15 use Service=DNSHosting. Number of years to subscribe to this service. Permitted values are 1 to 10. Second-level domain name (for example, enom in enom.com). Top-level domain name (extension). Set a password on the domain name Set to 1 to auto-renew the name Registrant last name First line of Registrant address Registrant postal code Registrant email address 2 63 15 60 1 60 60 16 128

RegistrantEmailAddress Required for DNSHosting EmailNotify Optional; default is 0

Permitted values are 0 and 1. 1 sends you an 3 email confirmation when a customer makes a purchase using this command.

12/1/08

483

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
UseCreditCard

Obligation
Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Credit card processing is available for DNSHosting. Required for our credit card processing Required for our CC processing

Definition
Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information.

Max size
3

EndUserIP

End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Amount to charge for each year of DNS hosting; ChargeAmount will by multiplied by NumYears to yield the total charge for this order. Required format is DD.cc Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Credit card number

15

ChargeAmount

CardType CreditCardNumber CreditCardExpMonth CreditCardExpYear CVV2

Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing, if printed on the card Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing

20 128

Expiration month of the credit card, in format 2 MM Expiration year of the credit card, in format YYYY Credit card verification value 4 4

CCName CCAddress CCZip CCPhone

Cardholders name Credit card billing street address Credit card billing postal code Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant first name Second line of Registrant address Registrant city

60 60 60 20

RegistrantFirstName RegistrantAddress2 RegistrantCity

Required for our CC processing Optional for our CC processing Required for our CC processing

60 60 60

12/1/08

484

1999-2008 eNom, Inc.

API commands: PurchaseServices

Param name
RegistrantCountry RegistrantPhone

Obligation
Required for our CC processing Required for our CC processing

Definition

Max size

Registrant country. Two-letter country code is 60 a permitted format. Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. 20

ResponseType

Optional in all cases Format of response. Options are Text (default), HTML, or XML.

Returned parameters and values

Param name
CCTransResult BundleID BundleCount LWSCHostAccount LWSCUpgrade SetBilling PackageID ServerIP Successful OrderID Command ErrCount Err(x) Done

Definition
Credit card preauthorization result; included when using our credit card processing for Service=WPPS, BusListing, or DNSHosting Our identification number for this POP pak; included for Service=POP3 Total number of POP paks purchased with this query; included for Service=POP3 WSC account name; included for Service=LWSC* Success status for adding WSC to this domain; included for Service=LWSC* Success status for setting up monthly billing for this WSC account; included for Service=LWSC* Web hosting package ID number assigned by us; included for Service=WebHosting IP of the Web hosting server for this Web hosting account; included for Service=WebHosting Success status of this query; included for Service=WebHosting Order ID number Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

485

1999-2008 eNom, Inc.

API commands: PurchaseServices

Example
The following query adds three POP mail paks to domain resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=PURCHASESERVICES& uid=resellid&pw=resellpw&Service=POP3&sld=resellerdocs&tld=com& Quantity=3&responsetype=xml

In the response, the presence of an OrderID and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <orderid>156272481</orderid> <Bundles> <BundleID>8069</BundleID> <BundleID>8070</BundleID> <BundleID>8071</BundleID> </Bundles> <BundleCount>3</BundleCount> <Command>PURCHASESERVICES</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.5429688</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
Forwarding GetHomeDomainList Purchase PurchaseHosting PurchasePOPBundle RenewServices SetHosts

12/1/08

486

1999-2008 eNom, Inc.

API commands: PushDomain

PushDomain
Description
Definition
Push a domain name into another account.

Usage
Use this command to transfer a domain name from one eNom account to another.

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/Push.asp?DomainNameID=152533676

On the push a domain page, the submit button calls the PushDomain 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. The account to which the domain name is being pushed must be under eNom or one of its resellers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD AccountID PushContact Required Required Required Required Required Optional; default is 1 Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Login ID of the account to push the name into. Use GetSubAccounts to list subaccounts. Push the contact information for this domain from the old account to the new account? Permitted values are: 0 Do not push contact information with the domain 1 Push contact information with the domain Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 16 16

ResponseType

Optional

12/1/08

487

1999-2008 eNom, Inc.

API commands: PushDomain

Returned parameters and values

Param name
RegistrarHold PushDomain Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Returns =1 if successful or =0 if it fails Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that the domain name resellerdocs2.net be pushed from account resellid to account olerud, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=pushdomain& uid=resellid&pw=resellpw&sld=resellerdocs2&tld=net&accountid=olerud&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Push> <domainname sld="resellerdocs2" tld="net" id="152533887"> resellerdocs2.net </domainname> <PushDomain>1</PushDomain> </Push> <Command>PUSHDOMAIN</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

488

1999-2008 eNom, Inc.

API commands: PushDomain

Related commands
TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

489

1999-2008 eNom, Inc.

API commands: RefillAccount

RefillAccount
Description
Definition
Add funds to your account using a credit card.

Usage
To add funds to your account, set parameter Debit=True and include the credit card parameters. To remove your credit card information from our database, set parameter Debit=True and omit the credit card parameters. To retrieve your account balance without adding funds, and to retrieve the current credit card information for the account, set parameter Debit=False.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com using Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/RefillAccount.asp

At the bottom of the Credit Card section, the submit button calls the RefillAccount command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The account must be a reseller account.

12/1/08

490

1999-2008 eNom, Inc.

API commands: RefillAccount

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Debit

Obligation
Required Required Required

Definition
Account login ID Account password

Max size
20 20

Debit the credit card; options are True or 1 False. Debit=True uses the credit card in this query string for this transaction, and replaces the credit card information for the account record with the values in this query string. Debit=False retrieves your account balance without changing it, and without charging your credit card; it also retrieves the current credit card information for the account. End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. 15

EndUserIP

Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Required to add funds to this account Optional

CCAmount

Amount to charge to credit card, in DD.cc Min format. We charge a 3% convenience fee which $100 is deducted immediately from the CCAmount. Credit card type. Options are AmEx, Discover, 10 MasterCard, Visa. Credit card holders name as imprinted on the credit card 16-digit credit card number Month in which credit card expires, in MM format Year in which credit card expires, in YYYY format Credit card security verification code, 3- or 4digit number from the back of the credit card Street address as shown on credit card bill City as shown on credit card bill State or province as shown on credit card bill 60 16 2 4 4 60 60 60

CCType CCName CCNumber CCMonth CCYear CVV2 CCAddress CCCity

CCStateProvince Required to add funds to this account CCZip CCCountry Required to add funds to this account Required to add funds to this account

Zip code or postal code as shown on credit card 16 bill Country of credit card billing address, expressed as 2-character country code 2

12/1/08

491

1999-2008 eNom, Inc.

API commands: RefillAccount

Param name
CCPhone

Obligation
Required to add funds to this account

Definition
Phone number as shown on credit card bill. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Send email confirmation to the billing contact for this account. 0 or No turns off the email; any other value or omitting this parameter sends the email. Format of response. Options are Text (default), HTML, or XML.

Max size
20

SendMail

Optional

ResponseType

Optional

Returned parameters and values

Param name
Reseller CCTRANSRESULT ResellerRefill CreditCardStatus Command ErrCount Err(x) Done

Definition
1 indicates that this is a reseller account Result of the credit card transaction Success status of the account refill Success status of the credit card transaction Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query adds $100.00 to the account balance for resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=REFILLACCOUNT& uid=resellid&pw=resellpw&CCAmount=100&CCType=MasterCard& CCName=JohnDoe&CCNumber=5215521552155215&CCMonth=02&CCYear=2009& cvv2=200&ccaddress=100+Main+St.&CCStateProvince=WA&cczip=99999& debit=true&CCCountry=us&CCPhone=+1.5555559999&ResponseType=xml

In the response, the values for CCTRANSRESULT, ResellerRefill, CreditCardStatus, and ErrCount confirm that the refill was successful:
<?xml version="1.0" ?> <interface-response> <CurrentDate>Wednesday, August 20, 2007</CurrentDate> <RefillAccount> <FName>John</FName>

12/1/08

492

1999-2008 eNom, Inc.

API commands: RefillAccount

<LName>Doe</LName> <Reseller>1</Reseller> <CCTRANSRESULT>APPROVED</CCTRANSRESULT> <ResellerRefill>Transactions processed successfully.</ResellerRefill> <CreditCardStatus>Successful</CreditCardStatus> <CCYear>2004</CCYear> <CCMonth>2</CCMonth> <CCNumber>************5215</CCNumber> <CCName>JohnDoe</CCName> <PaymentType>MasterCard</PaymentType> <CCAddress>100 Main St.</CCAddress> <CCCity>Hometown</CCCity> <CCStateProvince>WA</CCStateProvince> <CCCountry>us</CCCountry> <CCPhoneDial /> <CCPhone>5555559999</CCPhone> <CCZip>99999</CCZip> </RefillAccount> <Command>REFILLACCOUNT</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetBalance GetTransHistory UpdateNotificationAmount

12/1/08

493

1999-2008 eNom, Inc.

API commands: RegisterNameServer

RegisterNameServer
Description
Definition
Register a domain name server.

Usage
Use this command to register one of your own servers as a domain name server.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/RegNameServer.asp

On the register a name server page, the submit button calls the RegisterNameServer command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The server you register must use a domain name that is in your account. eNom must be licensed with the Registry in which you want to register a name server; you can only register name servers for TLDs that we support. The registrar lock for the domain must be set to off while you register a name server. You can switch the registrar lock back on (and we recommend that you do so) once the name server is registered. Name servers for .us names must be located in the United States. .co.uk and .org.uk names must have at least two name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW Add Required Required Required Account login ID Account password

Max size
20 20

Authority to add a name server. Set Add=true to authorize. 5

12/1/08

494

1999-2008 eNom, Inc.

API commands: RegisterNameServer

Param name Obligation Definition

NSName IP ResponseType Required Required Optional Name server to register. Use format dns1.NameServerName.com IP of the name server. Format of response. Options are Text (default), HTML, or XML.

Max size
60 15 4

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that the computer with IP address 127.0.0.1, known as ns1.nameservices.com, be registered as a name server. The query requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=registernameserver& uid=resellid&pw=resellpw&add=true&nsname=dns1.resellerdocs.com& ip=127.0.0.1&responsetype=xml

In the response, the RRP code of 200 and success message in the RRP text indicate a successful registration:
<?xml version="1.0" ?> <interface-response> <RegisterNameserver> <NS>dns1.resellerdocs.com</NS> <IP>127.0.0.1</IP> <reg-lock>1</reg-lock> <RegistrarLock>ACTIVE</RegistrarLock> <NsSuccess>1</NsSuccess> <RegistrarLock>REGISTRAR-LOCK</RegistrarLock> </RegisterNameserver> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>REGISTERNAMESERVER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug>

12/1/08

495

1999-2008 eNom, Inc.

API commands: RegisterNameServer

<![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting UpdateNameServer

12/1/08

496

1999-2008 eNom, Inc.

API commands: RemoveTLD

RemoveTLD
Description
Definition
Remove TLDs from your list of authorized TLDs that you offer to your resellers and retail customers. Or, revert to our default list, which includes all TLDs that we support.

Usage
Use this command to remove TLDs from your custom list of authorized TLDs that you offer to your resellers and retail customers. This command controls the list of TLDs we send you for registrations, renewals, and transfers. This command does not function unless you have previously used the AuthorizeTLD command to authorize TLDs. It will not remove TLDs if your account is using our default list. If you run RemoveTLD with one TLD, our system starts with your current list, removes the single TLD, and leaves the rest. If you remove all TLDs from your list of authorized TLDs, your account will revert to our default list (all TLDs that we support).

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/RenewalPricing.asp?tab=1

If you remove TLDs from your authorized list, refreshing this page will reflect the change.

Constraints
The query must meet the following requirements: The login ID and password must be valid. You can only remove TLDs that you added using the AuthorizeTLD command.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

497

1999-2008 eNom, Inc.

API commands: RemoveTLD

Param name Obligation

TLD Either TLD or DomainList is Required Either TLD or DomainList is Required Optional

Definition
One top-level domain (TLD) to remove from your list of authorized TLDs. For example, if you want to remove .biz, use TLD=biz Comma-separated list of TLDs to remove from your list of authorized TLDs. For example, if you want to remove .com, .net, and .org, use DomainList=com,net,org Format of response. Options are Text (default), HTML, or XML.

Max size
15

DomainList

100

ResponseType

Returned parameters and values

Param name Definition
DeleteTLDX Command ErrCount Err(x) Done List of TLDs to remove from the list of TLDs authorized for this account. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query removes TLDs .us and .ca from resellids list of authorized TLDs, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=removetld& uid=resellid&pw=resellpw&domainlist=us,ca&responsetype=xml

In the response, the list of TLDs and the ErrCount value of 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <tldlist> <deletetld>us</deletetld> <deletetld>ca</deletetld> </tldlist> <Command>REMOVETLD</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site>

12/1/08

498

1999-2008 eNom, Inc.

API commands: RemoveTLD

<IsLockable /> <IsRealTimeTLD /> <ExecTime>1.191406</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
AuthorizeTLD GetTLDList PE_SetPricing SetResellerTLDPricing

12/1/08

499

1999-2008 eNom, Inc.

API commands: RemoveUnsyncedDomains

RemoveUnsyncedDomains
Description
Definition
Remove out-of-sync domains from a specified Magic Folder, or from all Magic Folders in the account.

Usage
Use this command to remove out-of-sync domains from a specified Magic Folder, or from all Magic Folders in the 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.
http://resellertest.enom.com/domains/folder-control-panel/default.asp?FolderName=AAAaa

The Remove Names button calls the RemoveUnsyncedDomains 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW FolderName Required Required Optional; default is all folders in account Optional

Definition
Account login ID Account password

Max size
20 20

Folder from which to remove unsynced domains. If no 125 FolderName is supplied, all unsynced domains in all Magic Folders are removed. Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

12/1/08

500

1999-2008 eNom, Inc.

API commands: RemoveUnsyncedDomains

Returned parameters and values

Param name Definition
Result Result of processing this query. Possible return values are: 1 Success 2 Failure Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query removes out-of-sync domains from one folder, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=RemoveUnsyncedDomains& uid=resellid&pw=resellpw&FolderName=Master-Magic&responsetype=XML

In the response, a Result value 1 indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <RemoveResult> <Result>1</Result> </RemoveResult> <Command>REMOVEUNSYNCEDDOMAINS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.125</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

12/1/08

501

1999-2008 eNom, Inc.

API commands: RemoveUnsyncedDomains

Related commands
AddDomainFolder AdvancedDomainSearch AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList UpdateDomainFolder

12/1/08

502

1999-2008 eNom, Inc.

API commands: RenewPOPBundle

RenewPOPBundle
Description
Definition
Renew the annual subscription on a POP mail 10-pak in real time.

Usage
Use this command to renew, in real time, the annual subscription on a POP mail 10-pak.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/POPConfig.asp?DomainNameID=152533676

The add years button behaves similarly to the RenewPOPBundle 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. This command is available for reseller accounts only. Retail accounts must use the queue-based shopping cart process to renew POP bundles.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD PakID

Obligation
Required Required Required Required Required

Definition
Account login ID. Must be a reseller account. Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) ID number of this POP pak. You can retrieve the ID numbers of all POP paks in the account with the GetPOPExpirations command. Number of years to renew this POP pak subscription

Max size
20 20 63 15 10

Quantity

Required

12/1/08

503

1999-2008 eNom, Inc.

API commands: RenewPOPBundle

Param name
UseCreditCard

Obligation
Optional overall, but Required for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string Required for our credit card processing Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing

Definition

Max size

Permitted values are yes and no. The credit card 3 supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted or if UseCreditCard=no, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the Registrant contact and credit card information.

EndUserIP

15 End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Registrant first name 60

RegistrantFirstName

RegistrantLastName

Registrant last name

60

RegistrantAddress1

First line of Registrant address

60

RegistrantAddress2

Second line of Registrant address

60

RegistrantCity

Registrant city

60

RegistrantCountry

Registrant country. Two-letter country code is a permitted format. Registrant postal code

60

RegistrantPostalCode

16

RegistrantPhone

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant email address

20

RegistrantEmailAddress Required for our CC processing CardType Required for our CC processing Required for our CC processing Required for our CC processing

128

Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Cardholders name

20

CCName

60

CreditCardNumber

Credit card number

128

12/1/08

504

1999-2008 eNom, Inc.

API commands: RenewPOPBundle

Param name
CreditCardExpMonth

Obligation
Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Optional

Definition

Max size

Expiration month of the credit card, in format MM 2

CreditCardExpYear

Expiration year of the credit card, in format YYYY 4

CVV2

Credit card verification code

CCAddress

Credit card billing address

60

ChargeAmount

Amount to charge this credit card. Required format is DD.cc Format of response. Options are Text (default), HTML, or XML.

ResponseType

Returned parameters and values

Param name Definition
OrderID Command ErrCount Err(x) Done Order ID for a successful renewal Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query renews POP pak 5105 for 1 year and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=renewpopbundle& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& pakid=5105&quantity=1&responsetype=xml

In the response, an OrderID value and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <orderid>156227365</orderid> <Command>RENEWPOPBUNDLE</Command>

12/1/08

505

1999-2008 eNom, Inc.

API commands: RenewPOPBundle

<Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>0.34375</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
Extend GetPOP3 GetPOPExpirations GetRenew Purchase PurchasePOPBundle RenewServices

12/1/08

506

1999-2008 eNom, Inc.

API commands: RenewServices

RenewServices

Description
Definition
Renew one value-added service in real time.

Usage
Use this command to renew one value-added service in real time, as opposed to going through our shopping cart. This real-time command currently supports ID Protect.

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 service must currently be subscribed for this domain. If not already subscribed, do so using the PurchaseServices or AddToCart commands.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Service NumYears SLD

Obligation
Required Required Required Optional; default is 1 Required for WPPS Required for WPPS

Definition
Account login ID Account password Service to be renewed. Permitted value for ID Protect is WPPS Number of years to renew this service Second-level domain name (for example, enom in enom.com) for the domain this service is associated with Top-level domain name (extension) for the domain this service is associated with

Max size
20 20 15 2 63

TLD

15

12/1/08

507

1999-2008 eNom, Inc.

API commands: RenewServices

Param name
UseCreditCard

Obligation
Optional overall, but Required for resellers who have a credit card processing agreement with us AND want to use our CC processing to charge this transaction to the credit card included in this query string. Default is no. Available for WPPS. Required for our credit card processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing, if printed on the card Required for our CC processing Required for our CC processing Required for our CC processing

Definition
Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted, or if the value supplied is anything other than yes, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the required credit card information.

Max size
3

EndUserIP

End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Amount to charge for each year; ChargeAmount is multiplied by NumYears. Required format is DD.cc Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Credit card number

15

ChargeAmount

CardType

20

CreditCardNumber

128

CreditCardExpMonth

Expiration month of the credit card, in format MM Expiration year of the credit card, in format YYYY Credit card verification value

CreditCardExpYear

CVV2

CCName

Cardholders name

60

CCAddress

Credit card billing street address

60

CCZip

Credit card billing postal code

60

12/1/08

508

1999-2008 eNom, Inc.

API commands: RenewServices

Param name
CCPhone

Obligation
Optional for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Required for our CC processing Optional for our CC processing Optional for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Optional for our CC processing Required for our CC processing Optional

Definition
Credit card billing phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant first name

Max size
20

RegistrantFirstName

60

RegistrantLastName

Registrant last name

60

RegistrantAddress1

First line of Registrant address

60

RegistrantAddress2

Second line of Registrant address

60

RegistrantCity

Registrant city

60

RegistrantStateProvince

Registrant state or province, if applicable 16

RegistrantStateProvinceChoice

Is the RegistrantStateProvince value a state or a province? Permitted values are S for state, P for province. Registrant postal code

16

RegistrantPostalCode

16

RegistrantCountry

Registrant country. Two-letter country code is a permitted format. Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant phone extension

60

RegistrantPhone

20

RegistrantPhoneExt

16

RegistrantFax

Registrant fax. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Registrant email address

128

RegistrantEmailAddress

128

ResponseType

Format of response. Options are Text (default), HTML, or XML.

12/1/08

509

1999-2008 eNom, Inc.

API commands: RenewServices

Returned parameters and values

Param name Definition
OrderID Command ErrCount Err(x) Done Identification number for tracking this order in our system Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query renews ID Protect for two years and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=renewservices& uid=resellid&pw=resellpw&sld=resellid&tld=resellpw& service=WPPS&numyears=2&responsetype=xml

In the response, an order ID number confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <OrderID>157405437</OrderID> <Command>RENEWSERVICES</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+08.00</TimeDifference> <ExecTime>0.797</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
PurchaseServices RenewPOPBundle

12/1/08

510

1999-2008 eNom, Inc.

API commands: RPT_GetReport

RPT_GetReport
Description
Definition
Retrieve an itemized list of one type of activity in a domain name account.

Usage
Use this command to retrieve a list of one of the following types of account activity in a domain name account: registrations, renewals, transfers, private label, subaccounts, accounting, or expiring names.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. http://resellertest.enom.com/myaccount/newReports.asp When you choose one of the seven report types listed above under Usage, the view report button calls the RPT_GetReport command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The beginning date for reports must be no earlier than 6 months before today. The ResponseType must be XML. You can parse the XML response after receiving it.

12/1/08

511

1999-2008 eNom, Inc.

API commands: RPT_GetReport

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ReportType Required Required Required

Definition
Account login ID Account password Type 0 1 2 11 3 4 5 6 10 13 15 of report to generate. Permitted values are: Registrations Renewals Transfers in Transfers out Private label (PDQ and Registry Rocket) Subaccounts Accounting Expiring names Pricing Editor updates Business Listing bulk update Business Listing domain update

Max size
20 20 1

BeginDate

Optional; default is the last day of the month, two months before the current month Optional; default is todays date Required

First date to include in the report. Must be no earlier than six months before today. Use format MM/DD/YYYY

10

EndDate

Last date to include in the report. Use format MM/DD/YYYY Format of response. Permitted value is XML.

10

ResponseType

Returned parameters and values

The following parameters are present in every report. Each specific type of report listed above has a wide variety of other return parameters specific to the report type.

Param name Definition

ReportString ThreeMoPast SixMoPast BeginDate EndDate ID Name ReportType ReportName Results Command List report descriptions The date three months before today The date six months before today The first date included in this report The last date included in this report Report type identification number Report name Report type specified in this query string Name of the report type specified in this query string Itemized list of results; varies according to the report type Name of command executed

12/1/08

512

1999-2008 eNom, Inc.

API commands: RPT_GetReport

Param name Definition

ErrCount Err(x) Done The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests a list of registrations for the period 1/1/2008 to 4/1/2008, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=RPT_GETREPORT& uid=resellid&pw=resellpw&ReportType=0& BeginDate=01/01/2008&EndDate=04/01/2008&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <rpt> <sixmopast>10/1/2007</sixmopast> <begindate>1/1/2008</begindate> <enddate>4/1/2008</enddate> <option> <reporttype id="0" name="Registrations" /> <reporttype id="1" name="Renewals" /> <reporttype id="2" name="Transfers" /> <reporttype id="3" name="Private Label" /> <reporttype id="4" name="Sub-Accounts" /> <reporttype id="5" name="Accounting" /> <reporttype id="6" name="Expiring Names" /> <reporttype id="7" name="Auction History" /> <reporttype id="8" name="Auction Payment Pending" /> </option> <reporttype>0</reporttype> <reportname>Registrations</reportname> <results> <rpttld> <report0-single tld="com" sum="2" /> </rpttld> <rptrawxml> <row OrderID="156189763" SLD="fgs456" TLD="com" CreationDate="2008-04-01T06:29:37.607" ExpDate="2008-04-01T09:29:32" PaidAmount="8.9500" BilledToCust="0.0000" /> <row OrderID="156189777" SLD="sdifuf" TLD="com" CreationDate="2008-04-01T08:43:52.077" ExpDate="2008-04-01T11:43:47" PaidAmount="8.9500" BilledToCust="0.0000" /> </rptrawxml> <NewThisMonth>2</NewThisMonth> <AverageRegPeriod>1.000000</AverageRegPeriod>

12/1/08

513

1999-2008 eNom, Inc.

API commands: RPT_GetReport

</results> </rpt> <Command>RPT_GETREPORT</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>0.8125</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetOrderDetail GetOrderList GetReport GetSubAccounts GetTransHistory

12/1/08

514

1999-2008 eNom, Inc.

API commands: SendAccountEmail

SendAccountEmail
Description
Definition
Email subaccount login information to the billing contact of record.

Usage
Use this command to email subaccount login information to the billing contact for that subaccount.

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 subaccount must be a child of this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW LoginID Account Required Required Required Required

Definition
Account login ID Account password Login ID of subaccount ID number of subaccount, in NNN-aa-NNNN format. Use the GetSubAccounts command to retrieve the subaccount ID number. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 20 11

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

515

1999-2008 eNom, Inc.

API commands: SendAccountEmail

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sends an email to the owner of the subaccount, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SendAccountEmail& uid=resellid&pw=resellpw&loginID=resellidsub&account=659-fs-2869 &responsetype=xml

In the response, an ErrCount value 0 confirms that the query was successful:
<interface-response> <Command>SENDACCOUNTEMAIL</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod/> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable/> <IsRealTimeTLD/> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.078125</ExecTime> <Done>true</Done> <debug></debug> </interface-response>

Related commands
GetAccountPassword GetAccountValidation GetSubAccounts

12/1/08

516

1999-2008 eNom, Inc.

API commands: ServiceSelect

ServiceSelect
Description
Definition
Enable and disable services for a domain. You can also use this command to retrieve the current settings for a service.

Usage
Use this command to enable or disable email (MX or MXE), DNS, Web Site Creator, Web hosting, ID Protect, NameMyPhone, or NameMyMap services for a domain. Use this command to create a Web Site Creator account. Use this command to get the current settings for a service.

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/ ServiceSelection.asp?DomainNameID=152533676&service=emailset

On the email settings, name my phone, or name my map pages, the save changes button calls the ServiceSelect 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. One query can select only one service. You must repeat the query for each service you want to select.

12/1/08

517

1999-2008 eNom, Inc.

API commands: ServiceSelect

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Service Required Required

Definition
Account login ID Account password

Max size
20 20 15

Required; if Service type. Permitted values are: Service is WSB (Web Site Creator and Web hosting services) used without EmailSet (email services) NewOptionID WPPS (ID Protect Whois Privacy Protection) and Update, Messaging (NameMyPhone) the response Map (NameMyMap) gives the current setting Optional; if you Setting for the service. Permitted values are: Service=DNSServer (which domain name servers): use 1006 use our name servers NewOptionID 1012 use user-specified domain servers, including none you must also Service=WSB (Web site services): use Update 1060 no Web site services 1063 Web Site Creator stand-alone (use this option to create or enable Web Site Creator stand-alone) 1066 Web hosting account Service=EmailSet (Email services): 1048 no email 1051 email forwarding (to a POP or WebMail address) 1054 user (mail server name required) 1105 user simplified (mail servers IP address required) 1114 POP3/WebMail plus email forwarding Service=WPPS (ID Protect Whois Privacy Protection): 1120 WhoIs information is masked 1123 WhoIs information is viewable Service=Messaging (NameMyPhone): 1087 disabled 1090 enabled Service=Map (NameMyMap): 1108 disabled 1111 enabled Required if you True updates the NewOptionID value for the service use NewOptionID Required for Service= EmailSet WPPS Messaging Map Second-level domain name (for example, enom in enom.com)

NewOptionID

Update

SLD

63

12/1/08

518

1999-2008 eNom, Inc.

API commands: ServiceSelect

Param name Obligation

TLD Required for Service= EmailSet WPPS Messaging Map

Definition
Top-level domain name (extension)

Max size
15

HostAccount

Name of the Web hosting account to enable or disable. Required if Service=WSB and NewOptionID =1066 Optional Format of response. Options are Text (default), HTML, or XML.

14

ResponseType

Returned parameters and values

Param name Definition
RegistrarHold current-svc Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Current service option setting Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query enables email services, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=serviceselect& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&newoptionid=1114& service=emailset&update=True&responsetype=xml

The response indicates that email services have changed from option 1048 (no email) to 1114 (POP3/WebMail
plus email forwarding): <?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <ServiceSelect> <domainname sld="resellerdocs" tld="com" domainnameid="152533676"> resellerdocs.com </domainname> <service name="email">

12/1/08

519

1999-2008 eNom, Inc.

API commands: ServiceSelect

<UpdateOption>True</UpdateOption> <option name="1048" /> <option name="1114" /> </service> <current-svc>1114</current-svc> <WebSite /> </ServiceSelect> <Command>SERVICESELECT</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetDomainPhone GetWPPSInfo GetIPResolver ModifyNS PE_SetPricing SetDomainMap SetDomainPhone SetHosts SetIPResolver SetResellerServicesPricing

12/1/08

520

1999-2008 eNom, Inc.

API commands: SetCatchAll

SetCatchAll
Description
Definition
Set a forwarding address for any emails addressed to nonexistent mailboxes.

Usage
Use this command to forward email addressed to nonexistent email addresses under a domain name. The domain name must be in our system, but the forwarding address does not need to be.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. http://resellertest.enom.com/domains/POPConfig.asp?DomainNameId=152533676 The Catch-All Email box at the bottom of the page uses the SetCatchAll 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. The ForwardTo address does not need to be in our system.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ForwardTo ResponseType Required Required Required Required Required Optional

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Email address to forward mail to. Use format [email protected] Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 130 4

12/1/08

521

1999-2008 eNom, Inc.

API commands: SetCatchAll

Returned parameters and values

Param name Definition
CatchAll Command ErrCount Err(x) Done Email address that mail will be sent to if the addressee mailbox does not exist Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query forwards any email addressed to nonexistent mailboxes for this domain name, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SetCatchAll& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& [email protected]&responsetype=xml

In the response, the presence of the CatchAll email address you supplied confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <CatchAll>[email protected]</CatchAll> <Command>SETCATCHALL</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.09375</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

12/1/08

522

1999-2008 eNom, Inc.

API commands: SetCatchAll

Related commands
DeletePOP3 Forwarding GetCatchAll GetDotNameForwarding GetForwarding GetPOP3 GetPOPForwarding SetDotNameForwarding SetPOPForwarding SetUpPOP3User

12/1/08

523

1999-2008 eNom, Inc.

API commands: SetCustomerDefinedData

SetCustomerDefinedData
Description
Definition
Enter data fields defined by you, and the corresponding data.

Usage
Use this command to create a storage place for data fields that do not currently exist. Also use this command to put data into those custom data fields. This command allows you to add data one field at a time.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ObjectID Type Required Required Required Required

Definition
Account login ID Account password Object ID number, an integer assigned by you. Object type. Options are: 1 Data pertaining to an account 2 Data pertaining to a domain 3 Data pertaining to an order Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Order ID, which you can retrieve using GetDomainStatus. Title of this entry, or label describing this data field

Max size
20 20 2 1

SLD TLD OrderID Key

Required if Type=2 Required if Type=2 Required if Type=3 Required

63 15 11 50

12/1/08

524

1999-2008 eNom, Inc.

API commands: SetCustomerDefinedData

Param name Obligation

Value DisplayFlag Required Recommended

Definition
Content of this entry Visibility to subaccount. Options are: 0 Not visible when logged on with subaccount ID 1 Visible when logged on using subaccount ID Name of the person adding this entry Format of response. Options are Text (default), HTML, or XML.

Max size
50 1

EnteredBy ResponseType

Recommended Optional

50 4

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query creates a new data field labeled FavoriteCuisine and assigns a value Italian for this account.:
http://resellertest.enom.com/interface.asp?command=SetCustomerDefinedData& uid=resellid&pw=resellpw&ObjectID=1&Type=1&Key=FavoriteCuisine&Value=Italian& DisplayFlag=0&EnteredBy=John&responsetype=xml

In the response, the value 0 for ErrCount confirms that the query executed successfully:
<?xml version="1.0" ?> <interface-response> <Command>SETCUSTOMERDEFINEDDATA</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

525

1999-2008 eNom, Inc.

API commands: SetCustomerDefinedData

Related commands
DeleteCustomerDefinedData GetCustomerDefinedData

12/1/08

526

1999-2008 eNom, Inc.

API commands: SetDNSHost

SetDNSHost
Description
Definition
Dynamically updates the IP address of the host computer in our name server records.

Usage
Use this command to update the IP address of a host that does not have a static IP address. If possible, use this command in a secure mode: https instead of http.

Availability
All customers 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 domain name must belong to this account. The domain name must have a password. The host must be set as an IP address.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Zone DomainPassword Address

Obligation Definition
Required Required Required Required Optional Account login ID Account password The host and domain name that you want to update in the DNS. For example, www.resellerdocs.com. Password for managing the domain (a domain that uses the SetDNSHost command must have a password) The IP address to set the DNS record to. If omitted, the IP you are coming from (as our server sees it) is used. For example, if you are connecting to our server through a proxy, the proxy server's IP will be used. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 93 60 15

ResponseType

Optional

12/1/08

527

1999-2008 eNom, Inc.

API commands: SetDNSHost

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query uses a secure server to set the host for resellerdocs.com. Because the query string does not specify the IP, the command sets the IP to that from which the server received the query:
https://resellertest.enom.com/interface.asp?command=SetDNSHost& zone=resellerdocs.com&DomainPassword=tester&responsetype=xml

The error count value 0 confirms that the DNS host was set successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>SETDNSHOST</Command> <ErrCount>0</ErrCount> <Server>Reseller5</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetHosts GetRegHosts SetHosts

12/1/08

528

1999-2008 eNom, Inc.

API commands: SetDomainMap

SetDomainMap
Description
Definition
Update NameMyMap settings.

Usage
Use this command to update the location information listed on map.YourSite.com.

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/NameMyMap.asp?DomainNameID=152533676

On the Map Settings page, the save changes button calls the SetDomainMap 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD HostName Address City StateProvince PostalCode Country ResponseType Required Required Required Required Required Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Name for your host Address to build the map for City to build the map for State or province to build the map for Postal code to build the map for Country to build the map for Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 60 60 60 60 60 60 4

12/1/08

529

1999-2008 eNom, Inc.

API commands: SetDomainMap

Returned parameters and values

Param name
RegistrarHold host-name address city stateprovince postalcode country SetDomainMap Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name for your host. Address to build the map. City to build the map. State or province to build the map. Postal code to build the map. Country to build the map. Response is Successful or Failed. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query assigns an address to the NameMyMap feature of resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=setdomainmap&uid=resellid&pw=resellpw& sld=resellerdocs&tld=com&hostname=dns1.name-services.com&Address=100%20Main%20St.& City=Townsville&StateProvince=WA&PostalCode=99999&Country=United+States&responsetype=xml

The response confirms that map.resellerdocs.com was set successfully:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <SetDomainMap> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <map> <orig-host-name> <![CDATA[ ] ]> </orig-host-name> <host-name> <![CDATA[ dns1.name-services.com ] ]> </host-name> <address> <![CDATA[ 100 Main St. ] ]> </address> <city> <![CDATA[ Townsville ] ]>

12/1/08

530

1999-2008 eNom, Inc.

API commands: SetDomainMap

</city> <stateprovince> <![CDATA[ WA ] ]> </stateprovince> <postalcode> <![CDATA[ 99999 ] ]> </postalcode> <country> <![CDATA[ US ] ]> </country> <data-errors /> </map> <SetDomainMap>Successful</SetDomainMap> </SetDomainMap> <Command>SETDOMAINMAP</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetDomainPhone GetIPResolver ServiceSelect SetDomainPhone SetDomainSubServices SetIPResolver

12/1/08

531

1999-2008 eNom, Inc.

API commands: SetDomainPhone

SetDomainPhone
Description
Definition
Update NameMyPhone settings.

Usage
Use this command to set the telephone forwarding information for phone.YourSite.com

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/PhoneMessaging.asp?DomainNameID=152533676

On the name my phone page, the save changes button calls the SetDomainPhone 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD HostName Phone Required Required Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Name for your host (default is phone). Phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. ID of service (see notes).

Max size
20 20 63 15 50 20

ServiceID

Required

12/1/08

532

1999-2008 eNom, Inc.

API commands: SetDomainPhone

Param name Obligation Definition

EmailAlias TemplateID ResponseType Required Required Optional Use alias. Permitted values are On or Off. Template used to view your service (see notes). Format of response. Options are Text (default), HTML, or XML.

Max size
3 2 4

Returned parameters and values

Param name Definition
RegistrarHold host-name service-id max-chars email-alias template-id Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled Host name for DNS entry (default is phone) ID of your phone service Maximum number of characters allowed per message Flag to set up email forwarding alias - True or False Template used to view your service Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. ServiceID codes--1=Nextel, 2=Sprint PCS, 4=Verizon, 5=AT&T Wireless, 8=VoiceStream, 12=Cingular, 99=Other. TemplateID codes--1=Western, 2=Techno, 3=Modern, 4=Letter Head, 5=Hand Held, 6=Business.

Example
The following query assigns a phone number to the NameMyPhone feature of resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=setdomainphone&uid=resellid&pw=resellpw& sld=resellerdocs&tld=com&hostname=phone&phone=+1.5555555555&serviceid=4&emailalias=on& templateid=3&responsetype=xml

The response confirms that phone.resellerdocs.com was set successfully:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <SetDomainPhone> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <DomainPhone>

12/1/08

533

1999-2008 eNom, Inc.

API commands: SetDomainPhone

<host-name>phone</host-name> <phone-number> <![CDATA[ 5555555555 ] ]> </phone-number> <service-id>4</service-id> <device-email> <![CDATA[ ] ]> </device-email> <max-chars>0</max-chars> <email-alias>True</email-alias> <template-id>3</template-id> <cc-email1> <![CDATA[ ] ]> </cc-email1> <cc-email2> <![CDATA[ ] ]> </cc-email2> <cc-email3> <![CDATA[ ] ]> </cc-email3> <orig-host-name /> <data-errors /> </DomainPhone> <SetDomainPhoneStatus>Successful</SetDomainPhoneStatus> </SetDomainPhone> <Command>SETDOMAINPHONE</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetDomainPhone GetIPResolver ServiceSelect SetDomainMap SetDomainSubServices SetIPResolver

12/1/08

534

1999-2008 eNom, Inc.

API commands: SetDomainSRVHosts

SetDomainSRVHosts
Description
Definition
Create or edit SRV host records for a domain name.

Usage
Use this command to create or edit SRV (service) records for a domain name. This command deletes all previously existing SRV records for the domain name. You must include all SRV records that you want to end up with, in the query string. SRV records are required for some newer Internet protocols such as SIP and XMPP. Some other protocols support, but do not require, SRV records. This command allows a user to supply the components of an SRV record that are discretionary, then adds TTL, Class, and formatting to produce a complete SRV record.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/control-panel/default.asp?DomainNameID=152533676

The save button calls the SetDomainSRVHosts 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. The domain name must use our name servers.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

12/1/08

535

1999-2008 eNom, Inc.

API commands: SetDomainSRVHosts

Param name Obligation

HostIDX Optional

Definition
ID number of an existing host record, if it exists and you want to edit it. Use the GetDomainSRVHosts command to retrieve SRV record ID numbers. Service type of this record. Required format is 1 to 14 characters in length; includes lower-case letters, digits, and hyphens; and begins and ends with a letter or digit Transport protocol for this record, such as TCP or UDP. Priority for this record. Lowest priority values are used first, working toward higher priority values when lower values are unavailable. Use this value to designate backup service. Permitted values are numbers from 0 to 65535 Proportion of time to use this record. Records of equal priority are added and the total normalized to 100%. Use this parameter to specify load balancing among records of the same priority. Permitted values are numbers from 0 to 65535 Port to use for this service. Permitted format is numbers from 0 to 65535 Fully qualified domain name for this SRV record. Permitted format is SRVRecordName.SLD.TLD. (include the trailing period in a fully qualified domain name) Format of response. Options are Text (default), HTML, or XML.

Max size

ServiceX

Required

14

ProtocolX PriorityX

Required Required

14 5

WeightX

Required

PortX TargetX

Required Required

ResponseType

Optional

Returned parameters and values

Param name Definition
InsertedCount UpdatedCount DeletedCount Success Command ErrCount Err(x) Done Number of SRV records added Number of SRV records edited Number of SRV records deleted Success status of this query Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

536

1999-2008 eNom, Inc.

API commands: SetDomainSRVHosts

Example
The following query keeps an existing SRV record and adds a new record, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SETDOMAINSRVHOSTS& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&HostID1=17217418& Service1=imap&Protocol1=TCP&Priority1=10&Weight1=50&Port1=1& Target1=imap.resellerdocs.com.&HostID2=&Service2=xmpp&Protocol2=UDP& Priority2=10&Weight2=50&Port2=98&Target2=xmpp.resellerdocs.com.& ResponseType=XML

In the response, the Success value True and the ErrCount value 0 confirm that the query was successful. In addition, the response specifies the numbers of SRV records that were added, changed, and deleted:
<?xml version="1.0" ?> <interface-response> <InsertedCount>1</InsertedCount> <UpdatedCount>0</UpdatedCount> <DeletedCount>0</DeletedCount> <Success>true</Success> <Command>SETDOMAINSRVHOSTS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.078</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
GetDomainInfo GetDomainSRVHosts GetHosts SetHosts

12/1/08

537

1999-2008 eNom, Inc.

API commands: SetDomainSubServices

SetDomainSubServices
Description
Definition
Update settings for domain services (active or inactive for email forwarding host records).

Usage
Use this command to enable or disable services. (e.g., Host or email forwarding records).

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=SetDomainSubServices&uid=yourloginid &pw=yourpassword&sld=domain&tld=com&ActivateForwarding=0&ActivateHostRecords=1

Param name
UID PW SLD TLD ActivateForwarding

Obligation Definition
Required Required Required Required Optional; default is 1 Optional; default is 1 Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Enable email forwarding? Permitted values are: 1 to enable 0 to disable Enable URL forwarding? Permitted values are: 1 to enable 0 to disable Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 1

ActivateHostRecords

ResponseType

12/1/08

538

1999-2008 eNom, Inc.

API commands: SetDomainSubServices

Returned parameters and values

Param name
RegistrarHold EmailForwarding HostRecords SetDomainServices Command ErrCount Err(x) Done

Definition
The enabled status of a domain. If RegistrarHold is True, the domain is disabled. 1, 0 or empty 1, 0 or empty Successful or Failed Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets the subservices of a domain and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=setdomainsubservices& uid=resellid&pw=resellpw&sld=resellerdocs2&tld=net& ActivateForwarding=1&ActivateHostRecords=1&responsetype=xml

In the response, the SetDomainServices value Successful and the ErrCount value of 0 confirm that services have been set successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <DomainServices> <EmailForwarding>1</EmailForwarding> <HostRecords>1</HostRecords> <SetDomainServices>Successful</SetDomainServices> </DomainServices> <Command>SETDOMAINSUBSERVICES</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

539

1999-2008 eNom, Inc.

API commands: SetDomainSubServices

Related commands
GetDomainMap GetDomainPhone GetDomainSubServices GetIPResolver ServiceSelect SetDomainMap SetDomainPhone SetIPResolver

12/1/08

540

1999-2008 eNom, Inc.

API commands: SetDotNameForwarding

SetDotNameForwarding
Description
Definition
Set the email forwarding address for a .name domain.

Usage
Use this command if you want to use the .name Registrys email forwarding feature (you can also use eNoms email forwarding with .name domains).

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw. On the domain names menu, click my domains, and then click a .name domain. On the domain control panel of the .name domain, scroll down to Email Settings. Click the .name email button. On the Manage this domain's ".NAME email forward" settings page, the save changes button calls the SetDotNameForwarding 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. The domain must have a .name TLD.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD

Obligation
Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com)

Max size
20 20 63

12/1/08

541

1999-2008 eNom, Inc.

API commands: SetDotNameForwarding

Param name
TLD ForwardTo ResponseType

Obligation
Required Required Optional

Definition
Top-level domain name (extension) Email address to forward to, in the format [email protected] Format of response. Options are Text (default), HTML, or XML.

Max size
15 120 4

Returned parameters and values

Param name Definition
ForwardTo Command ErrCount Err(x) Done Email address to which email will be forwarded Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
John Doe registers domain john.doe.name, which automatically includes the email address [email protected]. The following query forwards email addressed to [email protected] to [email protected], and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=setdotnameforwarding& uid=resellid&pw=resellpw&sld=john.doe&tld=name& [email protected]&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <dotnameforwarding> <ForwardTo>[email protected]</ForwardTo> </dotnameforwarding> <Command>SETDOTNAMEFORWARDING</Command> <ErrCount>0</ErrCount> <Server>Reseller3</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]>

12/1/08

542

1999-2008 eNom, Inc.

API commands: SetDotNameForwarding

</debug> </interface-response>

Related commands
Forwarding GetCatchAll GetDotNameForwarding GetForwarding PurchasePOPBundle SetUpPOP3User

12/1/08

543

1999-2008 eNom, Inc.

API commands: SetHosts

SetHosts
Description
Definition
Set host records for a domain name.

Usage
Use this command to change the host records for a domain name. This command deletes the existing host records before replacing them with the host records included in the query string. To avoid unpleasant surprises for the user, some resellers use the GetHosts command to retrieve existing host records, and populate the SetHosts query string with existing host records while also allowing the user to add or delete host records. To set SRV records, use the SetDomainSRVHosts command. To enable or disable email, use the ServiceSelect command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/HostConfig.asp?DomainNameID=152533676

On the host settings page, the save changes button calls the SetHosts 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. This command deletes your existing host records before replacing them with the records you include in the query string. See Usage note, above.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

12/1/08

544

1999-2008 eNom, Inc.

API commands: SetHosts

Param name Obligation Definition

HostNameX X=1 to maximum 50 Required

Max size

Name of the host record to add. This command deletes all 60 existing host records and replaces them with the records you supply in this query string. Index the parameters for each host record X; X must be numeric and in sequence beginning with 1. Record type of host record X. Permitted values are: A Address CNAME Alias record type, to associate a host name with another host URL URL redirect FRAME Frame redirect MX Mail. Can be a host name under this domain name or the name of a mail server MXE Mail Easy (email forwarding) TXT Text (SPF) record 5

RecordTypeX X=1 to maximum 50

Required

AddressX X=1 to maximum 50

Required

Address to redirect to. 260 If RecordTypeX=A, AddressX must be an IP address If RecordTypeX=CNAME, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=URL, AddressX must be the exact URL of the page you redirect to, or an IP address, or a fully qualified domain name (see Note) If RecordTypeX=FRAME, AddressX is the actual URL, or the IP address, or the fully qualified domain name (see Note) of the page you want to display when someone types Your_Domain.com If RecordTypeX=MX, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=MXE, AddressX must be an IP address If RecordTypeX=TXT, AddressX is a text (SPF) record. For help writing an SPF record, go to http://spf.pobox.com/wizard.html

MXPrefX X=1 to maximum 50) ResponseType

Optional; use Host record preference for setting mail redirection. The lower 5 the number, the higher the priority. If not specified, default with record value is 10. type MX; default is 10 Optional Format of response. Options are Text (default), HTML, or XML. 4

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

545

1999-2008 eNom, Inc.

API commands: SetHosts

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
A fully qualified domain name is expressed in the format hostname.SLD.TLD.. Note that the period at the end is an essential component of a fully qualified domain name. 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
The following query sets four host records for resellerdocs.com. The results:
resellerdocs.com forwards mail to IP address 66.150.5.189. photos.resellerdocs.com points to domain name photos.msn.com yahoo.resellerdocs.com points to IP address 204.71.200.72 msn.resellerdocs.com points to URL http://www.msn.com http://resellertest.enom.com/interface.asp?command=sethosts& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& HostName1=@&RecordType1=A&Address1=66.150.5.189& HostName2=photos&RecordType2=CNAME&Address2=photos.msn.com.& HostName3=yahoo&RecordType3=URL&Address3=204.71.200.72& HostName4=msn&RecordType4=FRAME&Address4=http://www.msn.com& responsetype=xml

The error count value of 0 confirms that hosts have been set successfully:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>SETHOSTS</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

546

1999-2008 eNom, Inc.

API commands: SetHosts

Related commands
GetHosts GetMetaTag GetRegHosts GetSPFHosts PurchaseServices SetDomainSRVHosts SetDNSHost SetSPFHosts UpdateMetaTag

12/1/08

547

1999-2008 eNom, Inc.

API commands: SetIPResolver

SetIPResolver
Description
Definition
Update IP Resolver settings.

Usage
Use this command to set information for the NameMyComputer service.

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/IPResolverConfig.asp?DomainNameID=152533676

On the name my computer page, the save changes button calls the SetIPResolver 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand&uid=yourloginid& pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD IPResolverID OrigHostName HostName ClientUserID ServiceID OfflineURL ResponseType Required Required Required Required Optional Optional Required Required Required Optional Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) IP resolver ID Original host name Name for your host ICQ# or UserID City to build the map for Offline URL Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 60 60 60 60 60 78 4

12/1/08

548

1999-2008 eNom, Inc.

API commands: SetIPResolver

Returned parameters and values

Param name Definition
RegistrarHold ip-resolver-id host-name client-user-id service-id SetIPResolver Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Current ID if one exists. Name for your host. Current ICQ# or UserID. Current service ID ("1"). Success of this query. Response is Successful or Failed. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets information for the Name My Computer service, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=SetIPResolver& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&ClientUserID=12345678& HostName=home&ServiceID=1&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <SetIPResolver> <domainname sld="resellerdocs" tld="com" id="152533676"> resellerdocs.com </domainname> <IPResolver> <ip-resolver-id /> <orig-host-name /> <host-name>home</host-name> <client-user-id> <![CDATA[ 12345678 ] ]> </client-user-id> <service-id>1</service-id> <offine-url> <![CDATA[ ] ]> </offine-url> <data-errors /> </IPResolver> <SetIPResolver>Successful</SetIPResolver>

12/1/08

549

1999-2008 eNom, Inc.

API commands: SetIPResolver

</SetIPResolver> <Command>SETIPRESOLVER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>eNom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetDomainMap GetDomainPhone GetIPResolver ServiceSelect SetDomainMap SetDomainPhone

12/1/08

550

1999-2008 eNom, Inc.

API commands: SetPakRenew

SetPakRenew
Description
Definition
Set the auto-renew behavior for a POP email pak.

Usage
Use this command to set auto-renew behavior for an individual POP pak.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/POPConfig.asp?DomainNameId=152533676

At the bottom of the section for each POP pak, the Attempt to auto-renew check box calls the SetPakRenew 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. The POP pak bundle ID must belong to this domain.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD BundleID AutoPakRenew ResponseType

Obligation Definition
Required Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Numerical ID for the POP pak (retrieve the bundle ID using the GetPOP3 command) Auto-renew setting to be applied to this POP pak. Permitted values are 1 (on) or 0 (off) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4 1 4

12/1/08

551

1999-2008 eNom, Inc.

API commands: SetPakRenew

Returned parameters and values

Param name Definition
DomainRRP RegistrarHold PakUpdated Command ErrCount Err(x) Done Domain type The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Bundle ID of the POP pak for which the auto-renew value is being reset Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

AutoPakRenew Auto-renew setting for the pak. Values are 1 (on) or 0 (off)

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
The following query turns the POP pak auto-renew setting for bundle 5105 on, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SETPAKRENEW& uid=resellid&pw=resellpw&DomainNameID=152533676& bundleid=5105&AutoPakRenew=1&ResponseType=XML

In the response, the error count of 0 and absence of error messages confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <PakUpdated>5105</PakUpdated> <AutoPakRenew>1</AutoPakRenew> <Command>SETPAKRENEW</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetPOP3 GetRenew

12/1/08

552

1999-2008 eNom, Inc.

API commands: SetPakRenew

SetRenew UpdateCusPreferences

12/1/08

553

1999-2008 eNom, Inc.

API commands: SetPassword

SetPassword
Description
Definition
Set a password for a domain name.

Usage
Use this command to set a password for access to a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/SubAccountConfig.asp?DomainNameID=152533676

On the domain password page, the save changes button calls the SetPassword 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. The domain name password must use ASCII characters, and must be 6 to 60 characters in length.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD DomainPassword ResponseType

Obligation Definition
Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
20 20 63 15

Password to access and manage the domain name. Must 60 use ASCII characters and be 6 to 60 characters in length. Format of response. Options are Text (default), HTML, or XML. 4

12/1/08

554

1999-2008 eNom, Inc.

API commands: SetPassword

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets the domain password for resellerdocs.com as resellerdocspw, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=setpassword& uid=resellid&pw=resellpw& sld=resellerdocs&tld=com&domainpassword=resellerdocspw&responsetype=xml

The response confirms that the password is set successfully:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Command>SETPASSWORD</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

555

1999-2008 eNom, Inc.

API commands: SetPassword

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetRegLock SetRenew StatusDomain ValidatePassword

12/1/08

556

1999-2008 eNom, Inc.

API commands: SetPOPForwarding

SetPOPForwarding
Description
Definition
Create, change, or delete an email forwarding address for a domain name.

Usage
Use this command to create, update, or delete email forwarding records for a domain name. This command can be used to configure email forwarding addresses for both our POP mail and our email forwarding services.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.enom.com/domains/MailConfig.asp?DomainNameID=152533676

The save changes button calls the SetPOPForwarding 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD UserName EMail Required Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) The user name for this mailbox (email address will be [email protected]).

Max size
20 20 63 15 30

Domain for this mailbox. Must be the same values as SLD 78 and TLD above. Use format SLD.TLD (email address will be [email protected]). Email address to forward to. Use format [email protected] 130

ForwardTo

Required

12/1/08

557

1999-2008 eNom, Inc.

API commands: SetPOPForwarding

Param name Obligation

Enable Required

Definition
Add this email forwarding? Permitted values are: 0 Delete this email forwarding address 1 Add or change this email forwarding address

Max size
1

StatusFlags

Optional

Deliver to forwarding address? Permitted values are: 1 no value Deliver to original mailbox only 0 Deliver to both original mailbox and forwarding address 1 Deliver only to the forwarding address Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

Returned parameters and values

Param name Definition
Success Command ErrCount Err(x) Done 1 indicates the query was successful Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query creates an email forwarding record: Email addressed to [email protected] will be forwarded to [email protected]. The query string also requests a response in XML format:
http://resellertest.enom.com/interface.asp?command=SETPOPFORWARDING& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& username=sales&Email=resellerdocs.com&[email protected]& Enable=1&StatusFlags=1&ResponseType=xml

In the response, the Success value 1 indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <success>1</success> <Command>SETPOPFORWARDING</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server>

12/1/08

558

1999-2008 eNom, Inc.

API commands: SetPOPForwarding

<Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.1328125</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
DeletePOP3 GetCatchAll GetPOP3 GetPOPForwarding PurchasePOPBundle SetUpPOP3User

12/1/08

559

1999-2008 eNom, Inc.

API commands: SetRegLock

SetRegLock
Description
Definition
Set the registrar lock for a domain name.

Usage
Set the registrar unlock value to 0 to prevent unauthorized transfer of a domain name to another registrar. Set the registrar unlock value to 1 to allow unrestricted transfer of a domain name.

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/MiscConfig.asp?DomainNameID=152533676

On the Domain Name Maintenance page, the check box marked Do not allow this name to be transferred . . . sets the value for the UnlockRegistrar parameter, and the save changes button calls the SetRegLock 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD UnlockRegistrar ResponseType

Obligation Definition
Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Lock option to be set. Permitted values are 1 to unlock, 0 to lock). Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 1 4

12/1/08

560

1999-2008 eNom, Inc.

API commands: SetRegLock

Returned parameters and values

Param name Definition
RegistrarHold RegistrarLock Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Current lock status if successful, (=Failed otherwise). Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that the registrar lock be set (unlockregistrar set to false), and requests the response in XML format:
http://resellertest.enom.com/Interface.asp?command=setreglock& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&unlockregistrar=0& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <RegistrarLock>REGISTRAR-LOCK</RegistrarLock> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>SETREGLOCK</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

561

1999-2008 eNom, Inc.

API commands: SetRegLock

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRenew StatusDomain ValidatePassword

12/1/08

562

1999-2008 eNom, Inc.

API commands: SetRenew

SetRenew
Description
Definition
Set the auto-renew flag for a domain name.

Usage
Use this command with RenewFlag set to 1 to renew the domain registration automatically. Use this command with RenewFlag set to 0 to require the owner to actively renew.

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/MiscConfig.asp?DomainNameID=152533676

On the Domain Name Maintenance page, the check box marked Renew the registration . . . sets the value for the RenewFlag parameter, and the save changes button calls the SetRenew 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD RenewFlag AutoPakRenew

Obligation Definition
Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Turn the auto-renew setting for the domain on or off. Options are 1 to auto-renew, 0 otherwise

Max size
20 20 63 15 1

1 Turn the auto-renew setting for all POP paks in this domain on or off. Permitted values are 1 to autorenew, 0 otherwise. To control the auto-renew settings for individual POP paks, use the SetPakRenew command.

12/1/08

563

1999-2008 eNom, Inc.

API commands: SetRenew

Param name
EmailForwardRenew

Obligation Definition
Optional

Max size

Turn the auto-renew setting for email forwarding in 1 this domain on or off. Permitted values are 1 to autorenew, 0 otherwise. Turn the URL forwarding setting for POP paks in this domain on or off. Permitted values are 1 to autorenew, 0 otherwise. Turn the auto-renew setting for Whois Privacy Protection Service in this domain on or off. Permitted values are 1 to auto-renew, 0 otherwise. Format of response. Options are Text (default), HTML, or XML. 1

URLForwardRenew

Optional

WPPSRenew

Optional

ResponseType

Optional

Returned parameters and values

Param name Definition
RegistrarHold RenewName The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Current auto-renew setting (1 = on, 0 = off)

AutoPakRenew Current auto-renew setting for POP paks (True = on, False = off). This return parameter only appears if the AutoPakRenew is an input parameter. Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that resellerdocs.com renew automatically, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=setrenew& uid=resellid&pw=resellpw& sld=resellerdocs&tld=com&renewflag=1&responsetype=xml

The response confirms that the autorenew flag is set successfully (RenewName=1):
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <RenewName>1</RenewName> <Command>SETRENEW</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server>

12/1/08

564

1999-2008 eNom, Inc.

API commands: SetRenew

<Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
Extend GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword InsertNewOrder SetPakRenew SetPassword SetRegLock StatusDomain UpdateExpiredDomains ValidatePassword

12/1/08

565

1999-2008 eNom, Inc.

API commands: SetResellerServicesPricing

SetResellerServicesPricing
Description
Definition
Set the prices you charge your reseller for services.

Usage
Use this command to set prices you charge a subaccount for services. This command differs from the GetSubAccountDetails command in that the SetResellerServicesPricing command allows you to set pricing of any combination of services, SetResellerServicesPricing does not require you to simultaneously convert an account to reseller status, and SetResellerServicesPricing does not require you to set all service prices in a single query. To cover all the functionality of the GetSubAccountDetails command without its restrictions, use SetResellerTLDPricing, and SetResellerServicesPricing.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-Manage.asp?Account=107-vm-2729

The save changes button calls the SetResellerServicesPricing 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SubUID

Obligation
Required Required

Definition
Account login ID Account password

Max size
20 20 20

Either SubUID Login ID of the subaccount to set pricing for. or Account is Required

Account

11 Either SubUID Account ID of the subaccount to set pricing for, in or Account is NNN-aa-NNNN format. To retrieve the subaccount ID, use the GetSubAccounts command. Required

12/1/08

566

1999-2008 eNom, Inc.

API commands: SetResellerServicesPricing

Param name
DotNameBundle DNSHosting POP3 WPPS

Obligation
Optional Optional Optional Optional

Definition
Price you are charging this subaccount for a name-andemail .name bundle, in DD.cc format Price you are charging this subaccount for one year of DNS hosting, in DD.cc format Price you are charging this subaccount for a POP3 10-pak, in DD.cc format

Max size
5 5 5

5 Price your are charging this subaccount for a one-year subscription to Whois Privacy Protection Service, in DD.cc format Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

Returned parameters and values

Param name Definition
ServiceX PriceX ServicesCount Command ErrCount Err(x) Done Name of this service. Indexed X when ResponseType=Text or HTML. Price you set for this service. Indexed X when ResponseType=Text or HTML. Number of services listed in this response (all services, not just those for which you set prices in your query) Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets prices for serviceswholesale prices that resellid charges subaccount 443-up-6579and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SETRESELLERSERVICESPRICING uid=resellid&pw=resellpw&account=443-up-6579&pop3=19.95& responsetype=xml

In the response, the list of prices that match those you set, and the ErrCount value 0, indicate that the query was successful:
<?xml version="1.0" ?> <interface-response> <services> <service name="pop3" price="19.95" /> <service name="dotnamebundle" price="" /> </services>

12/1/08

567

1999-2008 eNom, Inc.

API commands: SetResellerServicesPricing

<servicescount>2</servicescount> <Command>SETRESELLERSERVICESPRICING</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>ResellerTest</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD> <ExecTime>0.6875</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetSubAccounts PE_SetPricing SetResellerTLDPricing

12/1/08

568

1999-2008 eNom, Inc.

API commands: SetResellerTLDPricing

SetResellerTLDPricing
Description
Definition
Set the prices you charge your resellers for domain names. You can use this command to set any number of prices.

Usage
Use this command to set prices you charge your resellers for domain names. We recommend that you use SetResellerTLDPricing for setting prices charged to subaccounts. The GetSubAccountDetails command also offers this functionality, but with much stricter requirements on the query string.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/SubAccount-Manage.asp?Account=107-vm-2729

The save changes button calls the SetResellerTLDPricing command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The subaccount must belong to this domain name account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SubUID

Obligation
Required Required

Definition
Account login ID Account password

Max size
20 20 20

Either SubUID Login ID of the subaccount to set pricing for. or Account is Required

Account

Either SubUID Account ID number of the subaccount to set pricing for, in 11 or Account is NNN-aa-NNNN format. To retrieve the subaccount ID number, use the GetSubAccounts command. Required Optional Price you are charging this subaccount for registering this 5 TLD, in DD.cc format

TLDPrice

12/1/08

569

1999-2008 eNom, Inc.

API commands: SetResellerTLDPricing

Param name
TLDRenew TLDTransfer DotNameBundle POP3 WPPS ResponseType

Obligation
Optional Optional Optional Required Required Optional

Definition
Price you are charging this subaccount for renewing this TLD, in DD.cc format Price you are charging this subaccount for transferring this TLD, in DD.cc format Price you are charging this subaccount for a name-andemail .name bundle, in DD.cc format Price you are charging this subaccount for a POP3 10pak, in DD.cc format Price you are charging this subaccount for WhoIs Privacy Protection Service, in DD.cc format Format of response. Options are Text (default), HTML, or XML.

Max size
5 5 5 5 5 4

Returned parameters and values

Param name
price tld="TLD" id="ID" prod="Prod"

Definition
When ResponseType=XML, this multi-part parameter name is used as the XML tag. The return value is the price of the product described by the param name. TLD. Indexed X when ResponseType=Text or HTML. TLD ID number from our database. Indexed X when ResponseType=Text or HTML. Product ID number from our database. Indexed X when ResponseType=Text or HTML. Product price. Indexed X when ResponseType=Text or HTML. The price of a one-year subscription to a .name name-andemail bundle Name of product. Indexed X when ResponseType=Text or HTML. The price for a one-year subscription to product. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

tldX tldIDX productIDX priceX DotNameBundle NameX PriceX Command ErrCount Err(x) Done

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.

12/1/08

570

1999-2008 eNom, Inc.

API commands: SetResellerTLDPricing

Example
The following query sets prices for some TLDs and services in account resellid, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SETRESELLERTLDPRICING& uid=resellid&pw=resellpw&account=443-up-6579& comprice=12.95&comrenew=12.95&comtransfer=12.95& netprice=12.95&netrenew=12.95&nettransfer=12.95& orgprice=8.95&orgrenew=8.95&orgtransfer=8.95& wpps=8.50&pop3=19.95&responsetype=xml

In the response, the list of TLDs and services and their prices, and the ErrCount value 0, confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <tlds> <price tld="biz" id="6" prod="10" /> <price tld="biz" id="6" prod="16" /> <price tld="biz" id="6" prod="19" /> <price tld="com" id="0" prod="10">12.95</price> <price tld="com" id="0" prod="16">12.95</price> <price tld="com" id="0" prod="19">12.95</price> <price tld="info" id="5" prod="10" /> <price tld="info" id="5" prod="16" /> <price tld="info" id="5" prod="19" /> <price tld="net" id="1" prod="10">12.95</price> <price tld="net" id="1" prod="16">12.95</price> <price tld="net" id="1" prod="19">12.95</price> <price tld="org" id="2" prod="10">12.95</price> <price tld="org" id="2" prod="16">12.95</price> <price tld="org" id="2" prod="19">12.95</price> </tlds> <tldcount>15</tldcount> <services> <service name="dotnamebundle" price="" /> </services> <servicescount>3</servicescount> <Command>SETRESELLERTLDPRICING</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site /> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <ExecTime>1.492188</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

571

1999-2008 eNom, Inc.

API commands: SetResellerTLDPricing

Related commands
AuthorizeTLD GetSubAccountDetails GetSubAccounts GetTLDList PE_GetTLDID PE_SetPricing RemoveTLD SetResellerServicesPricing

12/1/08

572

1999-2008 eNom, Inc.

API commands: SetSPFHosts

SetSPFHosts
Description
Definition
Create or update Sender Policy Framework (SPF) host records for a domain name.

Usage
Use this command to create or update SPF host records for a domain name. The SetSPFHosts command creates or updates one record per query. To set more than one SPF host record per query, use the SetHosts command.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/HostConfig.asp?DomainNameID=152533676

The host records setup section behaves similarly to the SetSPFHosts 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD HostID Required Required Required Required Required when updating an SPF host record Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Host ID number from our database. You can retrieve this value using the GetSPFHosts command.

Max size
20 20 63 15 10

HostName RecordType

Host name, assigned by you For SPF records, the required value is txt

63 5

12/1/08

573

1999-2008 eNom, Inc.

API commands: SetSPFHosts

Param name Obligation

Address MXPref Required Optional

Definition
The SPF record. For help writing this record, you can go to http://spf.pobox.com/wizard.html Host record preference for setting the SPF record. The lower the number, the higher the priority. If not specified, default value is 10. Format of response. Options are Text (default), HTML, or XML.

Max size
255 5

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets SPF host records for domain resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SETSPFHOSTS& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&HostName=test& Address=v%3dspf1%20mx%20ptr%20a:regular%20a:hostnames%20a:po%20mx:MX% 20mx:servers%20mx:to%20ip4:63.251.174.113%20include:myISP.net% 20include:mydomain.com%20-all&RecordType=txt&mxPref=&responsetype=xml

In the response, the ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <Command>SETSPFHOSTS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD>

12/1/08

574

1999-2008 eNom, Inc.

API commands: SetSPFHosts

<TimeDifference>+03.00</TimeDifference> <ExecTime>0.2382813</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetHosts GetSPFHosts SetHosts

12/1/08

575

1999-2008 eNom, Inc.

API commands: SetUpPOP3User

SetUpPOP3User
Description
Definition
Set up a POP3 mailbox for your domain.

Usage
Use this command when you have purchased a POP3 email pak (see PurchasePOPBundle) and want to set up mailboxes for your domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/POPConfig.asp?DomainNameID=152533676

On the POP3 Mail page, below the Add users to this Email Pak box, the save changes button calls the SetUpPOP3User 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. A POP mail pak must have been purchased for the domain and the correct BundleID supplied. There must be at least one mailbox available in the email pak (BundleID) referenced.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD BundleID Required Required Required Required Required Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) POP pak ID number to add the user to (must have already been purchased). The order confirmation for purchasing the bundle contains the Bundle ID, or you can retrieve it using the GetPOP3 command.

Max size
20 20 63 15 integer

12/1/08

576

1999-2008 eNom, Inc.

API commands: SetUpPOP3User

Param name Obligation Definition

POPUserName IsAdmin Required Optional The user name to set up (email address will be [email protected]). Should POPUserName have administrative privileges over all mailboxes associated with this domain name? Administrative privileges allow this user to reset the password for mailboxes, and delete mailboxes. Permitted values are: 0 Regular user (can change the password for their own mailbox but no one elses) 1 Administrator (when this user logs on to Webmail and goes to the admin page, he or she can see all mailboxes for this domain name, can reset passwords for any or all mailboxes, and can delete any or all mailboxes) POP3 password. User's full name, appears in Web mail. Format of response. Options are Text (default), HTML, or XML.

Max size
30 1

POPPassword POPFullName ResponseType

Required Optional Optional

50 60 4

Returned parameters and values

Param name Definition
RegistrarHold Command ErrCount Err(x) Done The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query creates mailbox [email protected] and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=SetupPop3user& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&BundleID=5134&POPUserName=james& POPPassword=resellpw&POPFullName=James+Doe&responsetype=xml

In the response, the value 0 for parameter ErrCount indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Command>SETUPPOP3USER</Command> <ErrCount>0</ErrCount>

12/1/08

577

1999-2008 eNom, Inc.

API commands: SetUpPOP3User

<Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
DeleteAllPOPPaks DeletePOP3 DeletePOPPak Forwarding GetCatchAll GetDotNameForwarding GetForwarding GetMailHosts GetPOP3 GetPOPForwarding ModifyPOP3 PurchasePOPBundle SetDotNameForwarding SetUpPOP3User

12/1/08

578

1999-2008 eNom, Inc.

API commands: StatusDomain

StatusDomain
Description
Definition
Get information about the status of a single domain name: registrar, expiration date, and whether it is in your account.

Usage
Use this command when you have received an RRPCode value of 724 when attempting to register a domain. The response for the Purchase command gives additional information explaining the 724 code. For other aspects of domain status, use the GetDomainStatus command for the fastest response.

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 query returns an error if the domain does not belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD OrderType ResponseType Required Required Required Required Optional Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Options are Purchase(default), Transfer or Extend. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 10 4

12/1/08

579

1999-2008 eNom, Inc.

API commands: StatusDomain

Returned parameters and values

Param name Definition
DomainName Registrar InAccount OrderID Command ErrCount Err(x) Done Name being statused Returns Known, Unknown, or None. Returns 0 if not in an eNom account, 1 if in your eNom account or 2 if in another eNom account. ID number of the most recent order that included this domain. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests information about domain resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=statusdomain& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <DomainStatus> <DomainName>resellerdocs.com</DomainName> <Registrar>Known</Registrar> <InAccount>1</InAccount> <ExpDate>6/25/2012 4:20:24 PM</ExpDate> <OrderID>156062089</OrderID> </DomainStatus> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>STATUSDOMAIN</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

580

1999-2008 eNom, Inc.

API commands: StatusDomain

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetDomainStatus GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew ValidatePassword

12/1/08

581

1999-2008 eNom, Inc.

API commands: SubAccountDomains

SubAccountDomains
Description
Definition
List the domains in a subaccount.

Usage
Use this command to list the domains in a subaccount.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/subaccount-list.asp

In the list of subaccounts, click any Enter link. Clicking the X domain names link produces a similar result to using the SubAccountDomains command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The subaccount must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Account Tab Required Required Required Required

Definition
Account login ID Account password Subaccount ID number, in NNN-aa-NNNN format. Use the GetSubAccounts command to retrieve this code. Which category of names to return. Permitted values are: iown names registered here ihost names that use our DNS hosting progress names that are expiring or expired watchlist names you are interested in Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 11 9

ResponseType

Optional

12/1/08

582

1999-2008 eNom, Inc.

API commands: SubAccountDomains

Returned parameters and values

Param name
Tab MultiRRP Domain-List Type DomainNameID SLD TLD NS-Status Expiration-Date Auto-Renew EndPosition PreviousRecords NextRecords OrderBy Result StartPosition DomainCount TotalDomainCount StartLetter Command ErrCount Err(x) Done

Definition
Category of names returned Do names in this account include credentials of more than one registrar? Description of the category of names returned Domain name ID number, from our records Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) YES indicates that this domain uses our default name servers Expiration date of this domain registration Is this domain set to renew automatically? Position in the overall list of the last domain returned with this query Number of domains in the overall list before the first domain in this list Number of domains in the overall list after the last domain in this list Sorting parameter for names Did this query yield any names? Position in the overall list of the first domain returned with this query Total number of domains in this subaccount Total number of domains in this parent account First letter of the domains returned with this query Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query returns the registered (iown) domain names in the subaccount, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SUBACCOUNTDOMAINS& uid=resellid&pw=resellpw&Account=493-yp-5836&tab=iown&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <GetDomains> <tab>iown</tab> <multirrp>False</multirrp> <domain-list type="Registered"> <domain>

12/1/08

583

1999-2008 eNom, Inc.

API commands: SubAccountDomains

<DomainNameID>152556719</DomainNameID> <sld>subresellerdocs</sld> <tld>com</tld> <ns-status>NA</ns-status> <expiration-date>8/2/2006</expiration-date> <auto-renew>Yes</auto-renew> </domain> <domain> <DomainNameID>152556721</DomainNameID> <sld>subresellerdocs2</sld> <tld>net</tld> <ns-status>NA</ns-status> <expiration-date>8/2/2006</expiration-date> <auto-renew>Yes</auto-renew> </domain> <domain> <DomainNameID>152556722</DomainNameID> <sld>subresellerdocs3</sld> <tld>info</tld> <ns-status>NA</ns-status> <expiration-date>8/2/2006</expiration-date> <auto-renew>Yes</auto-renew> </domain> </domain-list> <EndPosition>3</EndPosition> <PreviousRecords>0</PreviousRecords> <NextRecords>0</NextRecords> <OrderBy /> <Result>True</Result> <StartPosition>1</StartPosition> <DomainCount>3</DomainCount> <TotalDomainCount>225</TotalDomainCount> <StartLetter /> </GetDomains> <Command>SUBACCOUNTDOMAINS</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>e</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.2109375</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CreateAccount CreateSubAccount GetSubAccountDetails GetSubAccountPassword GetSubAccounts GetSubaccountsDetailList

12/1/08

584

1999-2008 eNom, Inc.

API commands: SynchAuthInfo

SynchAuthInfo
Description
Definition
Synchronize a domains EPP key with the Registry, and optionally email it to the registrant.

Usage
Use this command to create a new EPP key, synchronize the key with the Registry, and optionally email it to the registrant.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/domains/control-panel/default.asp?DomainNameID=152533676

On the General Settings page, the Email Auth Code to Registrant link calls the SynchAuthInfo 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD EmailEPP RunSynchAutoInfo

Obligation
Required Required Required Required Required Required

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Should we mail the EPP key to the registrant of this domain name? Permitted values are True and False Should we synchronize the EPP key for this domain and make sure our records are identical to the Registrys? Permitted values are True and False. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 5 5

ResponseType

Optional

12/1/08

585

1999-2008 eNom, Inc.

API commands: SynchAuthInfo

Returned parameters and values

Param name
InfoSynched EPPEmailMessage Command ErrCount Err(x) Done

Definition
Returns True if EPP key has been synchronized at Registry. This parameter displays when EmailEPP=False Returns confirmation that EPP key is emailed to registrant. This parameter displays when EmailEPP=True Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query synchronizes the EPP key between the Registry and our database, emails the EPP key to the registrant of record in our database, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=SynchAuthInfo& UID=resellid&pw=resellpw&sld=resellerdocs&tld=com&EmailEPP=True& RunSynchAutoInfo=True&ResponseType=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <EPPEmailMessage>Email has been sent.</EPPEmailMessage> <Command>SYNCHAUTHINFO</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>1.715</ExecTime> <Done>true</Done> <debug><![CDATA[ ]]></debug> </interface-response>

Related commands
TP_CreateOrder

12/1/08

586

1999-2008 eNom, Inc.

API commands: TP_CancelOrder

TP_CancelOrder
Description
Definition
Cancel a transfer order that has been submitted by eNom, but not yet processed by the Registry.

Usage
Use this command to cancel the parts of a transfer order that has been submitted by us, but not yet processed by the Registry (there is an interval of approximately 5 days between the two events).

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferStatus.asp?transferorderid=445425

On the Transfer Order Detail page, the Cancel This Order link calls the TP_CancelOrder command.
http://resellertest.enom.com/domains/TransferOrderReview.asp?TransferOrderID=445428& OrderType=Auto+Verification&RegistrantFirstName=&RegistrantLastName=

On the Pending orders page, the cancel button calls the TP_CancelOrder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The transfer order must be valid and must belong to this account. A transfer order can be conceled only for domains that have a TransferOrderDetail StatusID of 0, 9, 10, 11, 12, 13, 28, or 29. Use TP_GetOrderDetail to retrieve the statuses of each domain in the order.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation Definition
Required Required Account login ID Account password Transfer order ID number. To retrieve this value, use the TP_GetOrderStatuses command. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10 4

TransferOrderID Required ResponseType Optional

12/1/08

587

1999-2008 eNom, Inc.

API commands: TP_CancelOrder

Returned parameters and values

Param name Definition
Success Command ErrCount Err(x) Done Returns True if transfer request was successfully cancelled Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. To be eligible for cancellation, each domain must be in one of the following statuses. Retrieve an orders status by calling TP_GetOrder. Eligible TransferOrderDetail StatusIDs: 0 Transfer request created - awaiting fax 9 Awaiting auto verification of transfer request 10 Unable to retrieve current domain contacts from UWhois 11 Auto verification of transfer request initiated 12 Awaiting for auto transfer string validation 13 Domain awaiting transfer initiation 28 Fax received - awaiting registrant verification 29 Awaiting manual fax verification.

Example
The following query requests that transfer order ID 445413 be cancelled, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_CancelOrder& uid=resellid&pw=resellpw&transferOrderID=445413&responsetype=xml

In the response, the return value True for the Success parameter confirms the successful cancellation of the order:
<?xml version="1.0" ?> <interface-response> <success>True</success> <Command>TP_CANCELORDER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

588

1999-2008 eNom, Inc.

API commands: TP_CancelOrder

Related commands
PushDomain TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

589

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

TP_CreateOrder
Description
Definition
Transfer domains into an account. Accepts Fax and AutoVerification order types.

Usage
Use this command to create an order to transfer domains from another registrar to eNom or one of its resellers. You can also use this command to create but not submit a transfer order, using the PreConfig parameter.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferNew.asp

On the transfer a name page, the next button calls the TP_CreateOrder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. To use our credit card processing, this must be an ETP reseller account. All domain names in the order must be in top-level domains supported by this registrar. To transfer EPP names, the query must include the authorization key from the Registrar. When using the Fax order type, the registrant contact information must match the current Whois registrant.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW DomainCount

Obligation Definition
Required Required Required Account login ID Account password

Max size
20 20

The number of domain names to be 4 submitted on the order. This number must match the actual number of names submitted. Permitted values are Fax or Autoverification 20

OrderType

Required

12/1/08

590

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

Param name
SLDX X=1 to DomainCount TLDX AuthInfoX UseContacts ExtendedAttributes

Obligation Definition
Required Required Required for EPP TLDs Optional Required for TLDs that use extended attributes, when UseContacts =0 Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string Required for our CC processing Optional; Required for Fax orders and for our CC processing Optional Optional; Required for Fax orders and for our CC processing Optional; Required for Fax orders and for our CC processing Optional; Required for Fax orders Second-level domain name (for example, enom in enom.com) Top-level domain name (extension)

Max size
63 15

Current (losing) registrars authorization 20 key Set =1 to transfer existing WhoIs contacts 1 when the transfer is complete Extended attributes, required for some n/a country code TLDs. You can retrieve a list of required extended attributes for any TLD using the GetExtAttributes command.

UseCreditCard

3 Permitted values are yes and no. The credit card supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted or if UseCreditCard=no, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the Registrant contact and credit card information.

EndUserIP

End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN. Registrant address

15

RegistrantAddress1

60

RegistrantAddress2 RegistrantCity

Registrant additional address info Registrant city

60 60

RegistrantCountry

Registrant country

60

RegistrantEmailAddress

Registrant email address

128

12/1/08

591

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

Param name
RegistrantFax

Obligation Definition
Optional

Max size

Registrant fax number. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant first name 60

RegistrantFirstName

Optional; Required for Fax orders and for our CC processing Optional; Required for Fax orders and for our CC processing Optional Optional; Required for Fax orders Optional; Required for Fax orders and for our CC processing Required for our CC processing and for .org names when you supply new Registrant information Required for our CC processing Optional

RegistrantLastName

Registrant last name

60

RegistrantJobTitle RegistrantOrganizationName

Registrant job title Registrant organization

60 60

RegistrantPhone

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters.

20

RegistrantPostalCode

Registrant postal code

16

RegistrantStateProvince

Registrant state or province

60

RegistrantStateProvinceChoice

Registrant state or province choice: S state P province Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Cardholders name

CardType

Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing

20

CCName

60

CreditCardNumber

Credit card number

128

CreditCardExpMonth

Expiration month of the credit card, in format MM

12/1/08

592

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

Param name
CreditCardExpYear

Obligation Definition
Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Optional Expiration year of the credit card, in format YYYY Credit card verification code

Max size
4

CVV2

CCAddress

Credit card billing address

60

ChargeAmount

Amount to charge this credit card. Required format is DD.cc Set =1 to create, but not send, the order at this time. Using PreConfig=1 allows you to use TP_UpdateOrderDetail to modify DomainPassword, Lock, Renew, and contacts before submitting the order. When you are ready to submit the order, call TP_SubmitOrder. Set a domain access password on the domain name Set =1 to turn on RegistrarLock option Set =1 to turn on Auto-Renew option Authorization string for automated transfer order entries (approved accounts only)

PreConfig

DomainPassword Lock Renew AuthString

Optional Optional Optional Optional

16 1 1 100

ResponseType

Optional in all Format of response. Options are Text cases (default), HTML, or XML.

Returned parameters and values

Param name
Command ErrCount Err(x) Done

Definition
Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

TransferOrderID Transfer order number.

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 of SLD and TLD params: SLD1=firstSLD TLD1=firstTLD, SLD2=secondSLD TLD2=secondTLD.

12/1/08

593

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

Additional params for contact information can be passed by replacing Registrant in the param names above with Tech, Admin or AuxBilling. If UseContacts is set =1 and contact information is passed in the URL, current Whois contacts are transferred and preconfigured contacts (passed in the URL) are ignored. Automatic transfer of Whois information is available only for the largest registrars. An OrderType of Fax requires a signed fax to process the order, an OrderType of Autoverification uses an electronic verification process to authorize and initiate the transfer.

Example
The following query requests the creation of an autoverification transfer order, to transfer domains resellerdocs2.net and resellerdocs3.info, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_CreateOrder& uid=resellid&pw=resellpw&orderType=AutoVerification& sld1=resellerdocs2&tld1=net&AuthInfo1=ros8enQi& sld2=resellerdocs3&tld2=info&AuthInfo2=pkv7ihRb& domaincount=2&responsetype=xml

The response confirms the successful creation of transfer order 445413, and gives details of the transfer:
<?xml version="1.0" ?> <interface-response> <transferorder> <transferorderid>445413</transferorderid> <orderdate>7/29/2002 5:19:29 PM</orderdate> <ordertypeid>1</ordertypeid> <ordertypedesc>Auto Verification</ordertypedesc> <statusid>4</statusid> <statusdesc>Processing</statusdesc> <authamount>17.90</authamount> <version>1</version> <transferorderdetail> <transferorderdetailid>301770</transferorderdetailid> <sld>resellerdocs2</sld> <tld>net</tld> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc> <price>8.95</price> <usecontacts>0</usecontacts> </transferorderdetail> <transferorderdetail> <transferorderdetailid>301771</transferorderdetailid> <sld>resellerdocs3</sld> <tld>info</tld> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc> <price>8.95</price> <usecontacts>0</usecontacts> </transferorderdetail> <transferorderdetailcount>2</transferorderdetailcount> </transferorder> <success>True</success> <Command>TP_CREATEORDER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]>

12/1/08

594

1999-2008 eNom, Inc.

API commands: TP_CreateOrder

</debug> </interface-response>

Related commands
PushDomain SynchAuthInfo TP_CancelOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_GetTLDInfo TP_ResendEmail TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

595

1999-2008 eNom, Inc.

API commands: TP_GetDetailsByDomain

TP_GetDetailsByDomain
Description
Definition
Get transfer order information for a domain using sld.tld.

Usage
Use this command to retrieve status information on one domain name that is in the process of transferring.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferStatus.asp?transferorderid=445431

On the Transfer Order Detail page, one row of the Domain Name table returns the same information as one query using the TP_GetDetailsByDomain command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name must be in a transfer order that belongs to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

596

1999-2008 eNom, Inc.

API commands: TP_GetDetailsByDomain

Returned parameters and values

Param name Definition
OrderCount OrderIDX X=1 to OrderCount OrderDateX StatusIDX Number of transfer orders that have been submitted for this domain. Transfer order detail number. Indexed X when ResponseType=Text or HTML.

The date the order was submitted. Indexed X when ResponseType=Text or HTML. TransferOrderDetail status ID -- a number that indicates the status of this domain in the transfer process. See Notes. Indexed X when ResponseType=Text or HTML. TransferOrderDetail status descriptiona text description of the status of this domain in the transfer process. See Notes. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

StatusDescX

Command ErrCount Err(x) Done

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. TransferOrderDetail StatusID is the status of this domain in the transfer process: 0=Transfer request created - awaiting fax 5=Transferred successfully 9=Awaiting auto verification of transfer request 10=Unable to retrieve current domain contacts from UWhois 11=Auto verification of transfer request initiated 12=Awaiting for auto transfer string validation 13=Domain awaiting transfer initiation 14=Domain transfer initiated and awaiting approval 15=Canceled - cannot obtain domain contacts from UWhois 16=Canceled - domain contacts did not respond to verification e-mail 17=Canceled - domain contacts did not approve transfer of domain 18=Canceled - domain validation string is invalid 19=Canceled - Whois information provided does not match current registrant 20=Canceled - Domain is currently not registered and cannot be transferrred 21=Canceled - Domain is already registered in account and cannot be transferred 22=Canceled - Domain is locked at current registrar 23=Canceled - Transfer already initiated for this domain 24=Canceled - Unable to transfer due to unknown error 25=Canceled - Transfer rejected by losing registrar 26=Canceled - Transfer authorization fax not received 27=Canceled by customer 28=Fax received - awaiting registrant verification 29=Awaiting manual fax verification 30=Canceled - Domain name is invalid or is Invalid for Transfers 35=Transfer request not yet submitted.

12/1/08

597

1999-2008 eNom, Inc.

API commands: TP_GetDetailsByDomain

Example
The following query requests transfer information for resellerdocs2.net, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetDetailsByDomain& uid=resellid&pw=resellpw&sld=resellerdocs2&tld=net&responsetype=xml

The response confirms that resellerdocs2.net is part of transfer order ID 445413, and gives current status of that order:
<?xml version="1.0" ?> <interface-response> <TransferOrder> <orderid>445413</orderid> <orderdate>3/29/2003 5:19:29 PM</orderdate> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc> </TransferOrder> <ordercount>1</ordercount> <Command>TP_GETDETAILSBYDOMAIN</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResendEmail TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

598

1999-2008 eNom, Inc.

API commands: TP_GetOrder

TP_GetOrder
Description
Definition
Get a list of domains in a single transfer order.

Usage
Use this command to retrieve status information on each item in a transfer order.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferStatus.asp

On the transfer a name page, clicking a link in the Transfer Order ID column calls the TP_GetOrder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The transfer order ID must be valid. The transfer order must have originated from this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation Definition
Required Required Account login ID Account password Transfer order ID number. You can retrieve this number by calling the TP_GetOrderStatuses command. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10 4

TransferOrderID Required ResponseType Optional

12/1/08

599

1999-2008 eNom, Inc.

API commands: TP_GetOrder

Returned parameters and values

Param name
TransferOrderID OrderDate OrderTypeID OrderTypeDesc StatusID StatusDesc AuthAmount SLD TLD Price UseContacts Command ErrCount Err(x) Done

Definition
Transfer order number Date the order was entered Type ID of order Type of order Status ID of order. See Notes. Status description of order. See Notes. Charge amount for this order Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Cost of the name transfer Use original contacts or not Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

TransferOrderDetailID Transfer order detail number

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. TransferOrder StatusID: 0 Transfer request has been made 1 Fax has been received 2 Order canceled 3 Order complete 4 Processing 5 Order not submitted TransferOrderDetail StatusID: 0 Transfer request created - awaiting fax 1 WhoIs information matches 2 Canceled due to WhoIs error 3 Pending due to domain status 4 Canceled due to domain status 5 Transferred and paid successfully 6 Transfer incomplete - charge problem 7 Frozen due to charge problem 8 NSI rejected transfer 9 Awaiting auto verification of transfer request 10 Unable to retrieve current domain contacts from UWhois 11 Auto verification of transfer request initiated 12 Awaiting for auto transfer string validation 13 Domain awaiting transfer initiation 14 Domain transfer initiated and awaiting approval

12/1/08

600

1999-2008 eNom, Inc.

API commands: TP_GetOrder

15 Canceled - cannot obtain domain contacts from UWhois 16 Canceled - domain contacts did not respond to verification e-mail 17 Canceled - domain contacts did not approve transfer of domain 18 Canceled - domain validation string is invalid 19 Canceled - Whois information provided does not match current registrant 20 Canceled - Domain is currently not registered and cannot be transferred 21 Canceled - Domain is already registered in account and cannot be transferred 22 Canceled - Domain is locked at current registrar, or is not yet 60 days old 23 Canceled - Transfer already initiated for this domain 24 Canceled - Unable to transfer due to unknown error 25 Canceled - The current registrar has rejected transfer (please contact them for details) 26 Canceled - Transfer authorization fax not received 27 Canceled by customer 28 Fax received - awaiting registrant verification 29 Awaiting manual fax verification 30 Canceled - Domain name is invalid or is Invalid for Transfers 31 Canceled - Domain is currently undergoing transfer by another Registrar 32 Canceled - Invalid EPP/authorization key - Please contact current registrar to obtain correct key 33 Canceled - Cannot transfer domain from name-only account 34 Unable to complete transfer. Transfers must include a change in registrar. 35 Transfer request not yet submitted 36 Canceled - Account is not authorized to perform domain transfers 37 Canceled - Domain was not retagged or not retagged in time by losing registrar 45 Order cancelled

Example
The following query requests transfer information for transfer order ID 445413, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetOrder& uid=resellid&pw=resellpw&TransferOrderID=445413&responsetype=xml

The response provides information on transfer order ID 445413:

<?xml version="1.0" ?> <interface-response> <transferorder> <transferorderid>445413</transferorderid> <orderdate>7/29/2002 5:19:29 PM</orderdate> <ordertypeid>1</ordertypeid> <ordertypedesc>Auto Verification</ordertypedesc> <statusid>4</statusid> <statusdesc>Processing</statusdesc> <authamount>17.90</authamount> <version>1</version> <transferorderdetail> <transferorderdetailid>301770</transferorderdetailid> <sld>resellerdocs2</sld> <tld>net</tld> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc> <price>8.95</price> <usecontacts>0</usecontacts> </transferorderdetail> <transferorderdetail> <transferorderdetailid>301771</transferorderdetailid> <sld>resellerdocs3</sld> <tld>info</tld> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc>

12/1/08

601

1999-2008 eNom, Inc.

API commands: TP_GetOrder

<price>8.95</price> <usecontacts>0</usecontacts> </transferorderdetail> <transferorderdetailcount>2</transferorderdetailcount> </transferorder> <Command>TP_GETORDER</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

602

1999-2008 eNom, Inc.

API commands: TP_GetOrderDetail

TP_GetOrderDetail
Description
Definition
Get information for a single domain on a transfer order.

Usage
Use this command to retrieve a long list of information on a single domain that is in the process of transferring.

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 transfer order detail ID must belong to a transfer order created under this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation Definition
Required Required Account login ID Account password Transfer order detail number returned by calling TP_GetOrder. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10 4

TransferOrderDetailID Required ResponseType Optional

Returned parameters and values

Param name
SLD TLD Lock Renew

Definition
Second level name Top level name Lock status of the name Renew status of the name

TransferOrderDetailID Transfer order detail number

12/1/08

603

1999-2008 eNom, Inc.

API commands: TP_GetOrderDetail

Param name
DomainPassword StatusID StatusDesc Price UseContacts Command ErrCount Err(x) Done

Definition
Password to be set for the name Status ID of this order. See Notes. Status description of this order. See Notes. Charge amount for this order Use original contacts or not Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. TransferOrderDetail StatusID and StatusDesc: 0 Transfer request created - awaiting fax 1 WhoIs information matches 2 Canceled due to WhoIs error 3 Pending due to domain status 4 Canceled due to domain status 5 Transferred and paid successfully 6 Transfer incomplete - charge problem 7 Frozen due to charge problem 8 NSI rejected transfer 9 Awaiting auto verification of transfer request 10 Unable to retrieve current domain contacts from UWhois 11 Auto verification of transfer request initiated 12 Awaiting for auto transfer string validation 13 Domain awaiting transfer initiation 14 Domain transfer initiated and awaiting approval 15 Canceled - cannot obtain domain contacts from UWhois 16 Canceled - domain contacts did not respond to verification e-mail 17 Canceled - domain contacts did not approve transfer of domain 18 Canceled - domain validation string is invalid 19 Canceled - Whois information provided does not match current registrant 20 Canceled - Domain is currently not registered and cannot be transferred 21 Canceled - Domain is already registered in account and cannot be transferred 22 Canceled - Domain is locked at current registrar, or is not yet 60 days old 23 Canceled - Transfer already initiated for this domain 24 Canceled - Unable to transfer due to unknown error 25 Canceled - The current registrar has rejected transfer (please contact them for details) 26 Canceled - Transfer authorization fax not received 27 Canceled by customer 28 Fax received - awaiting registrant verification 29 Awaiting manual fax verification 30 Canceled - Domain name is invalid or is Invalid for Transfers 31 Canceled - Domain is currently undergoing transfer by another Registrar 32 Canceled - Invalid EPP/authorization key - Please contact current registrar to obtain correct key

12/1/08

604

1999-2008 eNom, Inc.

API commands: TP_GetOrderDetail

33 Canceled - Cannot transfer domain from name-only account 34 Unable to complete transfer. Transfers must include a change in registrar. 35 Transfer request not yet submitted 36 Canceled - Account is not authorized to perform domain transfers 37 Canceled - Domain was not retagged or not retagged in time by losing registrar 45 Order cancelled

Example
The following query requests information on transfer order detail (one item in a transfer order) ID 301770, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetOrderDetail& uid=resellid&pw=resellpw&TransferOrderDetailID=301770&responsetype=xml

The response indicates that tranfer order detail ID 301770 is for the transfer of domain resellerdocs2.net, and provides details of the order:
<?xml version="1.0" ?> <interface-response> <transferorderdetail> <transferorderdetailid>301770</transferorderdetailid> <sld>resellerdocs2</sld> <tld>net</tld> <lock>True</lock> <renew>False</renew> <domainpassword /> <statusid>9</statusid> <statusdesc>Awaiting auto verification of transfer request</statusdesc> <price>8.95</price> <usecontacts>0</usecontacts> <ordertype /> <contacts> <Registrant>None</Registrant> <AuxBilling>None</AuxBilling> <Tech>None</Tech> <Admin>None</Admin> <Billing> <BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID> <BillingAddress1>111 Main Street</BillingAddress1> <BillingAddress2 /> <BillingCity>Hometown</BillingCity> <BillingCountry>US</BillingCountry> <BillingEmailAddress>[email protected]</BillingEmailAddress> <BillingFax>+1.5555555556</BillingFax> <BillingFirstName>John</BillingFirstName> <BillingJobTitle>President</BillingJobTitle> <BillingLastName>Doe</BillingLastName> <BillingOrganizationName>Reseller Documents Inc.</BillingOrganizationName> <BillingPhone>+1.5555555555</BillingPhone> <BillingPostalCode>99999</BillingPostalCode> <BillingStateProvince>WA</BillingStateProvince> <BillingStateProvinceChoice>S</BillingStateProvinceChoice> <BillingFullCountry>United States</BillingFullCountry> <UseRegInfoAbove>True</UseRegInfoAbove> <auxID /> <regID /> </Billing> </contacts> </transferorderdetail> <Command>TP_GETORDERDETAIL</Command> <ErrCount>0</ErrCount>

12/1/08

605

1999-2008 eNom, Inc.

API commands: TP_GetOrderDetail

<Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResendEmail TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

606

1999-2008 eNom, Inc.

API commands: TP_GetOrderReview

TP_GetOrderReview
Description
Definition
Retrieve information on a transfer order.

Usage
Use this comand to retrieve information on a transfer order a request originated by you to transfer a name into your account. This command differs from the TP_GetOrderDetail command in that TP_GetOrderDetail retrieves a larger set of information, including the status of the order and detailed contact information.

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 transfer order must have originated from this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation
Required Required

Definition
Account login ID Account password

Max size
20 20

TransferOrderID Required

Order ID number that was returned when you originated 7 your transfer. You can also retrieve this number using the TP_GetOrderStatuses comand. Permitted value is Transfer Format of response. Options are Text (default), HTML, or XML. 8 4

OrderType ResponseType

Required Optional

12/1/08

607

1999-2008 eNom, Inc.

API commands: TP_GetOrderReview

Returned parameters and values

Param name
TransferOrderID OrderType TransferOrderDetailID SLD TLD Price Lock Renew DomainPassword UseContacts AuthInfo RRProcessor TransferOrderDetailCount TransferTotalPrice AuthInfoStillRequired

Definition
ID number of the transfer order Type of the order Transfer order detail ID number, from our records Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Price that will be charged to this account if the transfer is successful Registrar lock setting that was specified in the transfer order Auto-renew setting that was specified in the transfer order Domain password, if one was specified in the transfer order Use this accounts default contacts EPP Key associated with this domain. Some TLDs require this code to authorize a transfer RRProcessor we use Number of domain names in this order Total charges if all domains in this order transfer successfully Yes indicates we have not yet received the EPP key (authorization code) for at least one domain in this order. If you use the TP_CreateOrder command to begin an order, then allow customers to supply authorization codes on a separate page before using TP_SubmitOrder, you would use this value to determine whether to display the auth code page. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query requests details on transfer order 465681 and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetOrderReview& uid=resellid&pw=resellpw&TransferOrderID=465681&OrderType=Transfer& responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <transferorderid>465681</transferorderid> <ordertype>Transfer</ordertype> <transferorderreview>

12/1/08

608

1999-2008 eNom, Inc.

API commands: TP_GetOrderReview

<transferorderdetail> <transferorderdetailid>311389</transferorderdetailid> <sld>transferdomain</sld> <tld>com</tld> <price>8.95</price> <lock>True</lock> <renew>True</renew> <domainpassword /> <usecontacts>1</usecontacts> <authinfo /> <RRProcessor>Reseller Documents Inc.</RRProcessor> </transferorderdetail> <transferorderdetailcount>1</transferorderdetailcount> <transfertotalprice>8.95</transfertotalprice> <authinfostillrequired>No</authinfostillrequired> </transferorderreview> <Command>TP_GETORDERREVIEW</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>e</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.1132813</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

609

1999-2008 eNom, Inc.

API commands: TP_GetOrdersByDomain

TP_GetOrdersByDomain
Description
Definition
Retrieve transfer information for a domain name.

Usage
Use this command to list a history and status of transfer orders for a domain name.

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 domain name must belong to this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW SLD TLD ResponseType Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

Returned parameters and values

Param name
OrderCount TransferOrderIDX X=1 to OrderCount

Definition
Number of transfer orders that have been submitted for this domain. Transfer order detail number. Indexed X when ResponseType=Text or HTML.

12/1/08

610

1999-2008 eNom, Inc.

API commands: TP_GetOrdersByDomain

Param name
LoginIDX OrderDateX OrderStatusX StatusIDX

Definition
The account this transfer order is in. Indexed X when ResponseType=Text or HTML. The date the order was submitted. Indexed X when ResponseType=Text or HTML. Current status of the order. Indexed X when ResponseType=Text or HTML. TransferOrder StatusID number. Options are: 0 New 1 Authorization Succeeded 2 Authorization Failed 3 Processing 4 Order queued 5 Ready for Billing 6 Order complete 7 Order canceled. Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Command ErrCount Err(x) Done

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
The following query requests transfer order information for domain name resellerdocs2.net, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetOrdersByDomain& uid=resellid&pw=resellpw&sld=resellerdocs2&tld=net&responsetype=xml

The response indicates that resellerdocs2.net is in transfer order ID 445413, initiated by account resellid:
<?xml version="1.0" ?> <interface-response> <TransferOrder> <transferorderid>445413</transferorderid> <loginid>resellid</loginid> <orderdate>7/29/2002 5:19:29 PM</orderdate> <orderstatus>Processing</orderstatus> <statusid>4</statusid> </TransferOrder> <ordercount>1</ordercount> <Command>TP_GETORDERSBYDOMAIN</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug>

12/1/08

611

1999-2008 eNom, Inc.

API commands: TP_GetOrdersByDomain

<![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

612

1999-2008 eNom, Inc.

API commands: TP_GetOrderStatuses

TP_GetOrderStatuses
Description
Definition
Get a list of orders including Closed for the last 6 months.

Usage
Use this command to list all transfer orders for an account ID.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/Transfers.asp

On the transfer a name page, the Click here to view existing transfer orders link calls the TP_GetOrderStatuses 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW IncludeClosedOrders ResponseType

Obligation Definition
Required Required Optional Optional Account login ID Account password Set =1 to return closed orders in the list. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 1 4

Returned parameters and values

Param name
OrderDate OrderTypeID

Definition
Date the order was entered Type ID of order

TransferOrderID Transfer order number

12/1/08

613

1999-2008 eNom, Inc.

API commands: TP_GetOrderStatuses

Param name
OrderTypeDesc StatusID

Definition
Type of order Status ID of transfer order. Options: 0 Transfer request has been made 1 Fax has been received 2 Order canceled 3 Order complete 4 Processing 5 Order not submitted Status description of transfer order. See text descriptions of statuses in StatusID parameter, above. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

StatusDesc Command ErrCount Err(x) Done

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. The OrderIDs returned can be used to call functions to view or update transfer orders.

Example
The following query requests the status of all transfer orders by account resellid, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GetOrderStatuses& uid=resellid&pw=resellpw&responsetype=xml

The response lists the status of every transfer order placed by resellid. The complete output for transfer order ID 445413 is included here; details of other orders are abridged:
<?xml version="1.0" ?> <interface-response> <transferorder> <transferorderid>445413</transferorderid> <orderdate>2002-07-29T17:19:29.437</orderdate> <statusid>4</statusid> <tos> <statusdesc>Processing</statusdesc> <ordertypeid>1</ordertypeid> <tot> <ordertypedesc>Auto Verification</ordertypedesc> </tot> </tos> </transferorder> <transferorder> . . . </transferorder>

12/1/08

614

1999-2008 eNom, Inc.

API commands: TP_GetOrderStatuses

<FoundAtLeastOnePendingOrder>False</FoundAtLeastOnePendingOrder> <Command>TP_GETORDERSTATUSES</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

615

1999-2008 eNom, Inc.

API commands: TP_GetTLDInfo

TP_GetTLDInfo
Description
Definition
Retrieve a list of information required for transferring domains, for each TLD.

Usage
Use this command to list the information that each Registry requires when domains are transferred. A typical use for this command is administrative. When your customers submit transfer requests, you can use this command to guide you in what is required for processing the orders.

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.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW QueryFlag Required Required Required

Definition
Account login ID Account password Which subset of TLDs to return. Permitted values are: 0 All TLDs 1 Transferable TLDs 2 Transferable via auto-verification 3 Transferable via fax 4 Authorization key required for transfer 5 Lockable TLDs 6 Both lockable and transferable Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 1

ResponseType

Optional

12/1/08

616

1999-2008 eNom, Inc.

API commands: TP_GetTLDInfo

Returned parameters and values

Param name
TLDIDX TLDX ProtocolX AbleToLockX RealTimeX TransferableX HasAuthInfoX

Definition
ID number for this TLD, used by our database. Indexed X when ResponseType=Text or HTML. Top-level domain name (extension). Indexed X when ResponseType=Text or HTML. Registry protocol. Indexed X when ResponseType=Text or HTML. Registry permits locking (user ability to prevent domain from being transfered without authorization)? Indexed X when ResponseType=Text or HTML. Registry processes domain registrations in real time? Indexed X when ResponseType=Text or HTML. Is this TLD transferable? Indexed X when ResponseType=Text or HTML. Does this TLD require an authorization code for transfers? Indexed X when ResponseType=Text or HTML.

TransByAutoVeriX Does this Registry permit transfers by auto-verification? Indexed X when ResponseType=Text or HTML. TransByFaxX Command ErrCount Err(x) Done Does this Registry permit transfers by fax? Indexed X when ResponseType=Text or HTML. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of TLDs that satisfy QueryFlag=6TLDs that are both lockable and transferableand sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_GETTLDINFO& uid=resellid&pw=resellpw&QueryFlag=6&ResponseType=XML

In the response, a list of TLDs and their characteristics, and an ErrCount value 0, confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <tldtable> <tld> <TLDID>0</TLDID> <TLD>com</TLD> <Protocol>RRP</Protocol> <AbleToLock>True</AbleToLock> <RealTime>True</RealTime> <Transferable>True</Transferable>

12/1/08

617

1999-2008 eNom, Inc.

API commands: TP_GetTLDInfo

<HasAuthInfo>False</HasAuthInfo> <TransByAutoVeri>True</TransByAutoVeri> <TransByFax>True</TransByFax> </tld> <tld> <TLDID>1</TLDID> <TLD>net</TLD> <Protocol>RRP</Protocol> <AbleToLock>True</AbleToLock> <RealTime>True</RealTime> <Transferable>True</Transferable> <HasAuthInfo>False</HasAuthInfo> <TransByAutoVeri>True</TransByAutoVeri> <TransByFax>True</TransByFax> </tld> <tld> <TLDID>2</TLDID> <TLD>org</TLD> <Protocol>EPP</Protocol> <AbleToLock>True</AbleToLock> <RealTime>True</RealTime> <Transferable>True</Transferable> <HasAuthInfo>True</HasAuthInfo> <TransByAutoVeri>True</TransByAutoVeri> <TransByFax>True</TransByFax> </tld> <tld> <TLDID>3</TLDID> <TLD>cc</TLD> <Protocol>RRP</Protocol> <AbleToLock>True</AbleToLock> <RealTime>True</RealTime> <Transferable>True</Transferable> <HasAuthInfo>False</HasAuthInfo> <TransByAutoVeri>True</TransByAutoVeri> <TransByFax>True</TransByFax> </tld> </tldtable> <tldcount>4</tldcount> <Command>TP_GETTLDINFO</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1171875</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

618

1999-2008 eNom, Inc.

API commands: TP_GetTLDInfo

Related commands
AddToCart TP_CancelOrder TP_CreateOrder TP_GetOrderStatuses TP_SubmitOrder TP_UpdateOrderDetail

12/1/08

619

1999-2008 eNom, Inc.

API commands: TP_ResendEmail

TP_ResendEmail
Description
Definition
Resend the Domain Transfer Request authorization email. This is the email we send to the WhoIs contact on record at the Registry, requesting their authorization to transfer the domain name into the account specified in this query string.

Usage
Use this command to resend the Domain Transfer Request email for a transfer. You would typically use this command when the owner who is losing the domain updates their email address after we have sent an initial authorization email. This command can only be used between the time we send an initial Domain Transfer Request email, and the time we receive a response.

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 domain name must be one that is transferring into this account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW SLD TLD ResponseType Required Required Required Required Optional

Definition
Login ID of the account that requested the transfer (the gaining account) Password of the account that requested the transfer (the gaining account) Second-level domain name (for example, enom in enom.com) of the domain to be transferred Top-level domain name (extension) of the domain to be transferred Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 4

12/1/08

620

1999-2008 eNom, Inc.

API commands: TP_ResendEmail

Returned parameters and values

Param name Definition
Success Command ErrCount Err(x) Done True indicates the query was successful Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

Notes
If you are transferring a domain name between two of your own accounts at different registrars, you can reduce delays by updating your email address in the losing account before you submit a transfer order. 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
The following query resends confirmation emails for the transfer of resellerdocs3.info, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_RESENDEMAIL& uid=resellid&pw=resellpw&SLD=resellerdocs3&tld=info&responsetype=xml

In the response, a Success value of True indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <Success>True</Success> <Command>TP_RESENDEMAIL</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod>1</MinPeriod> <MaxPeriod>10</MaxPeriod> <Server>Reseller5</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <TimeDifference>+03.00</TimeDifference> <ExecTime>0.15625</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

621

1999-2008 eNom, Inc.

API commands: TP_ResendEmail

Related commands
TP_CreateOrder TP_GetDetailsByDomain TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder

12/1/08

622

1999-2008 eNom, Inc.

API commands: TP_ResubmitLocked

TP_ResubmitLocked
Description
Definition
Resubmit a request for a previously locked domain name.

Usage
Use this command after you have previously submitted a transfer request, received an error message saying the domain was locked, and have had the registrant of the domain unlock it. This command may also be used to resubmit a transfer that was rejected because the domain was registered less than 60 days ago.

Availability
All resellers have access to this command.

Implementation on eNom.com
On the Transfer order detail page, the Resubmit locked domain link (when it is present) calls the TP_ResubmitLocked command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The transfer order detail ID must be valid. The transfer order detail ID must belong to a domain that previously failed to transfer because it was locked.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW

Obligation Definition
Required Required Account login ID Account password Transfer Order Detail ID. To retrieve this value, use the TP_GetOrder command. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 10 4

TransferOrderDetailID Required ResponseType Optional

12/1/08

623

1999-2008 eNom, Inc.

API commands: TP_ResubmitLocked

Returned parameters and values

Param name
Command ErrCount Err(x) Done

Definition
Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

TransferOrderID New Transfer Order ID

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
Previously, account resellid had requested that a domain be transferred into this account, and received an e-mail stating that the transfer could not complete because the domain was locked. The owner of account resellid contacted the owner of the domain and had the lock removed. The following query resubmits the transfer request, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_ResubmitLocked& uid=resellid&pw=resellpw&TransferOrderDetailID=607291&responsetype=xml

The Success=True parameter value in the response, and the new TransferOrderID, confirm a successful request:
<?xml version="1.0" ?> <interface-response> <transferorder> <transferorderid>952245</transferorderid> </transferorder> <success>True</success> <Command>TP_RESUBMITLOCKED</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![ CDATA[ ] ]> </debug> </interface-response>

12/1/08

624

1999-2008 eNom, Inc.

API commands: TP_ResubmitLocked

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResendEmail TP_SubmitOrder TP_UpdateOrderDetail UpdatePushList

12/1/08

625

1999-2008 eNom, Inc.

API commands: TP_SubmitOrder

TP_SubmitOrder
Description
Definition
Submit a preconfigured transfer order.

Usage
Use this command to submit a transfer order that has been created and configured using the TP_CreateOrder command, but not submitted. Domain names in this status appear on the Pending orders page.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferNew.asp

Enter a domain name and click next. On the Pending orders page, the submit button calls the TP_SubmitOrder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. To use our credit card processing, this must be an ETP reseller account. The TransferOrderID must identify an order that has been successfully created but not submitted.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW TransferOrderID EndUserIP

Obligation Definition
Required Required Required Required for our CC processing Account login ID Account password Transfer order ID number. To retrieve this value, use the TP_GetOrderStatuses command. End users IP address. This is used in fraud checking, as part of our order processing service. Use format NNN.NNN.NNN.NNN.

Max size
20 20 10 15

12/1/08

626

1999-2008 eNom, Inc.

API commands: TP_SubmitOrder

Param name
UseCreditCard

Obligation Definition
Optional for resellers who use our credit card processing AND want to charge this transaction to the credit card included in this query string Required for our CC processing Required for our CC processing Required for our CC processing Optional for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing and for .org names when you supply new Registrant information Required for our CC processing

Max size

Permitted values are yes and no. The credit card 3 supplied in this query string is charged only if UseCreditCard=yes. If this param is omitted or if UseCreditCard=no, the account balance rather than the credit card is debited for this transaction. This is true even if the query string includes all the Registrant contact and credit card information.

RegistrantFirstName

Registrant first name

60

RegistrantLastName

Registrant last name

60

RegistrantAddress1

First line of Registrant address

60

RegistrantAddress2

Second line of Registrant address

60

RegistrantCity

Registrant city

60

RegistrantCountry

Registrant country. Two-letter country code is a permitted format. Registrant postal code

60

RegistrantPostalCode

16

RegistrantPhone

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant email address

20

RegistrantEmailAddress Required for our CC processing CardType Required for our CC processing Required for our CC processing Required for our CC processing

128

Credit card type. Permitted values are Visa, Mastercard, AmEx, Discover Cardholders name

20

CCName

60

CreditCardNumber

Credit card number

128

12/1/08

627

1999-2008 eNom, Inc.

API commands: TP_SubmitOrder

Param name
CreditCardExpMonth

Obligation Definition
Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Required for our CC processing Optional Expiration month of the credit card, in format MM

Max size
2

CreditCardExpYear

Expiration year of the credit card, in format YYYY

CVV2

Credit card verification code

CCAddress

Credit card billing address

60

ChargeAmount

Amount to charge this credit card. Required format 6 is DD.cc Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
Transfer order 445440 was created with command TP_CreateOrder, with parameter PreConfig=1. With that parameter value, the order was created and a transfer order ID was assigned, but the order was not submitted instantly. The following query uses the transfer order ID to submit the preconfigured order, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_SubmitOrder& uid=resellid&pw=resellpw&TransferOrderID=445440&responsetype=xml

In the response, the error count of 0 indicates that the order was submitted successfully:
<?xml version="1.0" ?> <interface-response> <success>True</success> <Command>TP_SUBMITORDER</Command> <ErrCount>0</ErrCount>

12/1/08

628

1999-2008 eNom, Inc.

API commands: TP_SubmitOrder

<Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_GetTLDInfo TP_ResendEmail TP_ResubmitLocked TP_UpdateOrderDetail UpdatePushList

12/1/08

629

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

TP_UpdateOrderDetail
Description
Definition
Update a preconfigured transfer order before submitting the order.

Usage
Use this command to configure registrar lock, auto-renew, domain password, or contact information for a domain name that is in the process of being transferred to eNom. This command is typically used after an order has been created using the TP_CreateOrder command with the parameter PreConfig=1. Once the transfer order has been configured using this command, the next step is typically to use the TP_SubmitOrder command, which causes the transfer order to be processed.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/TransferNew.asp

Enter a domain name and click next. On the Pending orders page, click the domain name. In the Editing transfer order for domain name box, the check boxes set the parameter values for the TP_UpdateOrderDetail command, and the next button calls the command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The transfer order detail ID must be valid and must be part of an order created under this account. The transfer order must be in a StatusID of 5 (Order not submitted).

12/1/08

630

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW TransferOrderDetailID

Obligation Definition
Required Required Required Account login ID Account password Transfer order detail ID. Use the TP_GetOrder command to retrieve this value. Set registrar lock on the name. Permitted values are True or False. Set auto-renew. Permitted values are True or False. Set a domain password on the name Remove all names from this order,. To remove all names, supply DeleteOrderDetail=Yes Registrant address

Max size
20 20 10

Lock

Optional; default is True Optional; default is True Optional Optional

Renew

DomainPassword DeleteOrderDetail

60 3

RegistrantAddress1

Optional; Required for Fax orders Optional Optional; Required for Fax orders Optional; Required for Fax orders

60

RegistrantAddress2 RegistrantCity

Registrant additional address info Registrant city

60 60

RegistrantCountry

Registrant country

60

RegistrantEmailAddress

Registrant email address Optional; Required for Fax orders and for .org names for which you are supplying new Registrant information Optional

128

RegistrantFax

Registrant fax number. Required format is 20 +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant first name 60

RegistrantFirstName

Optional; Required for Fax orders Optional; Required for Fax orders Optional

RegistrantLastName

Registrant last name

60

RegistrantJobTitle

Registrant job title

60

12/1/08

631

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

Param name
RegistrantOrganizationName

Obligation Definition
Optional; Required for Fax orders Optional; Required for Fax orders Optional Optional Optional Registrant organization

Max size
60

RegistrantPhone

Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant postal code Registrant state or province Registrant state or province choice: S state P province

20

RegistrantPostalCode RegistrantStateProvince RegistrantStateProvinceChoice

16 60 1

UseContacts ExtendedAttributes

Optional Required for TLDs that use extended attributes, when UseContacts =0 Optional

Set =1 to transfer existing WhoIs contacts 1 when the transfer is complete Extended attributes, required for some n/a country code TLDs. You can retrieve a list of required extended attributes for any TLD using the GetExtAttributes command.

RegistrantUseContact

If set =none then Billing contact will be used, otherwise Registrant contact data must be submitted Technical contact data. See Note.

Tech* TechUseContact

Optional Optional

If set =none then no contact will be used, 3 otherwise Tech contact data must be submitted. Auxiliary Billing contact data. See Note. * If set =none then no contact will be used, 3 otherwise Auxbilling contact data must be submitted. Format of response. Options are Text (default), HTML, or XML. 4

AuxBilling* AuxBillingUseContact

Optional Optional

ResponseType

Optional

Returned parameters and values

Param name
TransferOrderDetailID SLD TLD lock renew domainpassword statusid statusdesc price usecontacts Registrant*

Definition
Transfer order detail number Second-level domain name Top-level domain name Registrar lock status Auto-renew status Password to set for the domain name Status ID of the order Description of the status Transfer price Use the current contacts flag Registrant contact data

12/1/08

632

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

Param name
AuxBilling* Tech* Admin* Billing* Command ErrCount Err(x) Done

Definition
Auxilliary Billing contact data Technical contact data Administrative contact data Billing contact data Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. To update Technical or Auxilliary Billing contacts submit the contact data by replacing Registrant* param names with Tech* or AuxBilling* param names.

Example
The following query requests that for transfer order detail ID 301770, the registrar lock and automatic renew options both be set to On. It also instructs that contact information should remain unchanged, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=TP_UpdateOrderDetail& uid=resellid&pw=resellpw&TransferOrderDetailID=301770&Lock=On&Renew=On& RegistrantUseContact=none&TechUseContact=none&AuxBillingUseContact=none&responsetype=xml

The response indicates the successful setting of the registrar lock and automatic renew options:
<?xml version="1.0" ?> <interface-response> <transferorderdetail> <transferorderdetailid>301770</transferorderdetailid> <sld>resellerdocs2</sld> <tld>net</tld> <lock>True</lock> <renew>True</renew> <domainpassword /> <statusid>10</statusid> <statusdesc>Unable to retrieve current domain contacts from UW</statusdesc> <price>8.95</price> <usecontacts>0</usecontacts> <ordertype /> <contacts> <Registrant> <RegistrantPartyID> {BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629} </RegistrantPartyID> <RegistrantAddress1>111 Main Street</RegistrantAddress1> <RegistrantAddress2 /> <RegistrantCity>Hometown</RegistrantCity> <RegistrantCountry>US</RegistrantCountry>

12/1/08

633

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

<RegistrantEmailAddress>[email protected]</RegistrantEmailAddress> <RegistrantFax>555-555-5556</RegistrantFax> <RegistrantFirstName>John</RegistrantFirstName> <RegistrantJobTitle>President</RegistrantJobTitle> <RegistrantLastName>Doe</RegistrantLastName> <RegistrantOrganizationName>Reseller Documents Inc.</RegistrantOrganizationName> <RegistrantPhone>555-555-5555</RegistrantPhone> <RegistrantPostalCode>99999</RegistrantPostalCode> <RegistrantStateProvince>WA</RegistrantStateProvince> <RegistrantStateProvinceChoice>S</RegistrantStateProvinceChoice> </Registrant> <AuxBilling>None</AuxBilling> <Tech>None</Tech> <Admin>None</Admin> <Billing> <BillingPartyID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</BillingPartyID> <BillingAddress1>111 Main Street</BillingAddress1> <BillingAddress2 /> <BillingCity>Hometown</BillingCity> <BillingCountry>US</BillingCountry> <BillingEmailAddress>[email protected]</BillingEmailAddress> <BillingFax>555-555-5556</BillingFax> <BillingFirstName>John</BillingFirstName> <BillingJobTitle>President</BillingJobTitle> <BillingLastName>Doe</BillingLastName> <BillingOrganizationName>Reseller Documents Inc.</BillingOrganizationName> <BillingPhone>555-555-5555</BillingPhone> <BillingPostalCode>99999</BillingPostalCode> <BillingStateProvince>WA</BillingStateProvince> <BillingStateProvinceChoice>S</BillingStateProvinceChoice> <BillingFullCountry>United States</BillingFullCountry> <UseBelowAuxInfo>True</UseBelowAuxInfo> <auxID /> <regID>{BB4A2DE1-6485-45CB-A4FC-EE39BA0C1629}</regID> </Billing> </contacts> </transferorderdetail> <success>True</success> <Command>TP_UPDATEORDERDETAIL</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

634

1999-2008 eNom, Inc.

API commands: TP_UpdateOrderDetail

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrderReview TP_GetOrdersByDomain TP_GetOrderStatuses TP_GetTLDInfo TP_ResubmitLocked TP_SubmitOrder UpdatePushList

12/1/08

635

1999-2008 eNom, Inc.

API commands: UpdateAccountInfo

UpdateAccountInfo
Description
Definition
Update a variety of account information, for this account or a retail subaccount.

Usage
Use this command to update Billing contact information for this account. Use this command to change the password or authorization question for a retail subaccount. Use this command to update credit card information for this account or a retail subaccount. To add funds to a reseller account, use the RefillAccount command.

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://www.enom.com/myaccount/EditContact.asp?

On the my info page, the save changes button calls the UpdateAccountInfo command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The account identified in the UID parameter must be a reseller account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW NewUID

Obligation
Required Required Required for changing the password of a retail subaccount

Definition
Account login ID Account password Retail subaccount login ID. Permitted format is alphanumeric characters. Must be unique in our system

Max size
20 20 20

12/1/08

636

1999-2008 eNom, Inc.

API commands: UpdateAccountInfo

Param name
NewPW

Obligation
Required for changing the password of a retail subaccount

Definition
Desired password for the retail subaccount for the future. Permitted values are 6 to 20 alphanumeric characters and symbols. Not permitted: space, #, %, & Confirm desired password for the retail subaccount for the future

Max size
20

ConfirmNewPW

Required for changing the password of a retail subaccount Required

20

AuthQuestionType

Type of question. Permitted values: 10 smaiden mothers maiden name sbirth city of birth ssocial last 4 digits of SSN shigh high school The answer to the question type (mother's maiden name, city of birth, last 4 digits of social security or high school) Account ID of the account to be updated 50

AuthQuestionAnswer

Required

Account RegistrantOrganizationName

Optional

11 60

Required for us to Registrant organization apply the Web site URL

WebSiteURL

URL of the domain registration Web 150 Optional overall, but Required if we site, for billing purposes bill your customers for domain renewals and other services Required Required Registrant first name Registrant last name 60 60 60

RegistrantFirstName RegistrantLastName RegistrantJobTitle

Required if Registrant job title RegistrantOrgan izationName is supplied Required Optional Required Optional Registrant Address Registrant additional address info Registrant city

RegistrantAddress1 RegistrantAddress2 RegistrantCity RegistrantStateProvinceChoice

60 60 60

Registrant state or province choice: 1 S state P province Registrant state or province Registrant postal code Registrant country Email address for WhoIs Email address for us to contact to you about your domain name account 60 16 60 128 128

RegistrantStateProvince RegistrantPostalCode RegistrantCountry RegistrantEmailAddress RegistrantEmailAddress_Contact

Optional Optional Optional Required Optional

12/1/08

637

1999-2008 eNom, Inc.

API commands: UpdateAccountInfo

Param name
RegistrantPhone

Obligation
Required

Definition
Registrant phone. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Registrant fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters. Type of credit card

Max size
17

RegistrantFax

Required if RegistrantOrgan izationName is supplied

17

CardType

Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Required if updating credit card information of a retail account Optional

20

CCName

Cardholder's name

60

CreditCardNumber

Customer's credit card number

128

CreditCardExpMonth

Credit card expiration month

CreditCardExpYear

Credit card expiration year

CVV2

Credit card verification code

CCAddress

Credit card billing address

60

CCZip

Credit card billing postal code

15

CCCountry

Credit card billing country

60

ResponseType

Format of response. Options are Text (default), HTML, or XML.

12/1/08

638

1999-2008 eNom, Inc.

API commands: UpdateAccountInfo

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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. This command updates credit card information only if this is a retail account.

Example
The following query updates account information: password, authorization question, or contact information. The query requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=UpdateAccountInfo& uid=resellid&pw=resellpw&NewUID=resellid2& NewPW=resellpw2&ConfirmNewPW=resellpw2& AuthQuestionType=smaiden&AuthQuestionAnswer=Jones&RegistrantAddress1=111+Main+St.& RegistrantCity=Hometown&RegistrantCountry=United+States& [email protected]&RegistrantFax=+1.5555555556& RegistrantFirstName=John&RegistrantLastName=Doe&RegistrantJobTitle=President& RegistrantOrganizationName=Reseller+Documents+Inc.&RegistrantPhone=+1.5555555555& RegistrantPostalCode=99999&RegistrantStateProvince=WA&RegistrantStateProvinceChoice=S& RegistrantNexus=United+States&RegistrantPurpose=&responsetype=xml

The response confirms the Successful update of account information:

<?xml version="1.0" ?> <interface-response> <StatusEditContact>Successful</StatusEditContact> <OrganizationName>Reseller Documents Inc.</OrganizationName> <JobTitle>President</JobTitle> <Fname>John</Fname> <Lname>Doe</Lname> <Address1>111 Main St.</Address1> <Address2 /> <City>Hometown</City> <StateProvince>WA</StateProvince> <StateProvinceChoice>S</StateProvinceChoice> <PostalCode>99999</PostalCode> <Country>US</Country> <Phone>5555555555</Phone> <Fax>5555555556</Fax> <EmailAddress>[email protected]</EmailAddress> <EmailAddress_Contact>[email protected]</EmailAddress_Contact> <URL /> <GetAccountInfo>

12/1/08

639

1999-2008 eNom, Inc.

API commands: UpdateAccountInfo

<UserID>resellid</UserID> <Password>resellpw</Password> <AuthQuestionType>smaiden</AuthQuestionType> <AuthQuestionAnswer>Jones</AuthQuestionAnswer> <Account>217-no-0647</Account> <Reseller>True</Reseller> <AcceptTerms>True</AcceptTerms> </GetAccountInfo> <GetCustomerPaymentInfo> <CCName /> <CCNumber /> <CCType /> <CCMonth /> <CCYear /> </GetCustomerPaymentInfo> <GetCustomerPreferences> <DefPeriod /> </GetCustomerPreferences> <Command>UPDATEACCOUNTINFO</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory UpdateCusPreferences

12/1/08

640

1999-2008 eNom, Inc.

API commands: UpdateAccountPricing

UpdateAccountPricing
Description
Definition
Set wholesale prices for a subaccount.

Usage
Use this command to set the wholesale prices that one subaccount pays you for each product. To set retail prices for consumers who buy directly from this account, use PE_SetPricing.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/resellers/subaccount-list.asp

Click any subaccounts LoginID to see the wholesale prices you charge them; the values can be reset with UpdateAccountPricing.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name must belong to this account. The subaccount named with LoginID or Account parameters must be a subaccount of the account named in the uid and pw parameters.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW LoginID

Obligation Definition
Required Required Optional Account login ID Account password

Max size
20 20

Subaccount login ID (use 20 GetAccountInfo to retrieve the subaccount login ID) 11 Subaccount ID number (use GetAccountInfo to retrieve the subaccount ID number; format is NNN-aa-NNNN)

Account

Required

12/1/08

641

1999-2008 eNom, Inc.

API commands: UpdateAccountPricing

Param name
AcctType

Obligation Definition
Required

Max size

Type of subaccount that you 8 want this subaccount to be recorded as, after this query executes. Permitted values are reseller and retail. Note that once an account is converted to reseller status, it cannot be changed back to retail status. Price for registering a domain name, in DD.cc format. For example, comprice=24.95 sets the price of registering a .com name to $US24.95. Price for renewing a domain name, in DD.cc format 1000.00

TLDprice

Optional

TLDrenew TLDtransfer

Optional Optional

1000.00

Price for transferring a domain 1000.00 name and extending its expiration date by one year, in DD.cc format Price for one year of DNS hosting, in DD.cc format Price for a 10-pak of POP3 mailboxes, in DD.cc format Price of a .name domain plus email service from the .name Registry, in DD.cc format Price of email forwarding, in DD.cc format Price of URL forwarding, in DD.cc format Price for one year of Whois Privacy Protection Service, in DD.cc format Price for one year of Whois Business Listing, in DD.cc format Price for a one-year GeoTrust QuickSSL certificate, in DD.cc format 1000.00 1000.00 1000.00

DNSHosting POP3 DotNameBundle

Optional Optional Optional

45_valueadd 47_valueadd WPPS

Optional Optional Optional

1000.00 1000.00 1000.00

WBL

Optional

1000.00

Certificate-GeoTrust-QuickSSL

Optional

1000.00

Certificate-GeoTrust-QuickSSL-Premium

Optional

Price for a one-year GeoTrust 1000.00 QuickSSL Premium certificate, in DD.cc format Price for a one-year GeoTrust True BusinessID certificate, in DD.cc format Price for a one-year GeoTrust True BusinessID Wildcard certificate, in DD.cc format Price for a one-year GeoTrust True BusinessID with EV certificate, in DD.cc format Price for a one-year RapidSSL certificate, in DD.cc format 1000.00

Certificate-GeoTrust-TrueBizID

Optional

Certificate-GeoTrust-TrueBizID-Wildcard Optional

1000.00

Certificate-GeoTrust-TrueBizID-EV

Optional

1000.00

Certificate-RapidSSL-RapidSSL

Optional

1000.00

12/1/08

642

1999-2008 eNom, Inc.

API commands: UpdateAccountPricing

Param name
Certificate-SBS-Instant

Obligation Definition
Optional Price for a one-year SBS Instant certificate, in DD.cc format Price for a one-year SBS Secure certificate, in DD.cc format Price for a one-year SBS Secure Plus certificate, in DD.cc format Price for a one-year SBS EV certificate, in DD.cc format

Max size
1000.00

Certificate-SBS-Secure

Optional

1000.00

Certificate-SBS-Secure-Plus

Optional

1000.00

Certificate-SBS-EV Certificate-SBS-SGC-EV WSCBasic

Optional Optional Optional

1000.00

Price for a one-year SBS SGC 1000.00 EV certificate, in DD.cc format Price for WebSite Creator Basic package, in DD.cc format Price for WebSite Creator Full package, in DD.cc format 1000.00

WSCFull WSCEcommerce

Optional Optional

1000.00

Price for WebSite Creator 1000.00 eCommerce package, in DD.cc format Price for one Hosted Microsoft 1000.00 Exchange mailbox, per month, in DD.cc format Price for 100MB of extra 1000.00 storage on the Hosted Microsoft Exchange server, per month, in DD.cc format 1000.00 Price for delivery to one BlackBerry device, per month, in DD.cc format Setup fee for BlackBerry support, a one-time fee per device, in DD.cc format Price for delivery to one Good Mobile Messaging device, per month, in DD.cc format Setup fee for Good Mobile Messaging support, a onetime fee per device, in DD.cc format 1000.00

Hosted-Exchange-Mailbox

Optional

Hosted-Exchange-Extra-Storage

Optional

Hosted-Exchange-BlackBerry

Optional

Hosted-Exchange-BlackBerry-Setup-Fee

Optional

Hosted-Exchange-GoodLink

Optional

1000.00

Hosted-Exchange-GoodLink-Setup-Fee

Optional

1000.00

Hosted-Exchange-ActiveSync

Optional

1000.00 Price for delivery to one ActiveSync device, per month, in DD.cc format Format of response. Options are Text (default), HTML, or XML. 4

ResponseType

Optional

12/1/08

643

1999-2008 eNom, Inc.

API commands: UpdateAccountPricing

Returned parameters and values

Param name Definition
Account AccountType Count Status Command ErrCount Err(x) Done Subaccount ID Subaccount type Number of prices modified Success status for this query Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets prices for several products. It requests the response in XML format:
http://resellertest.enom.com/interface.asp?uid=resellid& pw=resellpw&Account=154-dz-5567& AcctType=reseller&command=UPDATEACCOUNTPRICING&comprice=14& comrenew=15&comtransfer=16&pop3=29.95&dotnamebundle=20.95&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <Set> <Account>154-dz-5567</Account> <AcctType>reseller</AcctType> <Count>5</Count> <Status>Successful</Status> </Set> <Command>UPDATEACCOUNTPRICING</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

644

1999-2008 eNom, Inc.

API commands: UpdateAccountPricing

Related commands
HE_GetPricing PE_GetCustomerPricing PE_GetDomainPricing PE_GetResellerPrice PE_GetRetailPrice PE_GetRetailPricing PE_GetRocketPrice PE_SetPricing SetResellerServicesPricing SetResellerTLDPricing WSC_GetPricing

12/1/08

645

1999-2008 eNom, Inc.

API commands: UpdateCart

UpdateCart
Description
Definition
Update items in the shopping cart.

Usage
Use this command to activate or deactivate a shopping cart item or to change its quantity.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/Cart.asp

On the cart page, changing an item from OldItemStatus=A (active) to ItemStatus=I (inactive) clears the check box in the select column.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The item must be in the customers shopping cart.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW Required Required Account login ID Account password

Max size
20 20

ItemIDX(X=1 Required to NumberOfItems) ItemStatusX Optional

Input value is the six-digit cart item ID. Retrieve this number 10 using the GetCartContent command. New status of the item. Permitted values are on to make the 3 status active, off to make it inactive. Items set to status on are subject to the next operation you perform on the cart. New quantity for the item Renewal setting for the item. Permitted values are on to auto-renew, none for an item that is not renewable. If RenewX is not supplied, item is set to not auto-renew. 4 4

ItemQtyX RenewX

Required Optional

12/1/08

646

1999-2008 eNom, Inc.

API commands: UpdateCart

Param name Obligation Definition

ClearItems ActivateItems ResponseType Optional Optional Optional

Max size

Toggle all items in cart to status I (Inactive). Permitted value 3 is Yes. Toggle all items in cart to status A (Active). Permitted value is Yes. Format of response. Options are Text (default), HTML, or XML. 3 4

Returned parameters and values

Param name Definition
Command ErrCount Err(x) Done Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that item 365690 be moved from active (A) to inactive (I) status, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=updatecart& uid=resellid&pw=resellpw& ItemID1=365690&ItemStatus1=on&ItemQty1=1&Renew1=1&ResponseType=xml

In the response, an ErrCount value 0 indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <Command>UPDATECART</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

647

1999-2008 eNom, Inc.

API commands: UpdateCart

Related commands
AddBulkDomains AddToCart DeleteFromCart GetCartContent InsertNewOrder PurchasePreview

12/1/08

648

1999-2008 eNom, Inc.

API commands: UpdateCusPreferences

UpdateCusPreferences
Description
Definition
Update the customer preference settings for an account.

Usage
Use this command to update customer preference settings.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/Settings.asp

On the my enom > settings page, the UpdateCusPreferences command sets any changes that a user enters in the Default Domain Options section.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW DefPeriod

Obligation Definition
Required Required Required Account login ID Account password Default period for auto-renew and registrar lock settings, in years. A domains registration period cannot extend more than 10 years beyond today. RegLock=on prevents a domain from being transferred to a new registrar. RegLock=off allows unrestricted transfer of a domain from one registrar to another. AutoRenew=on renews domain names automatically. AutoRenew=off does not renew domain names automatically.

Max size
20 20 2

RegLock

Optional; default is on

AutoRenew

Optional; default is off

IDProtect

Optional; default is off

IDProtect=on automatically purchases ID Protect for 3 all eligible domains. Permitted values are on and off

12/1/08

649

1999-2008 eNom, Inc.

API commands: UpdateCusPreferences

Param name
DefIDProtectRenew

Obligation Definition
Optional; default is off Optional; default is off Optional; default is off

Max size

DefIDProtectRenew=on automatically renews ID 3 Protect before it expires. Permitted values are on and off DefWBLRenew=on automatically renews Business Listing before it expires. Permitted values are on and off AutoPakRenew=on renews POP email paks automatically. AutoPakRenew=off does not renew POP paks automatically. Note: This parameter displays in the UI only if autorenewal of POP paks is enabled as a for-pay feature for this account. EMailForwardRenew=on renews email forwarding automatically. EMailForwardRenew=off does not renew email forwarding automatically. Note: This parameter displays in the UI only if email forwarding is enabled as a for-pay feature for this account. URLForwardingRenew=on renews URL forwarding automatically. URLForwardingRenew=off does not renew URL forwarding automatically. Allow domain name servers. Options are 0 and 1. 3

DefWBLRenew

AutoPakRenew

EMailForwardRenew

Optional; default is off

URLForwardingRenew Optional; default is off

AllowDNS UseDNS

Optional; default is 1 Optional; default is 0

Which name servers a domain is using. 1 If UseDNS=1, use our name servers. If UseDNS=0, use the name servers specified in this query string. Note: If UseDNS or DNSY are present in the UpdateCusPreferences query string, none of the other settings (DefPeriod through AllowDNS) will be updated. Use name of domain name server. For example, DNS1=ns1.name-services.com. Note: If UseDNS or DNSY are present in the UpdateCusPreferences query string, none of the other DNS settings (DefPeriod through AllowDNS) will be updated. Use the same host records as this accounts parent account? Permitted values are: 0 Do not use parent accounts defaults 1 Use parent accounts defaults 16

DNSY Y=1, 2, 3, . . .

Optional

UseParentDefault

Optional

12/1/08

650

1999-2008 eNom, Inc.

API commands: UpdateCusPreferences

Param name
RecordTypeX X=1, 2, 3, . . .

Obligation Definition
Optional Record type of host record X. Permitted values are: A Address CNAME Alias record type, to associate a host name with another host URL URL redirect FRAME Frame redirect MX Mail. Can be a host name under this domain name or the name of a mail server MXE Mail Easy (email forwarding) TXT Text (SPF) record

Max size
5

AddressX

Optional

Address to redirect to. 260 If RecordTypeX=A, AddressX must be an IP address If RecordTypeX=CNAME, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=URL, AddressX must be the exact URL of the page you redirect to, or an IP address, or a fully qualified domain name (see Note) If RecordTypeX=FRAME, AddressX is the actual URL, or the IP address, or the fully qualified domain name (see Note) of the page you want to display when someone types Your_Domain.com If RecordTypeX=MX, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain If RecordTypeX=MXE, AddressX must be an IP address If RecordTypeX=TXT, AddressX is a text (SPF) record. For help writing an SPF record, go to http://spf.pobox.com/wizard.html Name of host record X, for example, HostName1=www Show menus. ShowPopUps=0 hides menus. ShowPopUps=1 shows menus. Format of response. Options are Text (default), HTML, or XML. 60 1

HostNameX ShowPopUps

Optional Optional; default is 1 Optional

ResponseType

Returned parameters and values

Param name Definition
Update Command ErrCount Err(x) Done A return value of Successful indicates that customer preferences were successfully updated. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

12/1/08

651

1999-2008 eNom, Inc.

API commands: UpdateCusPreferences

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
The following query requests the updating of several customer preference settings, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=UPDATECUSPREFERENCES& uid=resellid&pw=resellpw&DefPeriod=4&AutoRenew=on& AutoPakRenew=on&RegLock=on&URLForwardingRenew=on& EmailForwardRenew=on&AllowDNS=0&ShowPopups=0&responsetype=xml

In the response, the ErrCount value 0 indicates that the update was successful:
<?xml version="1.0" ?> <interface-response> <Command>UPDATECUSPREFERENCES</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <IsLockable>0</IsLockable> <IsRealTimeTLD>0</IsRealTimeTLD <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
CheckLogin CreateAccount CreateSubAccount GetAccountInfo GetAccountPassword GetAllAccountInfo GetConfirmationSettings GetCusPreferences GetCustomerPaymentInfo GetOrderDetail GetOrderList GetReport GetSubAccountDetails GetSubAccounts GetTransHistory SetPakRenew UpdateAccountInfo UpdateRenewalSettings

12/1/08

652

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

UpdateDomainFolder
Description
Definition
Change the name of a folder, configure or change the settings of a Magic Folder, and/or change a folder from Standard to Magic or from Magic to Standard.

Usage
Use this command to change a folder from Standard to Magic or from Magic to Standard, configure or change the settings of a Magic Folder, and/or change the folder name or description of any folder. This command lets a user choose which settings are Magic, and what those settings should be (on, off, and so on). Settings that can be Magic include the following: Auto-renew Registrar lock Name servers Host records Domain password Contact information

When a domain is put into a Magic Folder, the domains settings synchronize to those that are specified as Magic for the folder. For example, if a folder is only Magic with respect to auto-renew, and auto-renew is on, all domains put into that folder have their auto-renew setting turned on. Since that is the only Magic setting for the folder, none of the domains other settings change.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/folder-control-panel/default.asp?FolderName=ResellFolder

Click any of the links in the left-hand column. On the resulting pages, the save button calls the UpdateDomainFolder command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The folder must belong to this account.

12/1/08

653

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW FolderName FolderType

Obligation Definition
Required Required Required Optional Account login ID Account password Current name of folder Should this folder be Standard or Magic? Permitted values are: 0 Standard 1 Magic

Max size
20 20 125 1

NewFolderName

Optional

New name for this existing folder. 125 Permitted characters are letters, numbers, hyphens, underscores, and spaces; name must begin with a letter or number. Description for this folder. Do you want DNS settings to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes Do you want name servers synchronized to our name servers? Permitted values are: 0 No, I will specify custom name servers 1 Yes, use eNoms name servers 250 1

Description DNSSync

Optional Optional

UseNameServer

Optional

78

DNSX X=1 to maximum 12 AutoRenewSync

Optional

Custom name servers for this folder. Up to 1 12 may be specified. Required format is DNS1=ns1.sld.tld or dns1.sld.tld Do you want auto-renew to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes Auto-renew setting for this folder. Permitted values are: 0 Auto-renew off 1 Auto-renew on Do you want Registrar Lock to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes Registrar Lock setting for this folder. Registrar Lock protects you from unapproved transfers of your domains. Permitted values are: 0 Registrar Lock off 1 Registrar Lock on 1

Optional

AutoRenew

Optional

RegLockSync

Optional

RegLock

Optional

12/1/08

654

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Param name
DomainPWSync

Obligation Definition
Optional; default is 0 Do you want domain passwords to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes Password for all domains in this folder. Do you want domain passwords to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes Host record name. Permitted values are www, @, and * Record type of this host record. Permitted values are: A Address. If RecordTypeX=A, AddressX must be an IP address. CName Alias. If RecordTypeX=CName, AddressX must be a fully qualified domain name or a host name defined in this domain. URL URL redirect. If RecordTypeX=URL, AddressX must be the exact URL of the page you want to redirect to, or an IP address, or a fully qualified domain name. Frame Frame redirect. If RecordTypeX=Frame, AddressX must be the exact URL of the page you want to redirect to, or an IP address, or a fully qualified domain name. Address to send this host record to. Do you want contacts to be a Magic setting of this folder? Permitted values are: 0 No 1 Yes

Max size
1

DomainPassword HostSync

Optional Optional

20 1

HostNameX X=1 to maximum 3 RecordTypeX X=1 to maximum 3

Optional Optional

60 5

AddressX X=1 to maximum 3 ContactSync

Optional Optional

260 1

ContactTypeContactSync

Optional

Do you want this contact type to be a 1 Magic setting of this folder? Permitted ContactTypes are Registrant, AuxBilling, Tech, or Admin. Permitted values are: 0 Do not synchronize this contact 1 Synchronize this contact For example, to make Registrant a Magic contact, use RegistrantContactSync=1

12/1/08

655

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Param name
ContactTypeUseBilling

Obligation Definition
Optional

Max size

Use the Billing contact information for this 60 contact? Permitted values are: 0 Do not use the Billing contact information for this contact 1 Use the Billing contact information for this contact Name of this contacts organization Job title of this contact First (given) name of this contact Last (family) name of this contact Address, line 1, of this contact Address, line 2, of this contact City of this contact State or province of this contact 60 60 60 60 60 60 60 60

ContactTypeOrganizationName ContactTypeJobTitle ContactTypeFirstName ContactTypeLastName ContactTypeAddress1 ContactTypeAddress2 ContactTypeCity ContactTypeProvince

Optional Optional Optional Optional Optional Optional Optional Optional

ContactTypeStateProvinceChoice Optional

Is the value for ContactTypeProvince a 1 state or a province? Permitted values are: S State P Province Postal code of this contact 16 Country of this contact. Two-letter country 60 code is a permitted value. Phone number of this contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Phone extension of this contact. Fax number of this contact. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters Email address of this contact. Permitted format is [email protected] Format of response. Options are Text (default), HTML, or XML. 17

ContactTypePostalCode ContactTypeCountry ContactTypePhone

Optional Optional Optional

ContactTypePhoneExt ContactTypeFax

Optional Optional

8 17

ContactTypeEmailAddress ResponseType

Optional Optional

128 4

12/1/08

656

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Returned parameters and values

Param name
FolderName Result

Definition
Name of folder Result of this operation. Return values are: 0 Failure 1 Success 2 New folder name already exists 3 Folder name does not exist in this account 4 Cannot convert this folder to Magic because at least one domain is already in another Magic folder 5 Cannot convert this folder to Magic because at least one domain has a registration status other than registered 6 Cannot convert this folder to Standard because at least one domain in this folder is pending processing 7 Unable to update folder 8 Invalid name server status value 9 Invalid auto-renew status value 10 Invalid registrar lock status value 11 Invalid domain password value 12 Cannot update DNS because at least one domain is pending processing 13 Cannot update auto-renew because at least one domain is pending processing 14 Cannot update registrar lock because at least one domain is pending processing 15 Cannot update domain password because at least one domain is pending processing 16 Cannot update contact information because at least one domain is pending processing 17 Cannot update host records because at least one domain is pending processing 18 Invalid host value Encloses your input parameters in XML tags Identification number of this folder Your name for this folder Your description of this folder Standard or Magic folder? 0 Standard 1 Magic Status of this folder as a whole. Return values are: 1 Not a Magic folder 2 Folder is currently in sync (all Magic settings have been updated to the values specified for the folder) 3 Folder is locked pending a global edit 4 Something in the folder is out of sync Number of domains in this folder Should this folder synchronize name servers? Return values are: 0 No, DNS is not Magic for this folder 1 Yes, DNS is Magic for this folder Status of DNS synchronization for this folder. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but DNS is not set to Magic, or DNS is set to Magic and is in sync 3 DNS is set to Magic and this folder is pending synchronization 4 DNS is set to Magic and is out of sync

UpdateText FolderID FolderName FolderDescription FolderType

FolderStatus

FolderDomainCount SyncDNS

SyncDNSStatus

12/1/08

657

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Param name
NSStatus

Definition
Name servers for this folder. Return values are: NA This folder uses custom name servers Yes This folder uses our name servers Name server you specified Should this folder synchronize auto-renew settings? Return values are: 0 No 1 Yes Status of auto-renew synchronization for this folder. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but auto-renew is not set to Magic, or auto-renew is set to Magic and is in sync 3 Auto-renew is set to Magic and this folder is pending synchronization 4 Auto-renew is set to Magic and is out of sync Auto-renew setting of this folder. Return values are: No Auto-renew is off for all domains in this folder Yes Auto-renew is on for all domains in this folder Should this folder synchronize registrar lock settings? Return values are: 0 No, registrar lock is not Magic for this folder 1 Yes, registrar lock is Magic for this folder Status of registrar lock synchronization for this folder. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but registrar lock is not set to Magic, or registrar lock is set to Magic and is in sync 3 Registrar lock is set to Magic and this folder is pending synchronization 4 Registrar lock is set to Magic and is out of sync Registrar lock setting of this folder. Return values are: Locked Registrar lock is on for this folder Not Locked Registrar lock is off for this folder Should this folder synchronize domain passwords? Return values are: 0 No, domain password is not Magic for this folder 1 Yes, domain password is Magic for this folder Status of password synchronization for this folder. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but password is not set to Magic, or password is set to Magic and is in sync 3 Password is set to Magic and this folder is pending synchronization 4 Password is set to Magic and is out of sync Domain password for this folder Should host records be Magic for this folder? Return values are: 0 No, do not synchronize host records in this folder 1 Yes, synchronize host records in this folder Status of host record synchronization for this folder. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but host records are not set to Magic, or host records are set to Magic and are in sync 3 Host records are set to Magic and this folder is pending synchronization 4 Host records are set to Magic and are out of sync Are contacts Magic in this folder? Return values are: 0 No, contacts are not synchronized in this folder 1 Yes, contacts are synchronized in this folder

NameServer SyncRenew

SyncRenewStatus

RenewStatus

SyncRegLock

SyncRegLockStatus

RegLockStatus

SyncDomainPwd

SyncDomainPwdStatus

DomainPwdValue SyncHosts

SyncHostsStatus

SyncContact

12/1/08

658

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Param name
SyncContactStatus

Definition
Status of synchronization of this contact type. Return values are: 1 This is not a Magic folder 2 This is a Magic folder but this contact type is not set to Magic, or this contact type is set to Magic and is in sync 3 This contact type is set to Magic and this folder is pending synchronization 4 This contact type is set to Magic and is out of sync PartyID of this contact Organization name of this contact Job title of this contact First (given) name of this contact Last (family) name of this contact Address, first line, of this contact Address, second line, of this contact City of this contact State or province of this contact Is the StateProvince value a state or a province? Return values are: S State P Province Postal code of this contact Country of this contact Full country name of this contact Phone number of this contact Fax number of this contact Email address of this contact Phone extension of this contact Model for this contact Is Registrant contact information Magic in this folder? Return values are: 0 No, Registrant is not synchronized in this folder 1 Yes, Registrant is synchronized in this folder Is Admin contact information Magic in this folder? Return values are: 0 No, Admin contact is not synchronized in this folder 1 Yes, Admin contact is synchronized in this folder Is Tech contact information Magic in this folder? Return values are: 0 No, Tech contact is not synchronized in this folder 1 Yes, Tech contact is synchronized in this folder Is Auxiliary Billing contact information Magic in this folder? Return values are: 0 No, Auxiliary Billing contact is not synchronized in this folder 1 Yes, Auxiliary Billing contact is synchronized in this folder Name of this folder Is this a Traffic Only account? Return values are: True This is a Traffic Only account False This is not a Traffic Only account Is this a Name Only account? Return values are: True This is a Name Only account False This is not a Name Only account Is parking enabled for this account? Return values are: True Parking is enabled for this account False Parking is not enabled for this account Name of command executed

PartyID OrganizationName JobTitle FName LName Address1 Address2 City StateProvince StateProvinceChoice

PostalCode Country FullCountry Phone Fax EmailAddress PhoneExt SameAs SyncContactRegistrant

SyncContactAdmin

SyncContactTech

SyncContactAuxBilling

FolderNameEnc TrafficOnly

NameOnly

ParkingEnabled

Command

12/1/08

659

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

Param name
ErrCount Err(x) Done

Definition
The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query makes a folder Magic, adds a folder description, makes auto-renew Magic and turns autorenew on for the folder, and sends the response in XML format:
http://api.staging.local/interface.asp?command=UpdateDomainFolder& uid=resellid&pw=resellpw&FolderName=ResellFolder2&FolderType=1& Description=hello&AutoRenewSync=1&AutoRenew=1&ResponseType=xml

In the response, a Result code 1 and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <UpdateResult> <FolderName>ResellFolder2</FolderName> <Result>1</Result> <UpdateText><Folder><FolderDescription>test</FolderDescription> <FolderType>1</FolderType><Renew><SyncRenew>1</SyncRenew> <RenewStatus>Yes</RenewStatus></Renew></Folder></UpdateText> </UpdateResult> <Folder> <FolderID>9080</FolderID> <FolderName>ResellFolder2</FolderName> <FolderDescription> <![CDATA[ hello]]> </FolderDescription> <FolderType>1</FolderType> <FolderStatus>2</FolderStatus> <FolderDomainCount>0</FolderDomainCount> <DNS> <SyncDNS>0</SyncDNS> </DNS> <Renew> <SyncRenew>1</SyncRenew> <SyncRenewStatus>2</SyncRenewStatus> <RenewStatus>Yes</RenewStatus> </Renew> <RegLock> <SyncRegLock>0</SyncRegLock> </RegLock> <DomainPwd> <SyncDomainPwd>0</SyncDomainPwd> </DomainPwd> <Hosts>

12/1/08

660

1999-2008 eNom, Inc.

API commands: UpdateDomainFolder

<SyncHosts>0</SyncHosts> </Hosts> <Contacts> <SyncContacts>0</SyncContacts> </Contacts> </Folder> <FolderNameEnc>ResellFolder2</FolderNameEnc> <TrafficOnly>False</TrafficOnly> <NameOnly>False</NameOnly> <ParkingEnabled>False</ParkingEnabled> <Command>UPDATEDOMAINFOLDER</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>8.203</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddDomainFolder AdvancedDomainSearch AssignToDomainFolder DeleteDomainFolder GetDomainFolderDetail GetDomainFolderList RemoveUnsyncedDomains

12/1/08

661

1999-2008 eNom, Inc.

API commands: UpdateExpiredDomains

UpdateExpiredDomains
Description
Definition
Reactivate an expired domain in real time.

Usage
Use this command to reactivate a domain after it has expired, while it is in Expired status. This command reactivates a domain in real time. Before a domain expires, use the Extend command to renew it. We recommend renewing at least a week before a domain expires.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/DomainManager.asp?tab=expireddomains

On the my domains page, my domains tab, expired subtab, clicking on the name of an expired domain calls the UpdateExpiredDomains command.

Constraints
The query must meet the following requirements: The domain must be in Expired status. The registrar sets the duration of the grace period between expiration and deletion from the registrars database. To retrieve a list of expired domains, use the GetDomains command with parameter Tab=ExpiredDomains. Customer must have sufficient funds. The charge for reactivation is the same as a one-year renewal.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW DomainName ResponseType Required Required Required Optional Account login ID Account password Domain Name (for example, example.com) Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 65 4

12/1/08

662

1999-2008 eNom, Inc.

API commands: UpdateExpiredDomains

Returned parameters and values

Param name Definition
Status Command ErrCount Err(x) Done Reactivation status. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests the reactivation of expired domain resellerdocs.com, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=UpdateExpiredDomains& uid=resellid&pw=resellpw&DomainName=resellerdocs.com&responsetype=xml

In the response, the Status value indicates a successful reactivation:

<?xml version="1.0" ?> <interface-response> <ReactivateDomainName> <Status>REACTIVATION PROCESSED SUCCESSFULLY! The orderid is 156514444.</Status> </ReactivateDomainName> <Command>UPDATEEXPIREDDOMAINS</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
Extend Extend_RGP GetDomainExp GetExtendInfo GetRenew InsertNewOrder SetRenew

12/1/08

663

1999-2008 eNom, Inc.

API commands: UpdateMetaTag

UpdateMetaTag
Description
Definition
Add or update the HTML metatags for one of a domains host records.

Usage
Use this command to raise the probability that a search engine will find this domain.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with login ID resellid, password resellpw.
http://resellertest.enom.com/domains/metatags.asp?HostID=11415002&DomainNameID=152533676

On the meta tags page, the save changes button calls the UpdateMetaTag 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD MetaTagHostID TitleBar

Obligation
Required Required Required Required Required Recommended to optimize search ranking

Definition
Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Metatag host ID, our internal tracking number. You can retrieve host IDs using the GetRegHosts command.

Max size
20 20 63 15 8

Content to display in the browser title bar. Replace spaces 100 with +.

12/1/08

664

1999-2008 eNom, Inc.

API commands: UpdateMetaTag

Param name
SiteDescription

Obligation
Recommended to optimize search ranking Recommended to optimize search ranking Optional

Definition
Content to display in search engine results. Replace spaces with +. List of keywords for search engines. Separate keywords with +. Format of response. Options are Text (default), HTML, or XML.

Max size
250

Keywords

250

ResponseType

Returned parameters and values

Param name
TitleBar SiteDescription Keywords DomainNameID Command ErrCount Err(x) Done

Definition
New title to display in browser title bar New description to display in search engine results New search-engine keywords for this host ID 9-digit domain name ID, our internal tracking number Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets values for the metatags, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=UpdateMetaTag& uid=resellid&pw=resellpw&sld=resellerdocs&tld=com& MetaTagHostID=11415002&TitleBar=MY+COOL+TITLE& SiteDescription=MY+SITE+DESCRIPTION&Keywords=MY+SITE+KEYWORDS&ResponseType=XML

In the response, metatag values that match your desired content, and an ErrCount value 0, confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <DomainRRP>E</DomainRRP> <RegistrarHold>False</RegistrarHold> <metatags> <titlebar>MY COOL TITLE</titlebar> <sitedescription>MY SITE DESCRIPTION</sitedescription> <keywords>MY SITE KEYWORDS</keywords> <DomainNameID>152533676</DomainNameID>

12/1/08

665

1999-2008 eNom, Inc.

API commands: UpdateMetaTag

</metatags> <Command>UPDATEMETATAG</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>False</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetHosts GetMetaTag GetRegHosts SetHosts

12/1/08

666

1999-2008 eNom, Inc.

API commands: UpdateNameServer

UpdateNameServer
Description
Definition
Change the IP address of a name server in the Registrys records.

Usage
Use this command when the IP address of a name server changes.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/domains/RegNameServer.asp

In the Update a Name Server IP section, clicking the submit button calls the UpdateNameServer command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain name of the name server must belong to this account. eNom must be the authoritative registrar (in the Registrys records) for the root domain. The registrar lock for the name server domain must be set to off while you update name servers. Once the name server IP has been updated, you can (and we recommend that you do) switch the registrar lock back on.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW OldIP NewIP NS ResponseType Required Required Required Required Required Optional Account login ID Account password Old IP address of the name server in the Registrys records New IP address of the name server in the Registrys records Use name of the name server, in the Registrys records Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 15 15 84 4

12/1/08

667

1999-2008 eNom, Inc.

API commands: UpdateNameServer

Returned parameters and values

Param name Definition
NSSuccess RRPCode RRPText Command ErrCount Err(x) Done 1 indicates that the name server IP update is successful Registry processing status code Text explanation of registry code Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query changes the IP of name server dns1.resellerdocs.com and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=updatenameserver& uid=resellid&pw=resellpw&OldIP=127.0.0.1&NewIP=127.0.0.2& NS=dns1.resellerdocs.com&responsetype=xml

In the response, the NsSuccess value 1 and RRPText value Command completed successfully confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <RegisterNameserver> <NsSuccess>1</NsSuccess> </RegisterNameserver> <RRPCode>200</RRPCode> <RRPText>Command completed successfully</RRPText> <Command>UPDATENAMESERVER</Command> <ErrCount>0</ErrCount> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable>True</IsLockable> <IsRealTimeTLD>True</IsRealTimeTLD> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

668

1999-2008 eNom, Inc.

API commands: UpdateNameServer

Related commands
CheckNSStatus DeleteNameServer GetDNS GetDNSStatus ModifyNS ModifyNSHosting RegisterNameServer

12/1/08

669

1999-2008 eNom, Inc.

API commands: UpdateNotificationAmount

UpdateNotificationAmount
Description
Definition
Update the account balance amount at which you want to be notified.

Usage
Use this command to specify the account balance at which you want a reminder to refill your 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.
http://resellertest.enom.com/myaccount/Settings.asp?tab=balance

The save changes button calls the UpdateNotificationAmount 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW NotifyAmount Required Required Required

Definition
Account login ID Account password

Max size
20 20

Points/$US amount at which you want us to send you a 9999.99 reminder email that this account needs refilling. Use DD.cc format Format of response. Options are Text (default), HTML, 4 or XML.

ResponseType

Optional

Returned parameters and values

Param name Definition
Command ErrCount Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

670

1999-2008 eNom, Inc.

API commands: UpdateNotificationAmount

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query changes the notification amount to 505 points/$US and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=UpdateNotificationAmount& uid=resellid&pw=resellpw&NotifyAmount=505&responsetype=xml

In the response, an ErrCount value 0 confirms that the query was successful:
<interface-response> <Update>Successful</Update> <Command>UPDATENOTIFICATIONAMOUNT</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod/> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable/> <IsRealTimeTLD/> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.0703125</ExecTime> <Done>true</Done> <debug> [CDATA] </debug> </interface-response>

Related commands
GetBalance RefillAccount

12/1/08

671

1999-2008 eNom, Inc.

API commands: UpdatePushList

UpdatePushList
Description
Definition
Update a list of domains to push into another account.

Usage
Use this command to push names from one eNom account to another.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/Push.asp?DomainNameID=152533882

UpdatePushList is not implemented on enom.com. However, the submit button on the push a name page calls PushDomain, a similar command.

Constraints
The query must meet the following requirements: Both the origin and destination accounts must be in our system. 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation Definition

UID PW DomainList ResponseType Required Required Required Optional Account login ID Account password LoginID of the account to push the names into CRLF-delimited list of domain names (URLEncode value for CRLF is %0D%0A). Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 16 4000 4

PushToLoginID Required

12/1/08

672

1999-2008 eNom, Inc.

API commands: UpdatePushList

Returned parameters and values

Param name
SuccessfulPush Command ErrCount Err(x) Done

Definition
True if successful or False otherwise Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query requests that resellerdocs2.net and resellerdocs3.info be pushed to account olerud, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=UpdatePushList& uid=resellid&pw=resellpw&PushToLoginID=olerud& domainlist=resellerdocs2.net%0D%0Aresellerdocs3.info&responsetype=xml

In the response, the SuccessfulPush values of Yes indicate that each domain was pushed successfully:
<?xml version="1.0" ?> <interface-response> <UPDATEPUSHLIST> <PUSH-DOMAIN> <DomainName>resellerdocs2.net</DomainName> <DomainListWrongFormat>Valid</DomainListWrongFormat> <DomainNameNotInYourAccount>Yes</DomainNameNotInYourAccount> <SuccessfulPush>Yes</SuccessfulPush> </PUSH-DOMAIN> <PUSH-DOMAIN> <DomainName>resellerdocs3.info</DomainName> <DomainListWrongFormat>Valid</DomainListWrongFormat> <DomainNameNotInYourAccount>Yes</DomainNameNotInYourAccount> <SuccessfulPush>Yes</SuccessfulPush> </PUSH-DOMAIN> </UPDATEPUSHLIST> <Command>UPDATEPUSHLIST</Command> <ErrCount>0</ErrCount> <Server>ResellerTest</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

12/1/08

673

1999-2008 eNom, Inc.

API commands: UpdatePushList

Related commands
PushDomain TP_CancelOrder TP_CreateOrder TP_GetDetailsByDomain TP_GetOrder TP_GetOrderDetail TP_GetOrdersByDomain TP_GetOrderStatuses TP_ResubmitLocked TP_SubmitOrder TP_UpdateOrderDetail

12/1/08

674

1999-2008 eNom, Inc.

API commands: UpdateRenewalSettings

UpdateRenewalSettings
Description
Definition
Update the settings regarding our notifying your customers about domain renewals.

Usage
Use this command to set or change the way in which we notify your customers about upcoming domain renewals.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://www.enom.com/myaccount/RenewalSettings.asp?RenewalSetting=2

The save changes button calls the UpdateRenewalSettings 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW RenewalSetting

Obligation
Required Required Optional

Definition
Account login ID Account password Renewal setting. Permitted values are: 0 Do not contact my customers for renewal 1 Email my customers 25 and 10 days before expiration; send them to my Web site to renew 2 Contact and charge my customers for renewals BCC me on all email correspondence sent to my customers. Permitted values are: 0 Do not BCC me 1 BCC me

Max size
20 20 1

RenewalBCC

Optional

12/1/08

675

1999-2008 eNom, Inc.

API commands: UpdateRenewalSettings

Param name
AcceptTerms

Obligation
Optional; must be accepted before you can use our credit card processing services Recommended when RenewalSetting =1 Optional

Definition

Max size

Do I accept eNoms credit card processing agreement? 1 Permitted values are: 0 I do not accept eNoms credit card processing agreement 1 I accept eNoms credit card processing agreement URL where customers can renew their domains; use format www.DomainName.com 63

URL

ResponseType

Format of response. Options are Text (default), HTML, or XML.

Returned parameters and values

Param name
AcceptTermsStatus RenewalSetting Command ErrCount Err(x) Done

Definition
Success status of updating credit card terms setting Success status of updating renewal settings Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query sets preferences for notifying customers about domain renewals, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=UPDATERENEWALSETTINGS& uid=resellid&pw=resellpw&RenewalSetting=2&RenewalBCC=1&AcceptTerms=1& URL=www.resellerdocs.com&ResponseType=XML

In the response, the return values Successful and the ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <UpdateRenewalSettings> <AcceptTermsStatus>Successful</AcceptTermsStatus> <RenewalSetting>Successful</RenewalSetting> </UpdateRenewalSettings> <Command>UPDATERENEWALSETTINGS</Command> <Language>en</Language> <ErrCount>0</ErrCount>

12/1/08

676

1999-2008 eNom, Inc.

API commands: UpdateRenewalSettings

<ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>LOCALHOST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.046875</ExecTime> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetCusPreferences UpdateCusPreferences

12/1/08

677

1999-2008 eNom, Inc.

API commands: ValidatePassword

ValidatePassword
Description
Definition
Validate a password for a domain name.

Usage
Use this command to determine whether the password for a domain name is valid.

Availability
All resellers have access to this command.

Implementation on eNom.com
http://access.enom.com/

On access.enom.com, the LOG-IN button calls the ValidatePassword command.

Constraints
The query must meet the following requirements: The domain name must exist.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW SLD TLD DomainPassword ResponseType

Obligation Definition
Required Required Required Required Required Optional Account login ID Account password Second-level domain name (for example, enom in enom.com) Top-level domain name (extension) Password to access and manage the domain name. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 63 15 60 4

Returned parameters and values

Param name Definition
RegistrarHold Command The enabled status of a domain. If RegistrarHold is True, the domain is disabled. Name of command executed

12/1/08

678

1999-2008 eNom, Inc.

API commands: ValidatePassword

Param name Definition

ErrCount Err(x) Done The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query asks whether resellerdocs2pw is the domain password for resellerdocs2.net, and requests the response in XML format:
http://resellertest.enom.com/interface.asp?command=validatepassword& uid=resellid&pw=resellpw& sld=resellerdocs2&tld=net&domainpassword=resellerdocs2pw&responsetype=xml

In the response, the error count of 0 confirms that resellerdocs2pw is the domain password for resellerdocs2.net:
<?xml version="1.0" ?> <interface-response> <RegistrarHold>False</RegistrarHold> <Command>VALIDATEPASSWORD</Command> <ErrCount>0</ErrCount> <Server>Dev Workstation</Server> <Site>enom</Site> <Done>true</Done> <debug> <![CDATA[ ] ]> </debug> </interface-response>

Related commands
GetAllDomains GetDomainCount GetDomainExp GetDomainInfo GetDomains GetExtendInfo GetPasswordBit GetRegistrationStatus GetRegLock GetRenew GetSubAccountPassword SetPassword SetRegLock SetRenew StatusDomain

12/1/08

679

1999-2008 eNom, Inc.

API commands: WBLConfigure

WBLConfigure
Description
Definition
Configure a Business Listing for the WhoisBusinessListings.com directory.

Usage
Use this command to create or edit the Business Listing for a domain name.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/domains/control-panel/panels/wbl_main.aspx?domainnameid=152533676

The Submit button calls the WBLConfigure command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The domain must be registered here but may use name servers other than ours. Business Listing is available for .com, .net, and .tv domain names.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW DomainList

Obligation
Required Required Required

Definition
Account login ID Account password

Max size
20 20

Comma-separated list of domains to configure. 80,000 Permitted domains are .com, .net, and .tv. Limit of 200 domains If this is a bulk edit (involving more than one domain name) you may assign a job name for tracking purposes 255

RequestName

Optional

12/1/08

680

1999-2008 eNom, Inc.

API commands: WBLConfigure

Param name
PersistExisting

Obligation
Optional; default is 1

Definition

Max size

Should our database keep any existing 1 configuration information that is not supplied in this query string? Use PersistExisting=1 to keep existing information. Use PersistExisting=0 to empty any fields that are not supplied in this query string.

Renew

3 Optional; default is Set automatic renewal for Business Listing before it expires? Permitted values are yes and no the first time no. Business Listing is configured or when PersistExisting=0. If PersistExisting=1, the current setting remains unchanged when the configuration is updated. Optional; default is Enable setting for Business Listing. Permitted 0 the first time values are 0 and 1. Business Listing is configured or when PersistExisting=0. If PersistExisting=1, the current setting remains unchanged when the configuration is updated. 1

Enable

CategoryID1 ... CategoryID5

Categories in which this Business Listing should 2 CategoryID1 is Optional; default is be displayed in the WhoisBusinessListings.com directory. Permitted values are: 10 the first time 1 Arts & Entertainment Business Listing is 2 Business configured or when PersistExisting=0. 3 Automotive 4 Consumer Electronics If PersistExisting=1, 5 Culture & Society 6 Domain For Sale the current setting 7 Education & Instruction remains unchanged 8 Fashion, Style & Personal Care when the 9 Food & Drink configuration is 10 Other updated. 11 Health & Medicine CategoryID2 12 Hobbies, Games & Toys through 13 Home & Garden CategoryID5 are 14 Computers & Internet optional. 15 Legal 16 Personal Finance 17 Professional Services 18 Real Estate 19 Relationships & Family 20 Sports & Fitness 21 Travel & Transportation

12/1/08

681

1999-2008 eNom, Inc.

API commands: WBLConfigure

Param name
CompanyName

Obligation
Required

Definition
Company name for this Business Listing. Permitted values are alphanumeric characters and some special characters (code-sensitive characters such as &%/\#@ will cause the query to fail)

Max size
500

CompanyDescription

Optional

Description of the company and/or its business. 500 Permitted values are alphanumeric characters adn some special characters (code-sensitive characters such as &%/\#@ will cause the query to fail) Street address for the business Street address, second line City State or province of the business Postal code for the business Country. The two-letter country code is a permitted format. Number of descriptive fields supplied in this query string. 160 160 60 60 60 2 2

StreetAddress StreetAddress2 City StateProvince PostalCode Country FieldCount

Optional Optional Optional Optional Optional Optional Required if you supply any FieldNameX and FieldTextX Optional

FieldNameX

Type of information being supplied in FieldTextX. Permitted values are: Web Site(s) Company Slogan Phone Number Email Address Fax Number Company Description Hours of Operation Other Contact Info Associations About This Domain For Sale price For Sale Listing Agent(s) For Sale Status Promotions Personal Description Blogs Tags Text supplied by customer for the field designate above. All characters are permitted. Format of response. Options are Text (default), HTML, or XML.

25

FieldTextX ResponseType

Optional Optional

500 4

Returned parameters and values

Param name Definition
ReportReques- Report number for this edit request. Run this report to retrieve results for all the tID domains listed in the query string DomainName The first domain name in the query string

12/1/08

682

1999-2008 eNom, Inc.

API commands: WBLConfigure

Param name Definition

ResultCode Results for the first domain in the query string. This code reflects only the immediate results for the first domain in the string. To report results to your customers and allow for queue delays, we recommend using WBLGetReport rather than this output. No code Successful configuration 2 Domain not found 3 Domain not owned by specified account 4 Service not purchased for this domain Verbal result for the first domain listed in the query string. This description reflects only the immediate results for the first domain in the string. To report results to your customers and allow for queue delays, we recommend using RPT_GetReport rather than this output. Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. True indicates this entire response has reached you successfully.

ResultDesc

Command ErrCount Err(x) Done

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
The following query submits a configuration request for four domain names and sends the response in XML format:
http://api.staging.local/interface.asp?command=WBLConfigure&uid=resellid&pw=resellpw& DomainList=resellerdocs.com,qsdsqdqsd.com,quebecrod.com,quebecrod111.com& RequestName=ThisJob&PersistExisting=1&Renew=no&Enable=1&CategoryID1=10& CompanyName=Company%20name&CompanyDescription=Company%20description& Logo=&StreetAddress=123%20Main&StreetAddress2=&City=Townsville&StateProvince=Maine& PostalCode=10000&Country=US&FieldCount=2&FieldName1=Company%20Slogan& FieldText1=We%20have%20a%20slogan&FieldName2=Promotions& FieldText2=We%20promote%20peace!&ResponseType=xml

In the response, a ReportRequestID value indicates that the query ran successfully and at least one domain was configured successfully:
<?xml version="1.0" ?> <interface-response> <ReportRequestID>828</ReportRequestID> <DomainName>resellerdocs.com</DomainName> <ResultCode /> <ResultDesc> Auto Renew Setting Updated.Company Information Updated.Categories Updated. Address Updated.Detailed Setting(s) Updated.Visbility Setting Updated. </ResultDesc> <Command>WBLCONFIGURE</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount>

12/1/08

683

1999-2008 eNom, Inc.

API commands: WBLConfigure

<MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.160</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart AdvancedDomainSearch GetAllDomains GetDomainInfo InsertNewOrder PurchaseServices RPT_GetReport UpdateCusPreferences WBLGetCategories WBLGetFields WBLGetStatus

12/1/08

684

1999-2008 eNom, Inc.

API commands: WBLGetCategories

WBLGetCategories
Description
Definition
Retrieve a list of Business Listing categories.

Usage
Use this command to retrieve a list of Business Listing categories.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/domains/control-panel/panels/wbl_main.aspx?domainnameid=152533676

The Categories section is populated using the WBLGetCategories 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
CategoryID CategoryName CategoryDesc Command ErrCount Identification number for a Business Listing category Business Listing category name Category description Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

685

1999-2008 eNom, Inc.

API commands: WBLGetCategories

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of categories and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WBLGetCategories& uid=resellid&pw=resellpw&responsetype=xml

In the response, an ErrCount value 0 indicates that the query was successful:
<?xml version="1.0" ?> <interface-response> <Categories> <Category> <CategoryID>1</CategoryID> <CategoryName>Arts & Entertainment</CategoryName> <CategoryDesc /> </Category> <Category> <CategoryID>2</CategoryID> <CategoryName>Business</CategoryName> <CategoryDesc /> </Category> <Category> <CategoryID>3</CategoryID> <CategoryName>Automotive</CategoryName> <CategoryDesc /> </Category> . . . </Categories> <Command>WBLGETCATEGORIES</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.125</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]>

12/1/08

686

1999-2008 eNom, Inc.

API commands: WBLGetCategories

</debug> </interface-response>

Related commands
AddToCart AdvancedDomainSearch GetAllDomains GetDomainInfo InsertNewOrder PurchaseServices RPT_GetReport UpdateCusPreferences WBLConfigure WBLGetFields WBLGetStatus

12/1/08

687

1999-2008 eNom, Inc.

API commands: WBLGetFields

WBLGetFields
Description
Definition
Retrieve a list of the descriptive fields available for configuring a Business Listing.

Usage
Use this command to retrieve a list of descriptive fields available for Business Listing.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/domains/control-panel/panels/wbl_main.aspx?domainnameid=152533676

In the Business Listing Details section, WBLGetFields is used to populate the Title dropdown menu.

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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
FieldID FieldName MaxLength Command ErrCount Identification number of the field Descriptive name of the field Maximum number of characters permitted for this field Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

12/1/08

688

1999-2008 eNom, Inc.

API commands: WBLGetFields

Param name Definition

Err(x) Done Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of descriptive fields for Business Listing, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WBLGetFields& uid=resellid&pw=resellpw&responsetype=xml

In the response, an ErrCount value of 0 confirms that the query ran successfully:
<?xml version="1.0" ?> <interface-response> <Fields> <Field> <FieldID>1</FieldID> <FieldName>Web Site(s)</FieldName> <MaxLength>500</MaxLength> </Field> <Field> <FieldID>3</FieldID> <FieldName>Company Slogan</FieldName> <MaxLength>500</MaxLength> </Field> <Field> <FieldID>4</FieldID> <FieldName>Phone Number</FieldName> <MaxLength>60</MaxLength> </Field> . . . </Fields> <Command>WBLGETFIELDS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.078</ExecTime> <Done>true</Done> <debug>

12/1/08

689

1999-2008 eNom, Inc.

API commands: WBLGetFields

<![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart AdvancedDomainSearch GetAllDomains GetDomainInfo InsertNewOrder PurchaseServices RPT_GetReport UpdateCusPreferences WBLConfigure WBLGetCategories WBLGetStatus

12/1/08

690

1999-2008 eNom, Inc.

API commands: WBLGetStatus

WBLGetStatus
Description
Definition
Retrieve a list of the possible statuses for Business Listing.

Usage
Use this command to retrieve a list of the possible statuses for Business Listing.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/domains/Domain-Manager.aspx

Business Listing statuses are reflected in the icons that display in the Business Listing column.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The report ID must match the login ID.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW ResponseType Required Required Optional

Definition
Account login ID Account password Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Returned parameters and values

Param name Definition
StatusID Description Command Identification number for a Business Listing status Verbal description of the status Name of command executed

12/1/08

691

1999-2008 eNom, Inc.

API commands: WBLGetStatus

Param name Definition

ErrCount Err(x) Done The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of statuses of Business Listing, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WBLGetStatus&uid=resellid& pw=resellpw&ResponseType=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <Templates> <StatusIDs> <StatusID>-1</StatusID> <Description>N/A</Description> </StatusIDs> <StatusIDs> <StatusID>0</StatusID> <Description>Available</Description> </StatusIDs> <StatusIDs> <StatusID>1</StatusID> <Description>Purchased, Not Configured</Description> </StatusIDs> <StatusIDs> <StatusID>2</StatusID> <Description>Configured</Description> </StatusIDs> <StatusIDs> <StatusID>3</StatusID> <Description>Expired</Description> </StatusIDs> <StatusIDs> <StatusID>4</StatusID> <Description>Configured, Visible</Description> </StatusIDs> <StatusIDs> <StatusID>5</StatusID> <Description>Configured, Not Visible</Description> </StatusIDs> </Templates> <Command>WBLGETSTATUS</Command> <Language>eng</Language> <ErrCount>0</ErrCount>

12/1/08

692

1999-2008 eNom, Inc.

API commands: WBLGetStatus

<ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLER1-STG</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.094</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart AdvancedDomainSearch GetAllDomains GetDomainInfo InsertNewOrder PurchaseServices RPT_GetReport UpdateCusPreferences WBLConfigure WBLGetCategories WBLGetFields

12/1/08

693

1999-2008 eNom, Inc.

API commands: WSC_GetAccountInfo

WSC_GetAccountInfo

Description
Definition
Retrieve the information for a Web Site Creator (WSC) account, including the URL for this account to link to the WSC wizard.

Usage
Use this command to retrieve information about a Web hosting account that includes WSC, or a stand-alone WSC account. This command retrieves the URL to the Web site creation wizard for this WSC 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. http://resellertest.enom.com/websitecreator/websitecreator_manage.asp? In the pane for each account, the account-specific information is provided by the WSC_GetAccountInfo command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Web hosting or WSC stand-alone account must belong to this domain name account.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW Required Required

Definition
Account login ID Account password

Max size
20 20

12/1/08

694

1999-2008 eNom, Inc.

API commands: WSC_GetAccountInfo

Param name Obligation

Account Required

Definition

Max size

Name of Web hosting or WSC stand-alone accounts. Use 14 the WSC_GetAllPackages command to retrieve a list of Web hosting accounts with WSC, and WSC stand-alone accounts. Language in which to launch the WSC wizard. Permitted values are: Eng English Spa Spanish Ger German Por Portuguese Fre French Ita Italian Format of response. Options are Text (default), HTML, or XML. 1

Language

Optional; default is Eng

ResponseType

Optional

Returned parameters and values

Param name
WebHostID HostAccount WebStorage BandWidth SQLSize DatabaseType POPMailboxes Overage BillingDate Status OSType Terminate TerminateDate HasWSC WSCEnabled WSCLaunchURL WSCCountry WSCLanguage CurrentPlanPrice CanUpgrade WSCFullPrice WSCECommercePrice WSCVersion HostHeaderDomains HasHostHeaders WSCPath SiteURL

Definition
Individual identification number for this Web hosting or WSC stand-alone account The individual account name of this Web hosting or WSC stand-alone account Storage space available to this account Monthly bandwidth available to this account Database space available to this account Type of database configured for this account POP mailboxes for this account Overage option for this account Billing date of this account Active status of this account Operating system of our server on which your WSC account resides Is this account flagged for termination? If flagged for termination, on what date? Does this account have WSC? Is WSC enabled for this account? The URL for the WSC wizard for this account The country for the WSC wizard for this account The language for the WSC wizard for this account Monthly price for WSC Is this account eligible for upgrade? Price for WSC Full Price for WSC eCommerce WSC version Host header domains Do these domains have host headers? Return value WSC indicates that this is a Web hosting account that subscribes to WSC URL of the WSC-built Web Site for this account

12/1/08

695

1999-2008 eNom, Inc.

API commands: WSC_GetAccountInfo

Param name
IsLWSC WSCSiteID PointedTo CurrentBillPeriod NextBillPeriod Month PromoID DiscountPercent DiscountPlanCnt CanUpdate DeleteDate AvailableHeaderDomains AvailableDomainList AvailableDomainCount Command Language ErrCount Err(x) Done

Definition
Is this a WSC Lite free account? Our identification number for this WSC site Is the WSC-built Web site pointing to SiteURL? Current billing period Next billing period For multi-month discounts, the number of months customer pays for to receive this discount For multi-month discounts, the promo code for this discount For multi-month discounts, the discount percentage Number of discount plans listed here Can this billing period be changed? Scheduled delete date for this WSC Web site Scheduled delete date for this WSC Web site Scheduled delete date for this WSC Web site Scheduled delete date for this WSC Web site Name of command executed Language of the WebSite Creator wizard The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves information about one Web hosting account that includes WSC, or one WSC standalone account, and sends the response in XML format:
http://resellertest.enom.com/Interface.asp?command=WSC_GETACCOUNTINFO& uid=resellid&pw=resellpw&account=LWSC123x4567&responsetype=xml

The response is as follows:

<?xml version="1.0" ?> <interface-response> <WSCHostAccounts> <HostPackage> <WebHostID>1398</WebHostID> <HostAccount>LWSC123x4567</HostAccount> <WebStorage /> <BandWidth /> <SQLSize /> <DatabaseType /> <POPMailBoxes /> <Overage />

12/1/08

696

1999-2008 eNom, Inc.

API commands: WSC_GetAccountInfo

<BillingDate>1/14/2007</BillingDate> <Status>Active</Status> <OSType /> <Terminate>False</Terminate> <TerminateDate /> <HasWSC>True</HasWSC> <WSCEnabled>True</WSCEnabled> <WSCLaunchURL>http://wsc.ehost-services.com/servlet/ CMWizardLN?flush=F7480EBA6798052499D1BA835B436021</WSCLaunchURL> <currentplanprice>15.05</currentplanprice> <canupgrade>False</canupgrade> <wscfullprice /> <wscecommerceprice /> <wscversion>Ecommerce</wscversion> <HostHeaderDomains> <Domains> <Domain>resellerdocs.com</Domain> <DomainNameID>152566773</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>True</HasPOP> </Domains> <Domains> <Domain>resellerdocs2.net</Domain> <DomainNameID>318282340</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>False</HasPOP> </Domains> <Domains> <Domain>resellerdocs3.info</Domain> <DomainNameID>318282341</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>True</HasPOP> </Domains> </HostHeaderDomains> <hashostheaders>True</hashostheaders> <wscpath>WSC</wscpath> <siteurl>http://www.resellerdocs.com</siteurl> <IsLWSC>False</IsLWSC> <wscsiteid>100</wscsiteid> <PointedTo>True</PointedTo> <lwscperiodicbilling> <currentbillperiod /> <nextbillperiod /> <DiscountPlans> <Plan> <Month>3</Month> <PromoID>53</PromoID> <DiscountPercent>10</DiscountPercent> </Plan> <Plan> <Month>6</Month> <PromoID>54</PromoID> <DiscountPercent>15</DiscountPercent> </Plan> <Plan> <Month>12</Month> <PromoID>55</PromoID> <DiscountPercent>20</DiscountPercent> </Plan> </DiscountPlans> <DiscountPlanCnt>3</DiscountPlanCnt>

12/1/08

697

1999-2008 eNom, Inc.

API commands: WSC_GetAccountInfo

<CanUpdate>True</CanUpdate> <deletedate /> </lwscperiodicbilling> </HostPackage> <AvailableHeaderDomains /> <availabledomainlist>False</availabledomainlist> <availabledomaincount>836</availabledomaincount> </WSCHostAccounts> <Command>WSC_GETACCOUNTINFO</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>7.546875</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart GetAllDomains PurchaseServices WSC_GetAllPackages WSC_GetPricing WSC_Update_Ops

12/1/08

698

1999-2008 eNom, Inc.

API commands: WSC_GetAllPackages

WSC_GetAllPackages

Description
Definition
Retrieve a list of all Web hosting packages that include WSC, and all WSC stand-alone accounts.

Usage
Use this command to list all Web hosting packages that include WSC, and all WSC stand-alone accounts, in a domain name account. The response includes a variety of information about each WSC account, including the URL to launch the WSC site-building wizard for this 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. http://resellertest.enom.com/websitecreator/websitecreator_manage.asp? The account information on this page is provided by the WSC_GetAllPackages 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:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW GetLaunchURL ResponseType Required Required Optional; default is 1 Optional

Definition
Account login ID Account password Include URL to launch WSC wizard in response? Permitted values are 1 to include URL, 0 to omit. Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 1 4

12/1/08

699

1999-2008 eNom, Inc.

API commands: WSC_GetAllPackages

Returned parameters and values

Param name
WebHostID HostAccount WebStorage BandWidth SQLSize DatabaseType POPMailboxes Overage BillingDate Status OSType Terminate TerminateDate HasWSC WSCEnabled WSCLaunchURL CurrentPlanPrice CanUpgrade WSCFullPrice WSCVersion Domain DomainNameID WSCOnlyHeaders HasPOP HasHostHeaders WSCPath SiteURL IsLWSC WSCSiteID PointedTo CurrentBillPeriod NextBillPeriod Month PromoID DiscountPercent DiscountPlanCnt CanUpdate DeleteDate Command ErrCount

Definition
Individual identification number for this Web hosting or WSC stand-alone account The individual account name of this Web hosting or WSC stand-alone account Storage space available to this account Monthly bandwidth available to this account Database space available to this account Type of database configured for this account POP mailboxes for this account Overage option for this account Billing date of this account Active status of this account Operating system of our server on which your Web hosting account resides Is this account flagged for termination? If flagged for termination, on what date? Does this account have WSC? Is WSC enabled for this account? The URL for the WSC wizard for this account Monthly price for WSC Is this account eligible for upgrade? Price for WSC Full WSC version Name of domain associated with this account Our identification number for this domain name Is this domain associated with the WSC Web site? Does this domain have POP email associated with it? Do these domains have host headers? Return value WSC indicates that this is a Web hosting account that subscribes to WSC URL of the WSC-built Web site for this account Is this a WSC Lite free account? Our identification number for this WSC site Is the WSC-built Web site pointing to SiteURL? Current billing period Next billing period For multi-month discounts, the number of months customer pays for to receive this discount For multi-month discounts, the promo code for this discount For multi-month discounts, the discount percentage Number of discount plans listed here Can this billing period be changed? Scheduled delete date for this WSC Web site Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.

WSCECommercePrice Price for WSC eCommerce

12/1/08

700

1999-2008 eNom, Inc.

API commands: WSC_GetAllPackages

Param name
Err(x) Done

Definition
Error messages explaining the failure. These can be presented as is back to the client. 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
The following query retrieves a list of Web hosting accounts that include WSC, and WSC stand-alone accounts, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WSC_GETALLPACKAGES& uid=resellid&pw=resellpw&responsetype=xml

The response includes a wide variety of information on each Web hosting account that include WSC, and WSC stand-alone account:
<?xml version="1.0" ?> <interface-response> <WSCHostAccounts> <HostPackage> <WebHostID>1398</WebHostID> <HostAccount>test121406</HostAccount> <WebStorage /> <BandWidth /> <SQLSize /> <DatabaseType /> <POPMailBoxes /> <Overage /> <BillingDate>1/14/2007</BillingDate> <Status>Active</Status> <OSType /> <Terminate>False</Terminate> <TerminateDate /> <HasWSC>True</HasWSC> <WSCEnabled>True</WSCEnabled> <WSCLaunchURL>http://wsc.ehost-services.com/servlet/ CMWizardLN?flush=7D2643832113A75809908A9F1913DC72</WSCLaunchURL> <currentplanprice>15.05</currentplanprice> <canupgrade>False</canupgrade> <wscfullprice /> <wscecommerceprice /> <wscversion>Ecommerce</wscversion> <HostHeaderDomains> <Domains> <Domain>resellerdocs.com</Domain> <DomainNameID>152566773</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>True</HasPOP> </Domains> <Domains> <Domain>resellerdocs2.net</Domain>

12/1/08

701

1999-2008 eNom, Inc.

API commands: WSC_GetAllPackages

<DomainNameID>318282340</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>False</HasPOP> </Domains> <Domains> <Domain>resellerdocs3.info</Domain> <DomainNameID>318282341</DomainNameID> <WSCOnlyHeaders>True</WSCOnlyHeaders> <HasPOP>True</HasPOP> </Domains> </HostHeaderDomains> <hashostheaders>True</hashostheaders> <wscpath>WSC</wscpath> <siteurl>http://www.resellerdocs.com</siteurl> <IsLWSC>False</IsLWSC> <wscsiteid>100</wscsiteid> <PointedTo>True</PointedTo> <lwscperiodicbilling> <currentbillperiod /> <nextbillperiod /> <DiscountPlans> <Plan> <Month>3</Month> <PromoID>53</PromoID> <DiscountPercent>10</DiscountPercent> </Plan> <Plan> <Month>6</Month> <PromoID>54</PromoID> <DiscountPercent>15</DiscountPercent> </Plan> <Plan> <Month>12</Month> <PromoID>55</PromoID> <DiscountPercent>20</DiscountPercent> </Plan> </DiscountPlans> <DiscountPlanCnt>3</DiscountPlanCnt> <CanUpdate>True</CanUpdate> <deletedate /> </lwscperiodicbilling> </HostPackage> . . . </interface-response>

Related commands
AddToCart GetAllDomains PurchaseServices WSC_GetAccountInfo WSC_GetPricing WSC_Update_Ops

12/1/08

702

1999-2008 eNom, Inc.

API commands: WSC_GetPricing

WSC_GetPricing

Description
Definition
Retrieve this accounts wholesale costs or retail prices for Web Site Creator (WSC), and the URL for our WSC demo.

Usage
Use this command to retrieve the prices this account pays for WSC, or the prices this account charges retail customers. Use this command to retrieve the URL to our WSC demo. Package names that begin with WSC offer WSC as part of a Web hosting packageyour customer can build one Web site using the Web Site Creator wizard and in addition have up to 49 other Web sites hosted through the same package. Package names that begin with LWSC offera single Web site: the one built in the WSC wizard.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://resellertest.enom.com/myaccount/hostingpricing.asp?tab=webhosting

In the Web Site Creator Pricing table, the My Total Cost (WSC + Hosting) column shows the same return values as the WSC_GetPricing command used in the wholesale price mode. The Total Price (WSC + Hosting) column shows the return values when GetRetail=true.
http://enom.staging.local/myaccount/ProductPricing.asp?tab=domainaddons

In the web tools table, the Your Cost column shows the same return values as the WSC_GetPricing command used in the wholesale price mode. The Price column shows the return values when GetRetail=true.

Constraints
The query must meet the following requirements: The login ID and password must be valid.

12/1/08

703

1999-2008 eNom, Inc.

API commands: WSC_GetPricing

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name Obligation

UID PW GetRetail Required Required Optional

Definition
Account login ID Account password Get prices this account charges to retail customers? Permitted value is true. Any other value, or not using this parameter, returns prices this account pays for WSC. In what language should the WSC wizard launch? Permitted values are: Eng English Fre French Ger German Ita Italian Por Portuguese Spa Spanish Format of response. Options are Text (default), HTML, or XML.

Max size
20 20 4

Language

Optional; default is Eng

ResponseType

Optional

Returned parameters and values

Param name
WSCBasicPrice WSCFullPrice WSCECommercePrice LWSCBasicPrice LWSCFullPrice

Definition
This accounts wholesale cost or retail price for the WSC Basic package, as an add-on to a Web hosting package This accounts wholesale cost or retail price for the WSC Full package, as an add-on to a Web hosting package This accounts wholesale cost or retail price for the WSC eCommerce package, as a stand-alone product This accounts wholesale cost or retail price for the WSC Basic stand-alone package (supports only the WSC Web site) This accounts wholesale cost or retail price for the WSC Full stand-alone package

LWSCECommercePrice This accounts wholesale cost or retail price for the WSC eCommerce standalone package WSCDemoURL Command ErrCount Err(x) Done URL of our Web Site Creator demo Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

704

1999-2008 eNom, Inc.

API commands: WSC_GetPricing

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
The following query retrieves this accounts wholesale costs for Web Site Creator packages, and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WSC_GETPRICING& uid=resellid&pw=resellpw&responsetype=xml

In the response, WSC prices and an ErrCount value 0 confirm that the query was successful:
<?xml version="1.0" ?> <interface-response> <wscpricing> <wscbasicprice>2.85</wscbasicprice> <wscfullprice>5.75</wscfullprice> <wscecommerceprice>9.25</wscecommerceprice> <lwscbasicprice>2.85</lwscbasicprice> <lwscfullprice>5.75</lwscfullprice> <lwscecommerceprice>11.75</lwscecommerceprice> </wscpricing> <wscdemo> <wscdemourl>http://wsc.ehost-services.com/create_demo_account.jsp?productId= WSCENOSSSLYTC215&clientId=RRENOS999JZT4SYQ&language=en&country=US& wl_name=wl_enom&demoCallbackUrl=</wscdemourl> </wscdemo> <Command>WSC_GETPRICING</Command> <Language>en</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.1484375</ExecTime> <Done>true</Done> <debug> <![CDATA[ ]]> </debug> </interface-response>

Related commands
AddToCart GetAllDomains PurchaseServices WSC_GetAccountInfo WSC_GetAllPackages WSC_Update_Ops

12/1/08

705

1999-2008 eNom, Inc.

API commands: WSC_Update_Ops

WSC_Update_Ops
Description
Definition
Upgrade Web Site Creator.

Usage
Use this command to upgrade Web Site Creator stand-alone accounts (Web hosting accounts with account names using format LWSCNNNxNNNN), that are at least Lite Basic. The following table lays out the upgrade path for WSC stand-alone products (Lite, Lite Basic, Lite Full, and Lite eCommerce):

If you have:
No WSC No WSC

And want:
WSC Lite Lite Basic Lite Full Lite eCommerce Lite Basic Lite Full Lite eCommerce Upgrade to a higher plan Change to a different billing cycle

And purchase in this way:

No purchase necessary for WSC Lite Real time

Use this command:

ServiceSelect PurchaseServices

No WSC

Shopping cart

ServiceSelect to create Lite, then AddToCart to upgrade to higher plan

Lite Basic Lite Full Lite Basic Lite Full Lite eCommerce

Billing amount is deducted from your account balance Billing amount is deducted from your account balance

WSC_Update_Ops in the last

month of the current billing cycle WSC_Update_Ops in the last month of the current billing cycle

To upgrade Web Site Creator within a Web hosting account (Web hosting accounts with names that do not begin with LWSC), use the WebHostSetCustomPackage command. You cannot downgrade Web Site Creator from a higher to a lower version.

Availability
All resellers have access to this command.

Implementation on eNom.com
Log on to resellertest.enom.com with Login ID resellid, password resellpw.
http://enom.staging.local/websitecreator/websitecreator_manage.asp

The upgrade now button calls the WSC_Update_Ops command.

Constraints
The query must meet the following requirements: The login ID and password must be valid. The Web Site Creator account must belong to this domain name account.

12/1/08

706

1999-2008 eNom, Inc.

API commands: WSC_Update_Ops

You can only use this command in the last 30 days of the current billing cycle. You can only upgrade Lite Basic and Lite Full plans with this command. See Usage section above. You can change the billing cycle with this command, with or without upgrading the plan.

Input parameters
Build the query string using this syntax:
http://resellertest.enom.com/interface.asp?command=nameofcommand& uid=yourloginid&pw=yourpassword&paramname=paramvalue&nextparamname=nextparamvalue

Param name
UID PW Account NewLWSCPlan

Obligation
Required Required Required Optional; default is current plan

Definition
Account login ID Account password Name of LWSC account. Must be an account name with format LWSCNNNxNNNN

Max size
20 20 14

13 Level of service you want. Your current plan must be at least Lite Basic (you must use PurchaseServices or AddToCart to upgrade from Lite to a higher plan). Permitted values are: LWSCBasic LWSCFull LWSCECommerce You can upgrade the plan when you are within 30 days of the next billing date. Billing period, in months. Permitted values are 2 1, 3, 6, or 12. You can change the billing period when you are within 30 days of the next billing date. Format of response. Options are Text (default), 4 HTML, or XML.

LWSCBillCycle

Optional; default is current billing cycle

ResponseType

Optional

Returned parameters and values

Param name
AccountStatusID Successful PlanUpdated BillingCycleUpdated Command ErrCount Err(x) Done

Definition
1 indicates a valid, active account. True indicates that the query executed successfully True indicates that the LWSC plan was successfully upgraded True indicates that the LWSC billing cycle was successfully changed Name of command executed The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values. Error messages explaining the failure. These can be presented as is back to the client. 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.

12/1/08

707

1999-2008 eNom, Inc.

API commands: WSC_Update_Ops

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
The following query upgrades Web Site Creator to eCommerce and sends the response in XML format:
http://resellertest.enom.com/interface.asp?command=WSC_Update_Ops& uid=resellid&pw=resellpw&Account=LWSC337x8128& NewLWSCPlan=LWSCEcommerce&LWSCBillCycle=6&ResponseType=XML

In the response, the ErrCount value 0 confirms that the query was successful:
<?xml version="1.0" ?> <interface-response> <AccountStatusID>1</AccountStatusID> <Successful>True</Successful> <Successful>True</Successful> <PlanUpdated>True</PlanUpdated> <BillingCycleUpdated>True</BillingCycleUpdated> <Command>WSC_UPDATE_OPS</Command> <Language>eng</Language> <ErrCount>0</ErrCount> <ResponseCount>0</ResponseCount> <MinPeriod /> <MaxPeriod>10</MaxPeriod> <Server>RESELLERTEST</Server> <Site>enom</Site> <IsLockable /> <IsRealTimeTLD /> <TimeDifference>+0.00</TimeDifference> <ExecTime>0.078125</ExecTime> <Done>true</Done> </interface-response>

Related commands
AddToCart Purchase PurchaseServices ServiceSelect WSC_GetAccountInfo WSC_GetAllPackages WSC_GetPricing

12/1/08

708

1999-2008 eNom, Inc.

Index

Index Index
A
account ID validating . . . . . . . . . . . . accounting CommissionAccount . . . . . GetBalance . . . . . . . . . . . PE_GetCustomerPricing . . PE_GetDomainPricing . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricinge . . . . PE_GetRocketPrice . . . . . PE_GetTLDID . . . . . . . . . PE_SetPricing . . . . . . . . . SetResellerServicesPricing SetResellerTLDPricing . . . UpdateAccountPricing . . . . accounts AuthorizeTLD . . . . . . . . . CheckLogin . . . . . . . . . . . CreateAccount . . . . . . . . . CreateSubAccount . . . . . . DeleteSubaccount . . . . . . GetAccountInfo . . . . . . . . GetAccountPassword . . . . GetAccountValidation . . . . GetAllAccountInfo . . . . . . GetConfirmationSettings . . GetCusPreferences . . . . . GetCustomerPaymentInfo . GetDomainCount . . . . . . . GetDomains . . . . . . . . . . GetOrderDetail . . . . . . . . GetOrderList . . . . . . . . . . GetReport . . . . . . . . . . . . GetResellerInfo . . . . . . . . GetSubAccountDetails . . . GetSubAccounts . . . . . . . GetSubAccountsDetailList .

. . . . . . . . . 84 ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... 89 172 412 416 419 421 425 429 433 438 440 442 566 569 641 50 84 95 100 128 150 153 155 165 183 190 197 205 234 293 296 324 327 336 346 349

GetTLDList . . . . . . . . . . GetTransHistory . . . . . . . RefillAccount . . . . . . . . . RemoveTLD . . . . . . . . . . RPT_GetReport . . . . . . . SendAccountEmail . . . . . UpdateAccountInfo . . . . . UpdateCusPreferences . . UpdateNotificationAmount . UpdateRenewalSettings . . validating user ID . . . . . . AddBulkDomains . . . . . . . . . AddContact . . . . . . . . . . . . . AddDomainFolder . . . . . . . . . AddToCart . . . . . . . . . . . . . . AdvancedDomainSearch . . . . AssignToDomainFolder . . . . . auctions Check . . . . . . . . . . . . . . authorization key GetContacts . . . . . . . . . . AuthorizeTLD . . . . . . . . . . . . automatic renewals GetCusPreferences . . . . . GetRenew . . . . . . . . . . . SetPakRenew . . . . . . . . SetRenew . . . . . . . . . . . UpdateCusPreferences . . UpdateRenewalSettings . . availability checking domain names . .

. . . . . . . . . . 352 . . . . . . . . . . 355 . . . . . . . . . . 490 . . . . . . . . . . 497 . . . . . . . . . . 511 . . . . . . . . . . 515 . . . . . . . . . . 636 . . . . . . . . . . 649 . . . . . . . . . . 670 . . . . . . . . . . 675 . . . . . . . . . . 84 . . . . . . . . . . 17 . . . . . . . . . . 20 . . . . . . . . . . 23 . . . . . . . . . . 26 . . . . . . . . . . 39 . . . . . . . . . . 46 . . . . . . . . . . 80 . . . . . . . . . . 186 . . . . . . . . . . 50 . . . . . . . . . . 190 . . . . . . . . . . 321 . . . . . . . . . . 551 . . . . . . . . . . 563 . . . . . . . . . . 649 . . . . . . . . . . 675 . . . . . . . . . . 80 . . . . . . . . . . 172 . . . . . . . . . . 490 . . . . . . . . . . 670 . . . . . . . . . . 419 . . . . . . . . . . 469 . . . . . . . . . . 17

B
balances GetBalance . . . . . . . . . . RefillAccount . . . . . . . . . UpdateNotificationAmount . bulk PE_GetPOPPrice . . . . . . PurchasePOPBundle . . . . purchasing domains . . . . .

12/1/08

709

1999-2008 eNom, Inc.

Index:

pushing domains to another account BundleID retrieving . . . . . . . . . . . . . . . . . . Business Listing PurchaseServices . . . . . . . . . . . . WBLConfigure . . . . . . . . . . . . . . . WBLGetCategories . . . . . . . . . . . . WBLGetFields . . . . . . . . . . . . . . . WBLGetStatus . . . . . . . . . . . . . . .

. . . 672 . . . 302 ... ... ... ... ... 475 680 685 688 691

C
cancelling orders DeleteRegistration . . . . . transfer orders . . . . . . . . cart AddBulkDomains . . . . . . AddToCart . . . . . . . . . . DeleteFromCart . . . . . . . GetCartContent . . . . . . . InsertNewOrder . . . . . . . Purchase . . . . . . . . . . . PurchasePreview . . . . . . UpdateCart . . . . . . . . . . CertConfigureCert . . . . . . . . CertGetApproverEmail . . . . . CertGetCertDetail . . . . . . . . . CertGetCerts . . . . . . . . . . . . CertModifyCert . . . . . . . . . . CertParseCSR . . . . . . . . . . . CertPurchaseCert. . . . . . . . . certs CertConfigureCert . . . . . CertGetApproverEmail . . CertGetCertDetail . . . . . . CertGetCerts item list . . . CertModifyCert . . . . . . . CertParseCSR . . . . . . . . CertPurchaseCert . . . . . GetCerts product list . . . . PurchaseServices . . . . . ChannelME.TV ME_AddChannelReseller . Check . . . . . . . . . . . . . . . . checking out DeleteFromCart . . . . . . . CheckLogin . . . . . . . . . . . . . CheckNSStatus . . . . . . . . . . checkout Purchase . . . . . . . . . . . PurchasePreview . . . . . . UpdateCart . . . . . . . . . . CommissionAccount . . . . . . . configure GetExtAttributes . . . . . . . configuring extended attributes Preconfigure . . . . . . . . . contact information AddContact . . . . . . . . . . Contacts . . . . . . . . . . . .

. . . . . . . . . . 125 . . . . . . . . . . 587 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... 17 26 113 174 391 456 472 646 53 59 62 67 71 74 77 53 59 62 67 71 74 77 180 475

DeleteContact . . . . . . . . . . GetAddressBook . . . . . . . . . GetAllAccountInfo . . . . . . . . GetContacts . . . . . . . . . . . . GetDomainMap . . . . . . . . . GetDomainPhone . . . . . . . . GetForwarding . . . . . . . . . . GetServiceContact . . . . . . . GetSubaccountsDetailList . . . GetWhoisContact . . . . . . . . ServiceSelect . . . . . . . . . . . SetDomainMap . . . . . . . . . . SetDomainPhone . . . . . . . . Contacts . . . . . . . . . . . . . . . . . contents GetCartContent . . . . . . . . . country code GetExtAttributes . . . . . . . . . country codes Preconfigure . . . . . . . . . . . CreateAccount . . . . . . . . . . . . . CreateSubAccount . . . . . . . . . . customer notifications UpdateRenewalSettings . . . . customer support GetServiceContact . . . . . . . customer-defined data . . . . . . . . DeleteCustomerDefinedData . GetCustomerDefinedData . . . customers CreateAccount . . . . . . . . . . CreateSubAccount . . . . . . . GetAccountInfo . . . . . . . . . . GetAllAccountInfo . . . . . . . . GetCustomerPaymentInfo . . . GetResellerInfo . . . . . . . . . .

. . . . . . . . 106 . . . . . . . . 158 . . . . . . . . 165 . . . . . . . . 186 . . . . . . . . 225 . . . . . . . . 230 . . . . . . . . 266 . . . . . . . . 333 . . . . . . . . 349 . . . . . . . . 363 . . . . . . . . 517 . . . . . . . . 529 . . . . . . . . 532 . . . . . . . . 91 . . . . . . . . 174 . . . . . . . . 258 . . . . . . . . 447 . . . . . . . . 95 . . . . . . . . 100 . . . . . . . . 675 . . . . . . . . 333 . . . . . . . . 524 . . . . . . . . 108 . . . . . . . . 194 . . . . . . . . 95 . . . . . . . . 100 . . . . . . . . 150 . . . . . . . . 165 . . . . . . . . 197 . . . . . . . . 327

. . . . . . . . . . 394 . . . . . . . . . . 80 . . . . . . . . . . 113 . . . . . . . . . . 84 . . . . . . . . . . 86 .......... .......... .......... .......... 456 472 646 89

. . . . . . . . . . 258 . . . . . . . . . . 447 . . . . . . . . . . 20 . . . . . . . . . . 91

DeleteAllPOPPaks . . . . . . . DeleteContact . . . . . . . . . . DeleteCustomerDefinedData . DeleteDomainFolder . . . . . . DeleteFromCart . . . . . . . . . DeleteHostedDomain . . . . . . DeleteNameserver . . . . . . . DeletePOP3 . . . . . . . . . . . . DeletePOPPak . . . . . . . . . . DeleteRegistration . . . . . . . . DeleteSubaccount . . . . . . . . DisableServices . . . . . . . . . DNS CheckNSStatus . . . . . . GetDNS . . . . . . . . . . . GetDNSStatus . . . . . . . ModifyNS . . . . . . . . . . ModifyNSHosting . . . . . redirect hosting . . . . . . . DNS hosting DeleteHostedDomain . . .

. . . . . . . . . . . 103 . . . . . . . . . . . 106 . . . . . . . . . . . 108 . . . . . . . . . . . 110 . . . . . . . . . . . 113 . . . . . . . . . . . 115 . . . . . . . . . . . 117 . . . . . . . . . . . 120 . . . . . . . . . . . 123 . . . . . . . . . . . 125 . . . . . . . . . . . 128 . . . . . . . . . . . 131 . . . . . . . . . . . 86 . . . . . . . . . . . 200 . . . . . . . . . . . 203 . . . . . . . . . . . 398 . . . . . . . . . . . 401 . . . . . . . . . . . 401 . . . . . . . . . . . 115
710

12/1/08

1999-2008 eNom, Inc.

Index:

ExtendDomainDNS . . . . . PurchaseHosting . . . . . . . PurchaseServices . . . . . . domain folders AddDomainFolder . . . . . . AssignToDomainFolder . . . DeleteDomainFolder . . . . . GetDomainFolderDetail . . . GetDomainFolderList . . . . RemoveUnsyncedDomains UpdateDomainFolder . . . . domain management AddDomainFolder . . . . . . AdvancedDomainSearch . . AssignToDomainFolder . . . CheckNSStatus . . . . . . . . DeleteDomainFolder . . . . . GetAllDomains . . . . . . . . GetDomainCount . . . . . . . GetDomainExp . . . . . . . . GetDomainFolderDetail . . . GetDomainFolderList . . . . GetDomainInfo . . . . . . . . GetDomains . . . . . . . . . . GetDomainStatus . . . . . . . GetExpiredDomains . . . . . GetExtendInfo . . . . . . . . . GetHomeDomainList . . . . . GetPasswordBit . . . . . . . . GetRegistrationStatus . . . . GetRegLock . . . . . . . . . . GetRenew . . . . . . . . . . . GetSubAccountPassword . PushDomain . . . . . . . . . . RemoveUnsyncedDomains renewals . . . . . . . . . . . . SetPakRenew . . . . . . . . . SetPassword . . . . . . . . . . SetRegLock . . . . . . . . . . SetRenew . . . . . . . . . . . . SubAccountDomains . . . . UpdateDomainFolder . . . . ValidatePassword . . . . . . domain name IDs GetAllDomains . . . . . . . . GetHomeDomainList . . . . . SubAccountDomains . . . . domain name servers CheckNSStatus . . . . . . . . DeleteHostedDomain . . . . ExtendDomainDNS . . . . . GetDNS . . . . . . . . . . . . . GetDNSStatus . . . . . . . . . ModifyNS . . . . . . . . . . . . ModifyNSHosting . . . . . . . PurchaseHosting . . . . . . . redirect hosting . . . . . . . . domain names AddToCart . . . . . . . . . . .

. . . . . . . . . 143 . . . . . . . . . 465 . . . . . . . . . 475 ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... 23 46 110 211 217 500 653 23 39 46 86 110 169 205 208 211 217 220 234 246 255 262 278 299 315 318 321 343 487 500 262 551 554 560 563 582 653 678

. . . . . . . . . 169 . . . . . . . . . 278 . . . . . . . . . 582 ......... ......... ......... ......... ......... ......... ......... ......... ......... 86 115 143 200 203 398 401 465 401

. . . . . . . . . 26

checking availability . . . . . . . . . . . DeleteRegistration . . . . . . . . . . . . GetDomainNameID . . . . . . . . . . . GetDomainSLDTLD . . . . . . . . . . . monitoring non-real-time purchases NameSpinner . . . . . . . . . . . . . . . ParseDomain . . . . . . . . . . . . . . . retrieveing order ID . . . . . . . . . . . ValidatePassword . . . . . . . . . . . . domain pricing GetSubAccountDetails . . . . . . . . . domain registration . . . . . . . . . . . . . . AddBulkDomains . . . . . . . . . . . . Check . . . . . . . . . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . . InsertNewOrder . . . . . . . . . . . . . Purchase . . . . . . . . . . . . . . . . . . StatusDomain . . . . . . . . . . . . . . . validating user ID . . . . . . . . . . . . domain renewals Extend . . . . . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . domain services DisableServices . . . . . . . . . . . . . EnableServices . . . . . . . . . . . . . . GetDomainMap . . . . . . . . . . . . . GetDomainPhone . . . . . . . . . . . . GetDomainServices . . . . . . . . . . . GetDomainSubServices . . . . . . . . GetIPResolver . . . . . . . . . . . . . . ServiceSelect . . . . . . . . . . . . . . . SetDomainMap . . . . . . . . . . . . . . SetDomainPhone . . . . . . . . . . . . SetDomainSubServices . . . . . . . . SetIPResolver . . . . . . . . . . . . . . domain transfers PushDomain . . . . . . . . . . . . . . . SynchAuthInfo . . . . . . . . . . . . . . TP_CancelOrder . . . . . . . . . . . . . TP_CreateOrder . . . . . . . . . . . . . TP_GetDetailsByDomain . . . . . . . TP_GetOrder . . . . . . . . . . . . . . . TP_GetOrderDetail . . . . . . . . . . . TP_GetOrderReview . . . . . . . . . . TP_GetOrdersByDomain . . . . . . . TP_GetOrderStatuses . . . . . . . . . TP_GetTLDInfo . . . . . . . . . . . . . TP_ResendEmail . . . . . . . . . . . . TP_ResubmitLocked . . . . . . . . . . TP_SubmitOrder . . . . . . . . . . . . . TP_UpdateOrderDetail . . . . . . . . . UpdatePushList . . . . . . . . . . . . . DomainNameID retrieving for a single domain . . . . .

. . . . 80 . . . . 125 . . . . 228 . . . . 241 . . . . 293 . . . . 406 . . . . 410 . . . . 246 . . . . 678 . . . . 336 . . . . 391 . . . . 17 . . . . 80 . . . . 336 . . . . 391 . . . . 456 . . . . 579 . . . . 84 . . . . 136 . . . . 140 . . . . 208 . . . . 262 . . . . 321 . . . . 563 . . . . 662 . . . . 131 . . . . 133 . . . . 225 . . . . 230 . . . . 238 . . . . 249 . . . . 284 . . . . 517 . . . . 529 . . . . 532 . . . . 538 . . . . 548 . . . . 487 . . . . 585 . . . . 587 . . . . 590 . . . . 596 . . . . 599 . . . . 603 . . . . 607 . . . . 610 . . . . 613 . . . . 616 . . . . 620 . . . . 623 . . . . 626 . . . . 630 . . . . 672 . . . . 220
711

12/1/08

1999-2008 eNom, Inc.

Index:

domains adding bulk . . . . . . . . . . AdvancedDomainSearch . Extend . . . . . . . . . . . . . Extend_RGP . . . . . . . . . get domain password . . . GetDomainNameID . . . . GetDomainSLDTLD . . . . ModifyNS . . . . . . . . . . . ParseDomain . . . . . . . . PE_GetCustomerPricing . PE_GetDomainPricing . . PE_GetPOPPrice . . . . . . PE_GetProductPrice . . . . PE_GetResellerPrice . . . PE_GetRetailPrice . . . . . PE_GetRetailPricing . . . . PE_GetRocketPrice . . . . PE_GetTLDID . . . . . . . . PE_SetPricing . . . . . . . . SetResellerTLDPricing . . UpdateAccountPricing . . . UpdateExpiredDomains . . dynamic IP SetDNSHost . . . . . . . . .

.......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... ..........

17 39 136 140 343 228 241 398 410 412 416 419 421 425 429 433 438 440 442 569 641 662

. . . . . . . . . . 527 . . . . . . . 360 . . . . . . . 272 . . . . . . . 275 ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... 147 177 252 287 309 521 541 557 103 120 123 147 177 252 266 287 302 306 309 370 373 376 379 382 385

HE_UpgradeAccount . . . ModifyPOP3 passwords . PE_GetPOPPrice . . . . . PurchasePOPBundle . . . RenewPOPBundle . . . . ServiceSelect . . . . . . . . SetCatchAll . . . . . . . . . SetDotNameForwarding . SetPakRenew . . . . . . . SetPOPForwarding . . . . SetUpPOP3User . . . . . . TP_ResendEmail . . . . . EnableServices . . . . . . . . . . EPP authorization key SynchAuthInfo . . . . . . . expiration dates GetAllDomains . . . . . . . GetHomeDomainList . . . SubAccountDomains . . . Extend . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . ExtendDomainDNS . . . . . . . extended attributes GetExtAttributes . . . . . . Preconfigure . . . . . . . .

. . . . . . . . . . . 388 . . . . . . . . . . . 403 . . . . . . . . . . . 419 . . . . . . . . . . . 469 . . . . . . . . . . . 503 . . . . . . . . . . . 517 . . . . . . . . . . . 521 . . . . . . . . . . . 541 . . . . . . . . . . . 551 . . . . . . . . . . . 557 . . . . . . . . . . . 576 . . . . . . . . . . . 620 . . . . . . . . . . . 133 . . . . . . . . . . . 585 . . . . . . . . . . . 169 . . . . . . . . . . . 278 . . . . . . . . . . . 582 . . . . . . . . . . . 136 . . . . . . . . . . . 140 . . . . . . . . . . . 143 . . . . . . . . . . . 258 . . . . . . . . . . . 447 . . . . . . . . . 23 . . . . . . . . . 46 . . . . . . . . . 110 . . . . . . . . . 211 . . . . . . . . . 217 . . . . . . . . . 500 . . . . . . . . . 653 . . . . . . . . . 147 . . . . . . . . . 269

E
EC key GetWebHostingAll . . . . . . . . editing GetGlobalChangeStatus . . . . GetGlobalChangeStatusDetail email forwarding Forwarding . . . . . . . . . . . . . GetCatchAll . . . . . . . . . . . . GetDotNameForwarding . . . . GetMailHosts . . . . . . . . . . . GetPOPForwarding . . . . . . . SetCatchAll . . . . . . . . . . . . . SetDotNameForwarding . . . . SetPOPForwarding . . . . . . . . email services DeleteAllPOPPaks . . . . . . . . DeletePOP3 user . . . . . . . . . DeletePOPPak . . . . . . . . . . Forwarding . . . . . . . . . . . . . GetCatchAll . . . . . . . . . . . . GetDotNameForwarding . . . . GetForwarding . . . . . . . . . . . GetMailHosts . . . . . . . . . . . GetPOP3 . . . . . . . . . . . . . . GetPOPExpirations . . . . . . . GetPOPForwarding . . . . . . . HE_CancelAccount . . . . . . . HE_ChangePassword . . . . . . HE_CreateAccount . . . . . . . . HE_GetAccountDetails . . . . . HE_GetAccounts . . . . . . . . . HE_GetPricing . . . . . . . . . . .

F
folders AddDomainFolder . . . . . . . AssignToDomainFolder . . . DeleteDomainFolder . . . . . GetDomainFolderDetail . . . GetDomainFolderList . . . . . RemoveUnsyncedDomains . UpdateDomainFolder . . . . . Forwarding . . . . . . . . . . . . . . fraud GetFraudScore . . . . . . . . .

GetAccountInfo . . . . . . . . GetAccountPassword . . . . GetAccountValidation . . . . GetAddressBook . . . . . . . GetAgreementPage . . . . . GetAllAccountInfo . . . . . . GetAllDomains . . . . . . . . GetBalance . . . . . . . . . . GetCartContent . . . . . . . GetCatchAll . . . . . . . . . . GetCerts . . . . . . . . . . . . GetConfirmationSettings . . GetContacts . . . . . . . . . . GetCusPreferences . . . . . GetCustomerDefinedData . GetCustomerPaymentInfo . GetDNS . . . . . . . . . . . . GetDNSStatus . . . . . . . . GetDomainCount . . . . . .

. . . . . . . . . . . . . 150 . . . . . . . . . . . . . 153 . . . . . . . . . . . . . 155 . . . . . . . . . . . . . 158 . . . . . . . . . . . . . 162 . . . . . . . . . . . . . 165 . . . . . . . . . . . . . 169 . . . . . . . . . . . . . 172 . . . . . . . . . . . . . 174 . . . . . . . . . . . . . 177 . . . . . . . . . . . . . 180 . . . . . . . . . . . . . 183 . . . . . . . . . . . . . 186 . . . . . . . . . . . . . 190 . . . . . . . . . . . . . 194 . . . . . . . . . . . . . 197 . . . . . . . . . . . . . 200 . . . . . . . . . . . . . 203 . . . . . . . . . . . . . 205

12/1/08

712

1999-2008 eNom, Inc.

Index:

GetDomainExp . . . . . . . . . . . . . GetDomainFolderDetail . . . . . . . . GetDomainFolderList . . . . . . . . . GetDomainInfo . . . . . . . . . . . . . GetDomainMap . . . . . . . . . . . . . GetDomainNameID . . . . . . . . . . GetDomainPhone . . . . . . . . . . . . GetDomains . . . . . . . . . . . . . . . GetDomainServices . . . . . . . . . . GetDomainSLDTLD . . . . . . . . . . GetDomainSRVHosts . . . . . . . . . GetDomainStatus . . . . . . . . . . . . GetDomainSubServices. . . . . . . . GetDotNameForwarding . . . . . . . GetExpiredDomains . . . . . . . . . . GetExtAttributes . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . GetForwarding . . . . . . . . . . . . . . GetFraudScore . . . . . . . . . . . . . GetGlobalChangeStatus . . . . . . . GetGlobalChangeStatusDetail . . . GetHomeDomainList . . . . . . . . . . GetHosts . . . . . . . . . . . . . . . . . GetIPResolver . . . . . . . . . . . . . . GetMailHosts . . . . . . . . . . . . . . GetMetaTag . . . . . . . . . . . . . . . GetOrderDetail . . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . . GetPasswordBit . . . . . . . . . . . . . GetPOP3 . . . . . . . . . . . . . . . . . GetPOPExpirations . . . . . . . . . . GetPOPForwarding . . . . . . . . . . GetRegHosts . . . . . . . . . . . . . . GetRegistrationStatus . . . . . . . . . GetRegLock . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . GetReport . . . . . . . . . . . . . . . . . GetResellerInfo . . . . . . . . . . . . . GetServiceContact . . . . . . . . . . . GetSPFHosts . . . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . GetSubAccountPassword . . . . . . GetSubAccounts . . . . . . . . . . . . GetSubAccountsDetailList . . . . . . getting commission balances . . . . . . GetTLDList . . . . . . . . . . . . . . . . GetTransHistory . . . . . . . . . . . . . GetWebHostingAll . . . . . . . . . . . GetWhoisContact . . . . . . . . . . . . GetWPPSInfo . . . . . . . . . . . . . . global edit GetGlobalChangeStatus . . . . GetGlobalChangeStatusDetail HE_CancelAccount . . HE_ChangePassword . HE_CreateAccount . . .

....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... ....... .......

208 211 217 220 225 228 230 234 238 241 243 246 249 252 255 258 262 266 269 272 275 278 281 284 287 290 293 296 299 302 306 309 312 315 318 321 324 327 333 330 336 343 346 349 89 352 355 360 363 366

HE_GetAccountDetails . . . . HE_GetAccounts . . . . . . . HE_GetPricing . . . . . . . . . HE_UpgradeAccount . . . . . history get transaction history . RPT_GetReport . . . . . host records GetDomainSRVHosts . GetHosts . . . . . . . . . . GetMetaTag . . . . . . . . GetRegHosts . . . . . . . SetDNSHost . . . . . . . SetDomainSRVHosts . . SetHosts . . . . . . . . . . UpdateMetaTag . . . . . Hosted Microsoft Exchange HE_CancelAccount . . . HE_ChangePassword . HE_CreateAccount . . . HE_GetAccountDetails . HE_GetAccounts . . . . HE_GetPricing . . . . . . HE_UpgradeAccount . . hosting DeleteHostedDomain . . ExtendDomainDNS . . . PurchaseHosting . . . . .

. . . . . . . . . . . . 379 . . . . . . . . . . . . 382 . . . . . . . . . . . . 385 . . . . . . . . . . . . 388 . . . . . . . . . . . . 355 . . . . . . . . . . . . 511 . . . . . . . . . . . . 243 . . . . . . . . . . . . 281 . . . . . . . . . . . . 290 . . . . . . . . . . . . 312 . . . . . . . . . . . . 527 . . . . . . . . . . . . 535 . . . . . . . . . . . . 544 . . . . . . . . . . . . 664 . . . . . . . . . . . . 370 . . . . . . . . . . . . 373 . . . . . . . . . . . . 376 . . . . . . . . . . . . 379 . . . . . . . . . . . . 382 . . . . . . . . . . . . 385 . . . . . . . . . . . . 388 . . . . . . . . . . . . 115 . . . . . . . . . . . . 143 . . . . . . . . . . . . 465

I
identity AddContact . . . . . Contacts . . . . . . . DeleteContact . . . GetAddressBook . . GetContacts . . . . . GetServiceContact validating . . . . . . . identity protection DisableServices . . EnableServices . . . GetWPPSInfo . . . . PurchaseServices . RenewServices . . . ServiceSelect . . . . InsertNewOrder . . . . . IP address update SetDNSHost . . . . IP forwarding GetIPResolver . . . SetIPResolver . . . items DeleteFromCart . . Purchase . . . . . . .

. . . . . . . . . . . . . . . 20 . . . . . . . . . . . . . . . 91 . . . . . . . . . . . . . . . 106 . . . . . . . . . . . . . . . 158 . . . . . . . . . . . . . . . 186 . . . . . . . . . . . . . . . 333 . . . . . . . . . . . . . . . 84 . . . . . . . . . . . . . . . 131 . . . . . . . . . . . . . . . 133 . . . . . . . . . . . . . . . 366 . . . . . . . . . . . . . . . 475 . . . . . . . . . . . . . . . 507 . . . . . . . . . . . . . . . 517 . . . . . . . . . . . . . . . 391 . . . . . . . . . . . . . . . 527 . . . . . . . . . . . . . . . 284 . . . . . . . . . . . . . . . 548 . . . . . . . . . . . . . . . 113 . . . . . . . . . . . . . . . 456 . . . . . . . . . . . . . . . 360

. . . . . . . 272 . . . . . . . 275

. . . . . . . . . . . . . . . 370 . . . . . . . . . . . . . . . 373 . . . . . . . . . . . . . . . 376

K
keys GetWebHostingAll .

12/1/08

713

1999-2008 eNom, Inc.

Index:

L
location GetDomainMap SetDomainMap locking domains GetRegLock . . SetRegLock . . login validating . . . .

. . . . . . . . . . . . . . . . . 225 . . . . . . . . . . . . . . . . . 529 . . . . . . . . . . . . . . . . . 318 . . . . . . . . . . . . . . . . . 560 . . . . . . . . . . . . . . . . . 84 . . . . . . . . . 23 ......... ......... ......... ......... ......... ......... 46 110 211 217 500 653

M
Magic Folders AddDomainFolder . . . . . . Magic folders AssignToDomainFolder . . . DeleteDomainFolder . . . . . GetDomainFolderDetail . . . GetDomainFolderList . . . . RemoveUnsyncedDomains UpdateDomainFolder . . . . mail GetSPFHosts . . . . . . . . . SetSPFHosts . . . . . . . . . mail records GetMailHosts . . . . . . . . . mail services DeleteAllPOPPaks . . . . . . DeletePOP3 . . . . . . . . . . DeletePOPPak . . . . . . . . Forwarding . . . . . . . . . . . GetCatchAll . . . . . . . . . . GetDotNameForwarding . . GetForwarding . . . . . . . . . GetPOP3 . . . . . . . . . . . . GetPOPExpirations . . . . . GetPOPForwarding . . . . . HE_CancelAccount . . . . . HE_ChangePassword . . . . HE_CreateAccount . . . . . . HE_GetAccountDetails . . . HE_GetAccounts . . . . . . . HE_GetPricing . . . . . . . . . HE_UpgradeAccount . . . . ModifyPOP3 passwords. . . PE_GetPOPPrice . . . . . . . PurchasePOPBundle . . . . RenewPOPBundle . . . . . . SetCatchAll . . . . . . . . . . . SetDotNameForwarding . . SetPakRenew . . . . . . . . . SetPOPForwarding . . . . . . SetUpPOP3User . . . . . . . mailboxes retrieving . . . . . . . . . . . . managing domains CheckNSStatus . . . . . . . . GetAllDomains . . . . . . . . GetDomainCount . . . . . . .

. . . . . . . . . 330 . . . . . . . . . 573 . . . . . . . . . 287 ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... ......... 103 120 123 147 177 252 266 302 306 309 370 373 376 379 382 385 388 403 419 469 503 521 541 551 557 576

GetDomainExp . . . . . . . . GetDomainInfo . . . . . . . . GetDomains . . . . . . . . . . GetDomainStatus . . . . . . GetExpiredDomains . . . . . GetExtendInfo . . . . . . . . GetHomeDomainList . . . . GetPasswordBit . . . . . . . GetRegistrationStatus . . . GetRegLock . . . . . . . . . . GetRenew . . . . . . . . . . . GetSubAccountPassword . PushDomain . . . . . . . . . renewals . . . . . . . . . . . . SetPakRenew . . . . . . . . SetPassword . . . . . . . . . SetRegLock . . . . . . . . . . SetRenew . . . . . . . . . . . SubAccountDomains . . . . ValidatePassword . . . . . . maps GetDomainMap . . . . . . . ME_AddChannelReseller . . . . metatags GetMetaTag . . . . . . . . . . UpdateMetaTag . . . . . . . ModifyNS . . . . . . . . . . . . . . ModifyNSHosting . . . . . . . . . ModifyPOP3 . . . . . . . . . . . . . multiple domains adding . . . . . . . . . . . . .

. . . . . . . . . . 208 . . . . . . . . . . 220 . . . . . . . . . . 234 . . . . . . . . . . 246 . . . . . . . . . . 255 . . . . . . . . . . 262 . . . . . . . . . . 278 . . . . . . . . . . 299 . . . . . . . . . . 315 . . . . . . . . . . 318 . . . . . . . . . . 321 . . . . . . . . . . 343 . . . . . . . . . . 487 . . . . . . . . . . 262 . . . . . . . . . . 551 . . . . . . . . . . 554 . . . . . . . . . . 560 . . . . . . . . . . 563 . . . . . . . . . . 582 . . . . . . . . . . 678 . . . . . . . . . . 225 . . . . . . . . . . 394 . . . . . . . . . . 290 . . . . . . . . . . 664 . . . . . . . . . . 398 . . . . . . . . . . 401 . . . . . . . . . . 403 . . . . . . . . . . 17

N
name my computer GetIPResolver . . . . . . SetIPResolver . . . . . . name servers CheckNSStatus . . . . . DeleteHostedDomain . . DeleteNameserver . . . ExtendDomainDNS . . . GetCusPreferences . . . GetDNS . . . . . . . . . . GetDNSStatus . . . . . . ModifyNS . . . . . . . . . ModifyNSHosting . . . . PurchaseHosting . . . . . redirect hosting . . . . . . RegisterNameServer . . UpdateCusPreferences UpdateNameServer . . . names checking availability . . . ParseDomain . . . . . . . NameSpinner . . . . . . . . . .

. . . . . . . . . . . . 284 . . . . . . . . . . . . 548 . . . . . . . . . . . . 86 . . . . . . . . . . . . 115 . . . . . . . . . . . . 117 . . . . . . . . . . . . 143 . . . . . . . . . . . . 190 . . . . . . . . . . . . 200 . . . . . . . . . . . . 203 . . . . . . . . . . . . 398 . . . . . . . . . . . . 401 . . . . . . . . . . . . 465 . . . . . . . . . . . . 401 . . . . . . . . . . . . 494 . . . . . . . . . . . . 649 . . . . . . . . . . . . 667 . . . . . . . . . . . . 80 . . . . . . . . . . . . 410 . . . . . . . . . . . . 406 . . . . . . . . . . . 587

. . . . . . . . . 302 . . . . . . . . . 86 . . . . . . . . . 169 . . . . . . . . . 205

O
orders cancelling transfer orders

12/1/08

714

1999-2008 eNom, Inc.

Index:

creating transfer orders . . . . . . . GetConfirmationSettings . . . . . . GetOrderDetail . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . InsertNewOrder . . . . . . . . . . . . listing domains in transfer orders . resubmit for locked domain. . . . . retrieving Order ID . . . . . . . . . . retrieving transfer order ID . . . . . reviewing orders by domain . . . . reviewing transfer order status . . submitting transfer orders. . . . . . transfer orders for one domain . . updating transfer orders . . . . . . .

..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... ..... .....

590 183 293 296 391 599 623 246 596 596 613 626 610 630 694 699 703 706 410 343 153 155 299 403 515 554 678 412 416 419 421 425 429 433 438 440 442

P
packages WSC_GetAccountInfo . WSC_GetAllPackages WSC_GetPricing . . . . WSC_Update_Ops . . . ParseDomain . . . . . . . . . passwords get domain password . GetAccountPassword . GetAccountValidation . GetPasswordBit . . . . . ModifyPOP3 . . . . . . . SendAccountEmail . . . SetPassword . . . . . . . ValidatePassword . . . PE_GetCustomerPricing . . PE_GetDomainPricing. . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricing . . . . . PE_GetRocketPrice . . . . . PE_GetTLDID . . . . . . . . . PE_SetPricing . . . . . . . . . phone GetDomainPhone . . . . SetDomainPhone . . . . POP mail DeleteAllPOPPaks . . . DeletePOP3 . . . . . . . DeletePOPPak . . . . . GetCatchAll . . . . . . . GetMailHosts . . . . . . GetPOP3 . . . . . . . . . GetPOPExpirations . . GetPOPForwarding . . ModifyPOP3 . . . . . . . PurchasePOPBundle . PurchaseServices . . . RenewPOPBundle . . . SetCatchAll . . . . . . . . SetPakRenew . . . . . .

............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............

. . . . . . . . . . . . 230 . . . . . . . . . . . . 532 ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ ............ 103 120 123 177 287 302 306 309 403 469 475 503 521 551

SetPOPForwarding . . . . . . SetUpPOP3User . . . . . . . . Preconfigure . . . . . . . . . . . . . preconfigure GetExtAttributes . . . . . . . . PreRegAddList . . . . . . . . . . . . preregistrations add domains to queue . . . . pricing AuthorizeTLD . . . . . . . . . . GetSubAccountDetails . . . . GetTLDList . . . . . . . . . . . HE_GetPricing . . . . . . . . . PE_GetCustomerPricing . . . PE_GetDomainPricing . . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricing . . . . . PE_GetRocketPrice . . . . . . PE_GetTLDID . . . . . . . . . PE_SetPricing . . . . . . . . . RemoveTLD . . . . . . . . . . . SetResellerServicesPricing . SetResellerTLDPricing . . . . UpdateAccountPricing . . . . WSC_GetAccountInfo . . . . WSC_GetAllPackages . . . . WSC_GetPricing . . . . . . . . WSC_Update_Ops . . . . . . privacy protection DisableServices . . . . . . . . EnableServices . . . . . . . . . GetWPPSInfo . . . . . . . . . . PurchaseServices . . . . . . . RenewServices . . . . . . . . . ServiceSelect . . . . . . . . . . products PE_GetCustomerPricing . . . PE_GetPOPPrice . . . . . . . PE_GetProductPrice . . . . . PE_GetResellerPrice . . . . . PE_GetRetailPrice . . . . . . PE_GetRetailPricing . . . . . PE_GetRocketPrice . . . . . . PE_GetTLDID . . . . . . . . . PE_SetPricing . . . . . . . . . SetResellerServicesPricing . SetResellerTLDPricing . . . . UpdateAccountPricing . . . . Purchase . . . . . . . . . . . . . . . . purchase AddBulkDomains . . . . . . . PurchaseHosting . . . . . . . . . . . PurchasePOPBundle . . . . . . . . PurchasePreview . . . . . . . . . . PurchaseServices . . . . . . . . . . purchasing

. . . . . . . . . 557 . . . . . . . . . 576 . . . . . . . . . 447 . . . . . . . . . 258 . . . . . . . . . 454 . . . . . . . . . 454 . . . . . . . . . 50 . . . . . . . . . 336 . . . . . . . . . 352 . . . . . . . . . 385 . . . . . . . . . 412 . . . . . . . . . 416 . . . . . . . . . 419 . . . . . . . . . 421 . . . . . . . . . 425 . . . . . . . . . 429 . . . . . . . . . 433 . . . . . . . . . 438 . . . . . . . . . 440 . . . . . . . . . 442 . . . . . . . . . 497 . . . . . . . . . 566 . . . . . . . . . 569 . . . . . . . . . 641 . . . . . . . . . 694 . . . . . . . . . 699 . . . . . . . . . 703 . . . . . . . . . 706 . . . . . . . . . 131 . . . . . . . . . 133 . . . . . . . . . 366 . . . . . . . . . 475 . . . . . . . . . 507 . . . . . . . . . 517 . . . . . . . . . 412 . . . . . . . . . 419 . . . . . . . . . 421 . . . . . . . . . 425 . . . . . . . . . 429 . . . . . . . . . 433 . . . . . . . . . 438 . . . . . . . . . 440 . . . . . . . . . 442 . . . . . . . . . 566 . . . . . . . . . 569 . . . . . . . . . 641 . . . . . . . . . 456 . . . . . . . . . 17 . . . . . . . . . 465 . . . . . . . . . 469 . . . . . . . . . 472 . . . . . . . . . 475

12/1/08

715

1999-2008 eNom, Inc.

Index:

DeleteFromCart . . InsertNewOrder . . PE_GetPOPPrice . UpdateCart . . . . . PushDomain . . . . . . . pushing domains UpdatePushList . .

............... ............... ............... ............... ...............

113 391 419 646 487

. . . . . . . . . . . . . . . 672

Q
queues PreRegAddList

. . . . . . . . . . . . . . . . . 454 ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... 136 140 143 376 388 456 465 469 475 503 507 590 623 626 662 490

R
real-time commands Extend . . . . . . . . . . . . Extend_RGP . . . . . . . . ExtendDomainDNS . . . HE_CreateAccount . . . . HE_UpgradeAccount . . Purchase . . . . . . . . . . PurchaseHosting . . . . . PurchasePOPBundle . . PurchaseServices . . . . RenewPOPBundle . . . . RenewServices . . . . . . TP_CreateOrder . . . . . TP_ResubmitLocked . . . TP_SubmitOrder . . . . . UpdateExpiredDomains . RefillAccount . . . . . . . . . . . registering domains StatusDomain . . . . . . . RegisterNameServer. . . . . . registrant AddContact . . . . . . . . . Contacts . . . . . . . . . . . DeleteContact . . . . . . . GetAddressBook . . . . . GetContacts . . . . . . . . GetWhoisContact . . . . . SyncAuthInfo . . . . . . . . registrar lock GetCusPreferences . . . GetRegLock . . . . . . . . SetRegLock . . . . . . . . UpdateCusPreferences . registration Extend . . . . . . . . . . . . Extend_RGP . . . . . . . . GetRegistrationStatus . . GetSubAccountDetails . InsertNewOrder . . . . . . PreRegAddList . . . . . . UpdateExpiredDomains . validating user ID . . . . . Registration Agreement GetAgreementPage . . . Registry GetExtAttributes . . . . . .

. . . . . . . . . . . 579 . . . . . . . . . . . 494 ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... 20 91 106 158 186 363 585 190 318 560 649 136 140 315 336 391 454 662 84

ModifyNS . . . . . . . . . . . . . . . . . . . . Registry Rocket PE_GetRocketPrice . . . . . . . . . . . . . . PE_GetTLDID . . . . . . . . . . . . . . . . . Registry Rocket key GetWebHostingAll . . . . . . . . . . . . . . . RemoveTLD . . . . . . . . . . . . . . . . . . . . . . RemoveUnsyncedDomains . . . . . . . . . . . . renewals Extend . . . . . . . . . . . . . . . . . . . . . . Extend_RGP . . . . . . . . . . . . . . . . . . GetDomainExp . . . . . . . . . . . . . . . . . GetExtendInfo . . . . . . . . . . . . . . . . . GetRenew . . . . . . . . . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . . . . . . UpdateExpiredDomains . . . . . . . . . . . RenewPOPBundle . . . . . . . . . . . . . . . . . RenewServices . . . . . . . . . . . . . . . . . . . . reporting GetOrderDetail . . . . . . . . . . . . . . . . . GetOrderList . . . . . . . . . . . . . . . . . . GetReport . . . . . . . . . . . . . . . . . . . . GetTransHistory . . . . . . . . . . . . . . . . RPT_GetReport . . . . . . . . . . . . . . . . ResellerKey GetWebHostingAll . . . . . . . . . . . . . . . resellers GetAccountInfo . . . . . . . . . . . . . . . . . GetConfirmationSettings . . . . . . . . . . . GetCustomerPaymentInfo . . . . . . . . . . GetResellerInfo . . . . . . . . . . . . . . . . . GetSubAccountDetails . . . . . . . . . . . . PE_GetResellerPrice . . . . . . . . . . . . . reviewing orders listing domains in transfer orders . . . . . TP_GetOrderDetail . . . . . . . . . . . . . . TP_GetOrderReview . . . . . . . . . . . . . transfer instructions for a single domain . transfer order status . . . . . . . . . . . . . . transfer orders for one domain . . . . . . . RPT_GetReport . . . . . . . . . . . . . . . . . . . RRPCode 724 StatusDomain . . . . . . . . . . . . . . . . . .

. 398 . 438 . 440 . 360 . 497 . 500 . 136 . 140 . 208 . 262 . 321 . 551 . 563 . 662 . 503 . 507 . 293 . 296 . 324 . 355 . 511 . 360 . 150 . 183 . 197 . 327 . 336 . 425 . 599 . 603 . 607 . 596 . 613 . 610 . 511 . 579

S
search engines GetMetaTag . . . . . . . . . UpdateMetaTag . . . . . . searching AdvancedDomainSearch security CertConfigureCert . . . . . CertGetApproverEmail . . CertGetCertDetail . . . . . CertGetCerts item list . . . CertModifyCert . . . . . . . CertParseCSR . . . . . . . CertPurchaseCert . . . . .

. . . . . . . . . . . 290 . . . . . . . . . . . 664 . . . . . . . . . . . 39 . . . . . . . . . . . 53 . . . . . . . . . . . 59 . . . . . . . . . . . 62 . . . . . . . . . . . 67 . . . . . . . . . . . 71 . . . . . . . . . . . 74 . . . . . . . . . . . 77
716

. . . . . . . . . . . 162 . . . . . . . . . . . 258

12/1/08

1999-2008 eNom, Inc.

Index:

GetCerts product list . . . PurchaseServices . . . . SendAccountEmail . . . . . . . Sender Policy Framework GetSPFHosts . . . . . . . SetSPFHosts . . . . . . . servers DeleteHostedDomain . . DeleteNameserver . . . . ExtendDomainDNS . . . GetDNS . . . . . . . . . . . GetDNSStatus . . . . . . . ModifyNS . . . . . . . . . . ModifyNSHosting . . . . . PurchaseHosting . . . . . redirect hosting . . . . . . RegisterNameServer. . . UpdateNameServer . . . services AddToCart . . . . . . . . . delete email user . . . . . DeleteAllPOPPaks . . . . DeletePOPPak . . . . . . DisableServices . . . . . . email forwarding . . . . . EnableServices . . . . . . GetCatchAll . . . . . . . . GetDomainInfo . . . . . . GetDomainMap . . . . . . GetDomainPhone . . . . . GetDomainServices . . . GetDomainSubServices. GetDotNameForwarding GetExpiredDomains . . . GetForwarding . . . . . . . GetIPResolver . . . . . . . GetMailHosts . . . . . . . GetPOP3 . . . . . . . . . . GetPOPExpirations . . . GetPOPForwarding . . . GetWPPSInfo . . . . . . . ModifyPOP3 passwords. PE_GetCustomerPricing PE_GetPOPPrice . . . . . PE_GetProductPrice . . . PE_GetResellerPrice . . PE_GetRetailPrice . . . . PE_GetRetailPricing . . . PE_GetRocketPrice . . . PE_GetTLDID . . . . . . . PE_SetPricing . . . . . . . PurchasePOPBundle . . PurchaseServices . . . . RenewPOPBundle . . . . RenewServices . . . . . . ServiceSelect . . . . . . . SetCatchAll . . . . . . . . . SetDomainMap . . . . . . SetDomainPhone . . . . .

. . . . . . . . . . . 180 . . . . . . . . . . . 475 . . . . . . . . . . . 515 . . . . . . . . . . . 330 . . . . . . . . . . . 573 ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... ........... 115 117 143 200 203 398 401 465 401 494 667 26 120 103 123 131 147 133 177 220 225 230 238 249 252 255 266 284 287 302 306 309 366 403 412 419 421 425 429 433 438 440 442 469 475 503 507 517 521 529 532

SetDomainSubServices . . . SetDotNameForwarding . . . SetIPResolver . . . . . . . . . SetPakRenew . . . . . . . . . SetPOPForwarding . . . . . . SetResellerServicesPricing . SetUpPOP3User . . . . . . . . UpdateAccountPricing . . . . ServiceSelect . . . . . . . . . . . . . SetCatchAll . . . . . . . . . . . . . . SetCustomerDefinedData . . . . . SetDNSHost . . . . . . . . . . . . . SetDomainMap . . . . . . . . . . . . SetDomainPhone . . . . . . . . . . SetDomainSRVHosts . . . . . . . . SetDomainSubServices . . . . . . SetDotNameForwarding . . . . . . SetHosts . . . . . . . . . . . . . . . . SetIPResolver . . . . . . . . . . . . SetPakRenew . . . . . . . . . . . . SetPassword . . . . . . . . . . . . . SetPOPForwarding . . . . . . . . . SetRegLock . . . . . . . . . . . . . . SetRenew . . . . . . . . . . . . . . . SetResellerServicesPricing . . . . SetResellerTLDPricing . . . . . . . SetSPFHosts . . . . . . . . . . . . . SetUpPOP3User . . . . . . . . . . . shopping cart AddBulkDomains . . . . . . . AddToCart . . . . . . . . . . . . DeleteFromCart . . . . . . . . GetCartContent . . . . . . . . InsertNewOrder . . . . . . . . Purchase . . . . . . . . . . . . . PurchasePreview . . . . . . . UpdateCart . . . . . . . . . . . Social Networking ME_AddChannelReseller . . SPF GetSPFHosts . . . . . . . . . . SetSPFHosts . . . . . . . . . . SRV records GetDomainSRVHosts . . . . SetDomainSRVHosts . . . . . SSL CertConfigureCert . . . . . . . CertGetApproverEmail . . . . CertGetCertDetail . . . . . . . CertGetCerts item list . . . . . CertModifyCert . . . . . . . . . CertParseCSR . . . . . . . . . CertPurchaseCert . . . . . . . GetCerts product list . . . . . PurchaseServices . . . . . . . status CheckNSStatus . . . . . . . . GetDomainInfo . . . . . . . . . GetExpiredDomains . . . . . .

. . . . . . . . . 538 . . . . . . . . . 541 . . . . . . . . . 548 . . . . . . . . . 551 . . . . . . . . . 557 . . . . . . . . . 566 . . . . . . . . . 576 . . . . . . . . . 641 . . . . . . . . . 517 . . . . . . . . . 521 . . . . . . . . . 524 . . . . . . . . . 527 . . . . . . . . . 529 . . . . . . . . . 532 . . . . . . . . . 535 . . . . . . . . . 538 . . . . . . . . . 541 . . . . . . . . . 544 . . . . . . . . . 548 . . . . . . . . . 551 . . . . . . . . . 554 . . . . . . . . . 557 . . . . . . . . . 560 . . . . . . . . . 563 . . . . . . . . . 566 . . . . . . . . . 569 . . . . . . . . . 573 . . . . . . . . . 576 . . . . . . . . . 17 . . . . . . . . . 26 . . . . . . . . . 113 . . . . . . . . . 174 . . . . . . . . . 391 . . . . . . . . . 456 . . . . . . . . . 472 . . . . . . . . . 646 . . . . . . . . . 394 . . . . . . . . . 330 . . . . . . . . . 573 . . . . . . . . . 243 . . . . . . . . . 535 . . . . . . . . . 53 . . . . . . . . . 59 . . . . . . . . . 62 . . . . . . . . . 67 . . . . . . . . . 71 . . . . . . . . . 74 . . . . . . . . . 77 . . . . . . . . . 180 . . . . . . . . . 475 . . . . . . . . . 86 . . . . . . . . . 220 . . . . . . . . . 255
717

12/1/08

1999-2008 eNom, Inc.

Index:

StatusDomain . . . . . . . . . . . SubAccountDomains . . . . . . subaccounts creating . . . . . . . . . . . . DeleteSubaccount . . . . . get domain list . . . . . . . . GetAccountPassword . . . GetAccountValidation . . . GetConfirmationSettings . GetSubAccountDetails . . GetSubAccounts . . . . . . GetSubAccountsDetailList SendAccountEmail . . . . . support GetServiceContact . . . . . SynchAuthInfo . . . . . . . . . . .

. . . . . . . . . . 579 . . . . . . . . . . 582 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... 100 128 234 153 155 183 336 346 349 515

TP_ResendEmail . . . . TP_ResubmitLocked . . TP_SubmitOrder . . . . . TP_UpdateOrderDetail . UpdatePushList . . . . .

. . . . . . . . . . . . 620 . . . . . . . . . . . . 623 . . . . . . . . . . . . 626 . . . . . . . . . . . . 630 . . . . . . . . . . . . 672 . . . . . . . . 636 . . . . . . . . 641 . . . . . . . . 646 . . . . . . . . 649 . . . . . . . . 653 . . . . . . . . 662 . . . . . . . . 664 . . . . . . . . 667 . . . . . . . . 670 . . . . . . . . 672 . . . . . . . . 675 . . . . . . . . 84 . . . . . . . . 108 . . . . . . . . 194 . . . . . . . . 524 . . . . . . . . 95 . . . . . . . . 100 . . . . . . . . 150 . . . . . . . . 165 . . . . . . . . 197 . . . . . . . . 327

. . . . . . . . . . 333 . . . . . . . . . . 585 . . . . . . . . . . 333 . . . . . . . . . . 230 . . . . . . . . . . 532 . . . . . . . . . . 162 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... 50 258 352 497 587 590 596 599 603 607 610 613 616 620 623 626 630

T
technical support GetServiceContact . . . . . telephone GetDomainPhone . . . . . . SetDomainPhone . . . . . . terms and conditions GetAgreementPage . . . . TLD AuthorizeTLD . . . . . . . . GetExtAttributes . . . . . . . GetTLDList . . . . . . . . . . RemoveTLD . . . . . . . . . TP_CancelOrder . . . . . . . . . TP_CreateOrder . . . . . . . . . TP_GetDetailsByDomain . . . . TP_GetOrder . . . . . . . . . . . TP_GetOrderDetail . . . . . . . . TP_GetOrderReview . . . . . . . TP_GetOrdersByDomain . . . . TP_GetOrderStatuses . . . . . . TP_GetTLDInfo . . . . . . . . . . TP_ResendEmail . . . . . . . . . TP_ResubmitLocked . . . . . . . TP_SubmitOrder . . . . . . . . . TP_UpdateOrderDetail . . . . . transactions get transaction history . . . RPT_GetReport . . . . . . . transferring domains GetContacts . . . . . . . . . PushDomain . . . . . . . . . SynchAuthInfo . . . . . . . . TP_CancelOrder . . . . . . TP_CreateOrder . . . . . . TP_GetDetailsByDomain . TP_GetOrder . . . . . . . . TP_GetOrderDetail . . . . . TP_GetOrderReview . . . . TP_GetOrdersByDomain . TP_GetOrderStatuses . . . TP_GetTLDInfo . . . . . . .

UpdateAccountInfo . . . . . . . . . . UpdateAccountPricing . . . . . . . . UpdateCart . . . . . . . . . . . . . . . UpdateCusPreferences . . . . . . . UpdateDomainFolder . . . . . . . . . UpdateExpiredDomains . . . . . . . UpdateMetaTag . . . . . . . . . . . . UpdateNameServer . . . . . . . . . . UpdateNotificationAmount . . . . . . UpdatePushList . . . . . . . . . . . . UpdateRenewalSettings . . . . . . . user ID validating . . . . . . . . . . . . . . user-defined data DeleteCustomerDefinedData . GetCustomerDefinedData . . . SetCustomerDefinedData . . . users CreateAccount . . . . . . . . . . CreateSubAccount . . . . . . . GetAccountInfo . . . . . . . . . . GetAllAccountInfo . . . . . . . . GetCustomerPaymentInfo . . . GetResellerInfo . . . . . . . . . .

. . . . . . . . . . 355 . . . . . . . . . . 511 .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... .......... 186 487 585 587 590 596 599 603 607 610 613 616

ValidatePassword . . . . . . . . validating user ID . . . . . . . . . . . . value-added services AddToCart . . . . . . . . . . DeleteAllPOPPaks . . . . DeletePOP3 . . . . . . . . . DeletePOPPak . . . . . . . DisableServices . . . . . . email forwarding . . . . . . EnableServices . . . . . . . Extend_RGP . . . . . . . . GetDomainInfo . . . . . . . GetDomainServices . . . . GetDomainSubServices . GetExpiredDomains . . . . GetMailHosts . . . . . . . . PE_GetCustomerPricing . PE_GetProductPrice . . . PE_GetResellerPrice . . . PE_GetRetailPrice . . . . PE_GetRetailPricing . . . PE_SetPricing . . . . . . . PurchasePOPBundle . . . PurchaseServices . . . . . RenewServices . . . . . . .

. . . . . . . . . . . 678 . . . . . . . . . . . 84 . . . . . . . . . . . 26 . . . . . . . . . . . 103 . . . . . . . . . . . 120 . . . . . . . . . . . 123 . . . . . . . . . . . 131 . . . . . . . . . . . 147 . . . . . . . . . . . 133 . . . . . . . . . . . 140 . . . . . . . . . . . 220 . . . . . . . . . . . 238 . . . . . . . . . . . 249 . . . . . . . . . . . 255 . . . . . . . . . . . 287 . . . . . . . . . . . 412 . . . . . . . . . . . 421 . . . . . . . . . . . 425 . . . . . . . . . . . 429 . . . . . . . . . . . 433 . . . . . . . . . . . 442 . . . . . . . . . . . 469 . . . . . . . . . . . 475 . . . . . . . . . . . 507

12/1/08

718

1999-2008 eNom, Inc.

Index:

ServiceSelect . . . . . . . . . SetDomainSubServices . . . SetPakRenew . . . . . . . . . SetResellerServicesPricing UpdateAccountPricing . . . .

......... ......... ......... ......... ......... ........ ........ ........ ........

517 538 551 566 641 680 685 688 691

WBLConfigure . . . . . . . . . . . . . WBLGetCategories . . . . . . . . . . WBLGetFields . . . . . . . . . . . . . WBLGetStatus . . . . . . . . . . . . . Web hosting PurchaseServices . . . . . . . Web hosting packages WSC_GetAccountInfo . . . . . WSC_GetAllPackages . . . . WSC_GetPricing . . . . . . . . WSC_Update_Ops . . . . . . . Web Site Creator create, enable, disable . . . . WebSite Creator WSC_GetAccountInfo . . . . . WSC_GetAllPackages . . . . WSC_GetPricing . . . . . . . . WSC_Update_Ops . . . . . . . WhoIs GetContacts . . . . . . . . . . . GetWhoisContact . . . . . . . . whois AddContact . . . . . . . . . . . . DeleteContact . . . . . . . . . . GetAddressBook . . . . . . . . Whois Business Listing PurchaseServices . . . . . . . Whois Business Listing Directory WBLConfigure . . . . . . . . . . WBLGetCategories . . . . . . . WBLGetFields . . . . . . . . . . WBLGetStatus . . . . . . . . . . WhoIs protection DisableServices . . . . . . . . . EnableServices . . . . . . . . . GetWPPSInfo . . . . . . . . . . RenewServices . . . . . . . . . ServiceSelect . . . . . . . . . . Whois protection PurchaseServices . . . . . . . WSC stand-alone WSC_GetAccountInfo . . . . . WSC_GetAllPackages . . . . WSC_GetPricing . . . . . . . . WSC_Update_Ops . . . . . . . WSC_GetAccountInfo . . . . . . . . WSC_GetAllPackages. . . . . . . . WSC_GetPricing . . . . . . . . . . . WSC_Update_Ops . . . . . . . . . .

. . . . . . . . 475 ........ ........ ........ ........ 694 699 703 706

. . . . . . . . 517 ........ ........ ........ ........ 694 699 703 706

. . . . . . . . 186 . . . . . . . . 363 . . . . . . . . 20 . . . . . . . . 106 . . . . . . . . 158 . . . . . . . . 475 ........ ........ ........ ........ ........ ........ ........ ........ ........ 680 685 688 691 131 133 366 507 517

. . . . . . . . 475 ........ ........ ........ ........ ........ ........ ........ ........ 694 699 703 706 694 699 703 706

12/1/08

719